接口功能介绍
调用describeClusterInstanceList查看集群实例列表。
接口约束
无
URI
GET /v1/openApi/describeClusterInstanceList
路径参数
无
Query参数
无
请求参数
请求头header参数
无
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 下级对象 | |
|---|---|---|---|---|---|
| statusCode | 是 | Integer | 响应码 取值范围：800为成功，900为失败 |
800 | |
| message | 是 | String | 响应信息 | 查看集群实例列表成功 | |
| returnObj | 是 | Object[] | 返回对象数组 | returnObj |
表returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| subnet | 是 | String | 子网 | subnet-9bdf-0922 | |
| expireTime | 是 | String | 到期时间 | 2022-11-29 10:42:37.0 | |
| createTime | 是 | String | 实例的创建时间 | 2022-07-29 10:42:13.0 | |
| prodDbEngin | 是 | String | dds数据库产品的版本 | 4.0 | |
| prodRunningStatus | 是 | Integer | 实例的运行状态 | 0 | |
| netName | 是 | String | 专有网络 | ||
| prodInstId | 是 | String | 示例id | a649077e15f349cb8b4cde6f7285a568 | |
| machineSpec | 是 | String | CPU内存规格 | 1C4G |
请求示例
请求头header
无
请求参数query
GET /v1/openApi/describeClusterInstanceList
响应示例
{
"statusCode": 800,
"message": "查看集群实例列表成功",
"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"
}
]
}
状态码
| 状态码 | 描述 |
|---|---|
| 800 | 表示请求成功 |
| 900 | 表示请求失败 |
错误码
无
