接口协议
接口 | https://[endpoint].ctapi.ctyun.cn/v1/instances/query | ||
请求方式 | GET | ||
请求参数 | 是否必填 | 参数类型 | 说明 |
pageNum | 否 | String | 分页中的页数，默认1 |
pageSize | 否 | String | 分页中的每页大小，默认10 |
prodInstId | 否 | String | 实例Id，如果填入，则返回指定实例信息 |
响应参数 | 参数类型 | 描述 | |
statusCode | String | 接口系统层面状态码。成功：800，失败：900 | |
message | String | 描述状态 | |
returnObj | String | 返回对象。此参数所包含的参数请见“响应示例"里面的注释 | |
请求示例
`GET https://[endpoint].ctapi.ctyun.cn/v1/instances/query`
返回示例
（1）成功响应示例
{
"statusCode": "Integer,返回状态码，800-成功，900-失败",
"message": "String，描述信息，成功，success；失败，说明原因",
"returnObj": {
"total": "实例总数",
"data": [{
"tenantName": "租户id",
"cluster": "实例Id",
"status": "状态：1正常，2暂停，3注销",
"prodType": "产品规格类型：10009002基础版，10009001高级版",
"topicsNum": "topic上限数",
"securityGroup": "安全组",
"network": "网络",
"subnet":"子网",
"expireTime": "过期时间，例如：1882413033000",
"createTime": "创建时间，例如：1564115466000",
"updateTime": "更新时间，例如：1564115466000"
}]
}
}（2）失败响应示例
{
"returnObj": {},
"message": null,
"statusCode": "900"
}