API Introduction
Call describeDBInstanceAttribute to query the instance details.
API Restrictions
None
URI
GET /v1/openApi/describeDBInstanceAttribute
Path Parameter
None
Query Parameter
Parameter | Required or Not | Parameter Type | Description | Example |
prodInstId | *Required | String | External instance ID of the document database | a649077e15f349cb8b4cde6f7285a568 |
Request Parameters
Request Header Parameter
None
Response Parameter
Parameter | Required or Not | Parameter Type | Description | Example | Lower-level Object |
statusCode | Yes | Integer | Response Code Value range: 800 indicates success, 900 indicates failure | 800 | |
message | Yes | String | Response information | The XXX information is queried successfully | |
returnObj | Yes | Object | Return object. | returnObj |
Table returnObj
Parameter | Required or Not | Parameter Type | Description | Example | Lower-level Object |
prodInstName | Yes | String | Instance Name | test001 | |
prodType | Yes | Integer | Instance type 0: Single instance, 1: one-master-one-slave, 2: one-master-two-slave, 3: one-master-three-slave | 0 | |
userId | Yes | Integer | User id | 111 | |
enableSSL | Yes | Integer | enableSSL indicates whether to enable SSL connection, 1 indicates enabled, 0 indicates disabled | 0 | |
diskSize | Yes | Integer | Storage space size /G | 100 | |
createTime | Yes | String | Creation time of instance | 10/10/2022 12:00:00 AM | |
port | Yes | String | Port to access this mongodb | 8888 | |
prodRunningStatus | Yes | Integer | The running state of the instance. | 0 | |
diskRate | Yes | String | Disk Utilization | 10% | |
host | Yes | String | Active node host | 67 | |
prodInstId | Yes | String | Instance ID. | a649077e15f349cb8b4cde6f7285a568 | |
machineSpec | Yes | String | Instance Specifications | 64C500G | |
nodeInfoVOS | Yes | Object[] | Node Information | nodeInfoVOS |
Table nodeInfoVOS
Parameter | Required or Not | Parameter Type | Description | Example | Lower-level Object |
elasticIp | Yes | String | Elastic IP (EIP) | 127.0.0.1 | |
node | Yes | String | The label of mongodb is specified as "set_ + three tail ip + port number" | set_1098350_1 | |
role | Yes | String | Role | master | |
alive | Yes | Integer | Taken from the ok attribute in mongodb | 0 | |
vpcIpv6 | Yes | String | ipv6 address in the vpc | ||
port | Yes | String | Port to access this mongodb | 888 | |
prodInstId | Yes | String | Instance ID. | 649077e15f349cb8b4cde6f7285a568 | |
resId | Yes | Integer | Uniquely mark this mongodb | 67 |
Sample Request
Request Header
None
Request parameter query
/v1/openApi/describeDBInstanceAttribute?prodInstId=a649077e15f349cb8b4cde6f7285a568
Response Example
{
"statusCode": 800,
"message": "the overview information of the MongoDB instance is queried successfully",
"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"
}
}Status Code
Status Code | Description |
800 | Indicate that the request succeeded |
900 | Indicates that the request failed |
Error Codes
None