接口介绍
查询消息服务实例列表信息。
接口约束
无。
URl
GET https://[endpoint]/v2/instance/list
请求参数
无。
响应参数
响应参数 | 参数类型 | 描述 |
statusCode | String | 接口系统层面状态码。成功：800，失败：900 |
message | String | 描述状态 |
returnObj | String | 返回对象。此参数所包含的参数请见“响应示例"里面的注释 |
返回值returnObj参数说明
响应参数 | 参数类型 | 描述 |
prodInstList | List | 实例列表 |
返回值prodInstList参数说明
响应参数 | 参数类型 | 描述 |
prodInstId | String | 实例ID |
billMode | String | 计费模式 1：包周期 2：按需计费 |
prodInstName | String | 实例名称 |
runningState | String | 实例状态： 运行中 已退订 |
prodType | String | 规格名称 |
machineSpec | String | 主机类型 |
tpsLimit | String | Tps峰值 |
topicLimit | String | 主题最大数量 |
diskSpace | String | 磁盘空间 |
netName | String | 网络名称 |
subnet | String | 子网 |
securityGroup | String | 安全组 |
expTime | Long | 过期时间戳 |
crtTime | Long | 创建时间戳 |
请求示例
GET https://[endpoint]/v2/instance/list
响应成功示例
{
"returnObj":{
"prodInstList":[
{
"prodInstId":"mq_test",
"billMode":null,
"prodInstName":"ctgmq_mq_test",
"runningState":"运行中",
"prodType":"其他",
"machineSpec":"4核16G",
"tpsLimit":"20000",
"topicLimit":"500",
"diskSpace":"1000G",
"netName":null,
"subnet":null,
"securityGroup":null,
"expTime":1661858790649,
"crtTime":1652841984000
}
]
},
"message":"success",
"statusCode":800
}
响应失败示例
{
"returnObj": {},
"message": "...",
"statusCode": "900"
}