API Introduction
Call describeDBInstancesOverview to query the overview information of one or more MongoDB instances.
API Restrictions
None
URI
GET /v1/openApi/describeDBInstancesOverview
Path Parameter
None
Query Parameter
Parameter | Required or Not | Parameter Type | Description | Example | Lower-level Object |
prodInstIds | Yes | String | Product ID | 555b89493b1a40e1b97ea05e50dd8170 |
Request Parameters
Request Header Parameter
None
Response Parameter
Parameter | Required or Not | Parameter Type | Description | Example | Lower-level Object |
statusCode | Yes | String | Return code Value range: 800 indicates success | 800 | |
message | Yes | String | Return to Messages | ||
returnObj | Yes | Object[] | Return object array | returnObj |
Table returnObj
Parameter | Required or Not | Parameter Type | Description | Example | Lower-level Object |
prodInstName | Yes | String | Instance Name | mongodb001 | |
userId | Yes | Integer | User id | 124 | |
enableSSL | Yes | Integer | 'enableSSL indicates whether to enable SSL connection, 1 indicates enabled, 0 indicates disabled' | 1 | |
diskSize | Yes | Integer | Disk Space | 300 | |
createTime | Yes | Integer | Created At | 1658458503000 | |
port | Yes | String | Host Port | 8350 | |
diskRate | Yes | String | Query the disk usage | 32% | nodeInfoVOS |
nodeInfoVOS
Parameter | Required or Not | Parameter Type | Description | Example | Lower-level Object |
node | Yes | String | Child node name | mongodb001 | |
role | Yes | String | Role | master | |
vpcIpv6 | Yes | Integer | ipv6 address in the vpc | ||
port | Yes | String | Host Port | 8832 | |
host | Yes | String | Host address | 172.27.176.109 | |
prodInstId | Yes | String | Instance ID. | ||
resId | Yes | Integer | Uniquely mark this mongodb |
Sample Request
Request Header
None
Request parameter query
/v1/openApi/describeDBInstancesOverview?prodInstIds=555b89493b1a40e1b97ea05e50dd8170
Response Example
{
"statusCode": 800,
"message": "the overview information of the MongoDB instance is queried successfully",
"returnObj": [
{
"prodInstName": "mongodb001",
"prodType": null,
"userId": 149,
"enableSSL": 0,
"diskSize": 3072,
"createTime": 1658458503000,
"port": "8350",
"prodRunningStatus": 0,
"diskRate": "14%",
"nodeInfoVOS": [
{
"elasticIp": "",
"node": "set_1098350_1",
"role": "master",
"alive": 1,
"vpcIpv6": "",
"port": "8350",
"host": "172.27.176.109",
"prodInstId": "c46d8f547cc648a78a68270092e70f80",
"type": null,
"resId": 67
}
],
"host": "172.27.176.109",
"prodInstId": "c46d8f547cc648a78a68270092e70f80",
"machineSpec": "64C500G"
}
]
}Status Code
Status Code | Description |
800 | Indicate that the request succeeded |
900 | Request response failed, see message for reason of failure |
Error Codes
Please refer to the error code description.