API Introduction
Call describeClusterInstanceList to view the cluster instance list.
API Restrictions
None
URI
GET /v1/openApi/describeClusterInstanceList
Path Parameter
None
Query Parameter
None
Request Parameters
Request Header Parameter
None
Response Parameter
Parameter | Required or Not | Parameter Type | Description | Lower-level Object | |
statusCode | Yes | Integer | Response Code Value range: 800 indicates success, 900 indicates failure | 800 | |
message | Yes | String | Response information | The cluster instance list is viewed successfully | |
returnObj | Yes | Object[] | Return object array | returnObj |
Table returnObj
Parameter | Required or Not | Parameter Type | Description | Example | Lower-level Object |
subnet | Yes | String | Subnet | subnet-9bdf-0922 | |
expireTime | Yes | String | Expiration Time | 2022-11-29 10:42:37.0 | |
createTime | Yes | String | Creation time of instance | 2022-07-29 10:42:13.0 | |
prodDbEngin | Yes | String | Version of dds database product | 4.0 | |
prodRunningStatus | Yes | Integer | The running state of the instance. | 0 | |
netName | Yes | String | Private Network | ||
prodInstId | Yes | String | Sample id | a649077e15f349cb8b4cde6f7285a568 | |
machineSpec | Yes | String | CPU memory specification | 1C4G |
Sample Request
Request Header
None
Request parameter query
GET /v1/openApi/describeClusterInstanceList
Response Example
{
"statusCode": 800,
"message": "the cluster instance list is viewed successfully",
"returnObj": [
{
"subnet": "subnet-9bdf-0922",
"expireTime": "2022-11-29 10:42:37.0",
"prodInstName": "test23319836bc4f4bff8ded0fa4cbe1acfe",
"createTime": "2022-09-26 10:09:22.0",
"prodDbEngine": "3.4",
"prodRunningStatus": 0,
"netName": "vpc-9bdf-0922",
"prodInstId": "23319836bc4f4bff8ded0fa4cbe1acfe",
"machineSpec": "1C4G"
},
{
"subnet": "subnet-3t68",
"expireTime": "2022-10-27 17:34:45.0",
"prodInstName": "testtest1111211",
"createTime": "2022-10-27 17:06:28.0",
"prodDbEngine": "4.0",
"prodRunningStatus": 8,
"netName": "vpc-3t68",
"prodInstId": "f0e5dba2a22e4dcd939b09284816451e",
"machineSpec": "1C4G"
}
]
}Status Code
Status Code | Description |
800 | Indicate that the request succeeded |
900 | Indicates that the request failed |
Error Codes
None