查詢實例的連接地址信息
更新時間 2023-08-29 15:13:49
最近更新時間: 2023-08-29 15:13:49
分享文章
接口功能介紹
調用describeInstanceConnectionString查詢實例的連接地址信息。
接口約束
無
URI
GET /v1/openApi/describeInstanceConnectionString
路徑參數
無
Query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 |
|---|---|---|---|---|
| prodInstId | *必填 | String | 文檔數據庫對外的實例標識 | a649077e15f349cb8b4cde6f7285a568 |
請求參數
請求頭header參數
無
響應參數
| 參數 | 是否必填 | 參數類型 | 說明 | 下級對象 | |
|---|---|---|---|---|---|
| statusCode | 是 | Integer | 響應碼 取值范圍：800為成功，900為失敗 |
800 | |
| message | 是 | String | 響應信息 | 查詢XXX信息成功 | |
| returnObj | 是 | Object | 返回對象 | returnObj |
表returnObj
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| ProdInstId | 是 | String | 實例ID | a649077e15f349cb8b4cde6f7285a568 | |
| ConnectionString | 是 | String | mongodb的連接信息 | mongodb://root:****@172.27.176.109:8350/admin?authSource=admin |
請求示例
請求頭header
無
請求參數query
/v1/openApi/describeInstanceConnectionString?prodInstId=a649077e15f349cb8b4cde6f7285a568
響應示例
{
"statusCode": 800,
"message": "查詢文檔數據庫服務的實例連接地址信息成功",
"returnObj": {
"ProdInstId": "a649077e15f349cb8b4cde6f7285a568",
"ConnectionString":"mongodb://root:****@172.27.176.109:8350/admin?authSource=admin"
}
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 800 | 表示請求成功 |
| 900 | 表示請求失敗 |
錯誤碼
無
