接口功能介绍
查询文档数据库服务的实例列表。
接口约束
无
URI
GET /v1/openApi/getAllInstances
路径参数
无
Query参数
无
请求参数
请求头header参数
无
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 是 | Integer | 响应码 取值范围：800为成功，900为失败 |
800 | |
| message | 是 | String | 响应信息 | 查询XXX信息成功 | |
| returnObj | 是 | Object[] | 返回对象数组 | returnObj |
表returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| subnet | 是 | String | 子网 | ||
| expireTime | 是 | String | 到期时间 | 2022-07-22 10:54:13.0 | |
| createTime | 是 | String | 实例的创建时间 | 2022-07-22 10:54:13.0 | |
| prodDbEngin | 是 | String | dds数据库产品的版本 | 4.0 | |
| prodRunningStatus | 是 | Integer | 实例的运行状态 | 0 | |
| netName | 是 | String | 专有网络 | ||
| prodInstId | 是 | String | 示例id | a649077e15f349cb8b4cde6f7285a568 | |
| machineSpec | 是 | String | CPU内存规格 | 64C500G |
请求示例
请求头header
无
请求参数query
/v1/openApi/getAllInstances
响应示例
{
"statusCode": 800,
"message": "查询文档数据库服务的实例列表成功",
"returnObj": [
{
"subnet": "",
"expireTime": "2022-07-22 10:54:13.0",
"prodInstName": "mongodb001",
"createTime": "2022-07-22 10:55:03.0",
"prodDbEngine": "4.0",
"prodRunningStatus": 0,
"netName": "",
"prodInstId": "c46d8f547cc648a78a68270092e70f80",
"machineSpec": "64C500G"
}
]
}
状态码
| 状态码 | 描述 |
|---|---|
| 800 | 表示请求成功 |
| 900 | 表示请求失败 |
错误码
无
