Interface Protocol
Interface | https://[endpoint].ctapi.ctyun.cn/v1/instances/query | ||
Request Method | GET | ||
Request Parameters | Required or Not | Parameter Type | Description |
pageNum | No | String | The number of pages in the pagination. The default is 1. |
pageSize | No | String | The size of each page in the pagination. The default is 10. |
prodInstId | No | String | Instance id. If specified, it returns the specified instance information. |
Response Parameter | Parameter Type | Description | |
statusCode | String | The status code of the interface on the system layer. Success: 800; failure: 900. | |
message | String | Status Description | |
returnObj | String | Return the object. The parameters included in this parameter are described in the comments in Response Examples. | |
Sample Request
`GET https://[endpoint].ctapi.ctyun.cn/v1/instances/query`
Return Example
(1) Example of successful response
{
"statusCode": "Integer, return status code, 800-success, 900-failure",
"message": "String, description information, success; failed, explain the reason",
"returnObj": {
"total": "total number of instances",
"data": [{
"tenantName": "tenant id".
"cluster": "Instance Id",
"status": "status: 1 normal, 2 suspended, 3 unregistered",
"prodType": "Specification Type: 10009002 Basic Edition, 10009001 Advanced Edition",
"topicsNum": "maximum number of topics",
"securityGroup": "security group",
"network": "network",
"subnet":"subnet",
"expireTime": "expiration time, for example: 1882413033000",
"createTime": "Creation time, for example: 1564115466000",
"updateTime": "Update time, for example: 1564115466000"
}]
}
}
(2) Example of failed response
{
"returnObj": {},
"message": null,
"statusCode": "900"
}