接口功能介绍
调用describeDBInstanceAttribute查询实例详情。
接口约束
无
URI
GET /v1/openApi/describeDBInstanceAttribute
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 |
prodInstId | *必填 | String | 文档数据库对外的实例标识 | a649077e15f349cb8b4cde6f7285a568 |
请求参数
请求头header参数
无
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
statusCode | 是 | Integer | 响应码 | 800 | |
message | 是 | String | 响应信息 | 查询XXX信息成功 | |
returnObj | 是 | Object | 返回对象 | returnObj |
表returnObj
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
prodInstName | 是 | String | 实例名称 | test001 | |
prodType | 是 | Integer | 实例类型 0: 单实例, 1:一主一从, 2:一主两从, 3:一主三从 | 0 | |
userId | 是 | Integer | 用户id | 111 | |
enableSSL | 是 | Integer | enableSSL表示是否开启ssl连接，1表示开启，0表示未开启 | 0 | |
diskSize | 是 | Integer | 存储空间大小/G | 100 | |
createTime | 是 | String | 实例创建时间 | 2022-10-10 00:00:00 | |
port | 是 | String | 访问该mongodb的端口 | 8888 | |
prodRunningStatus | 是 | Integer | 实例的运行状态 | 0 | |
diskRate | 是 | String | 磁盘使用率 | 10% | |
host | 是 | String | 主节点host | 67 | |
prodInstId | 是 | String | 实例id | a649077e15f349cb8b4cde6f7285a568 | |
machineSpec | 是 | String | 实例规格 | 64C500G | |
nodeInfoVOS | 是 | Object[] | 节点信息 | nodeInfoVOS |
表nodeInfoVOS
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
elasticIp | 是 | String | 弹性ip | 127.0.0.1 | |
node | 是 | String | 该mongodb的标签，规定为“set_ + 三个尾部ip + 端口号” | set_1098350_1 | |
role | 是 | String | 角色 | master | |
alive | 是 | Integer | 取自mongodb中的ok属性 | 0 | |
vpcIpv6 | 是 | String | vpc内部的ipv6地址 | ||
port | 是 | String | 访问该mongodb的端口 | 888 | |
prodInstId | 是 | String | 实例id | 649077e15f349cb8b4cde6f7285a568 | |
resId | 是 | Integer | 唯一标志该mongodb | 67 |
请求示例
请求头header
无
请求参数query
/v1/openApi/describeDBInstanceAttribute?prodInstId=a649077e15f349cb8b4cde6f7285a568
响应示例
{
"statusCode": 800,
"message": "查询MongoDB实例概览信息成功",
"returnObj": {
"prodInstName": "test-lcy",
"prodType": null,
"userId": 149,
"enableSSL": 0,
"diskSize": 3072,
"createTime": 1658458503000,
"port": "8350",
"prodRunningStatus": 0,
"diskRate": "12%",
"nodeInfoVOS": [
{
"elasticIp": "",
"node": "set_1098350_1",
"role": "master",
"alive": 1,
"vpcIpv6": "",
"port": "8350",
"host": "172.27.176.109",
"prodInstId": "c46d8f547cc648a78a68270092e70f80",
"resId": 67
}
],
"host": "172.27.176.109",
"prodInstId": "c46d8f547cc648a78a68270092e70f80",
"machineSpec": "64C500G"
}
}状态码
状态码 | 描述 |
800 | 表示请求成功 |
900 | 表示请求失败 |
错误码
无