API Introduction
Query the instance list of the document database service.
API Restrictions
None
URI
GET /v1/openApi/getAllInstances
Path Parameter
None
Query Parameter
None
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 array | returnObj |
Table returnObj
Parameter | Required or Not | Parameter Type | Description | Example | Lower-level Object |
subnet | Yes | String | Subnet | ||
expireTime | Yes | String | Expiration Time | 2022-07-22 10:54:13.0 | |
createTime | Yes | String | Creation time of instance | 2022-07-22 10:54:13.0 | |
prodDbEngin | Yes | String | Version of dds database product | 4.0 | |
prodRunningStatus | Yes | Integer | The running state of the instance. | 0 | |
netName | Yes | String | Private Network | ||
prodInstId | Yes | String | Sample id | a649077e15f349cb8b4cde6f7285a568 | |
machineSpec | Yes | String | CPU memory specification | 64C500G |
Sample Request
Request Header
None
Request parameter query
/v1/openApi/getAllInstances
Response Example
{
"statusCode": 800,
"message": "the instance list of the document database service is queried successfully",
"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"
}
]
}Status Code
Status Code | Description |
800 | Indicate that the request succeeded |
900 | Indicates that the request failed |
Error Codes
None