API Introduction
Call describeInstanceConnectionString to query the connection address information of the instance.
API Restrictions
None
URI
GET /v1/openApi/describeInstanceConnectionString
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 | 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 |
ProdInstId | Yes | String | Instance ID | a649077e15f349cb8b4cde6f7285a568 | |
ConnectionString | Yes | String | Connection information of the mongodb | mongodb://root:****@172.27.176.109:8350/admin?authSource=admin |
Sample Request
Request Header
None
Request parameter query
/v1/openApi/describeInstanceConnectionString?prodInstId=a649077e15f349cb8b4cde6f7285a568
Response Example
{
"statusCode": 800,
"message": "the instance connection address information of the document database service is queried successfully",
"returnObj": {
"ProdInstId": "a649077e15f349cb8b4cde6f7285a568",
"ConnectionString":"mongodb://root:****@172.27.176.109:8350/admin?authSource=admin"
}
}Status Code
Status Code | Description |
800 | Indicate that the request succeeded |
900 | Indicates that the request failed |
Error Codes
None