查詢實例的數據庫root賬號信息
更新時間 2023-08-29 15:13:51
最近更新時間: 2023-08-29 15:13:51
分享文章
接口功能介紹
調用describeRootAccoun查詢MongoDB實例的數據庫root賬號信息。
接口約束
無
URI
GET /v1/accountsOpenApi/describeRootAccount
路徑參數
無
Query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 |
|---|---|---|---|---|
| prodInstId | 是 | String | 文檔數據庫對外的實例標識 | 60d420bffb394397b4303be871a481e3 |
請求參數
請求頭header參數
無
響應參數
| 參數 | 是否必填 | 參數類型 | 說明 | 下級對象 | |
|---|---|---|---|---|---|
| statusCode | 是 | Integer | 響應碼 取值范圍：800為成功，900為失敗 |
800 | |
| message | 是 | String | 響應信息 | 查詢MongoDB實例的主機告警規則成功 | |
| returnObj | 是 | Object | 返回對象 | returnObj |
表returnObj
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| ProdInstId | 是 | String | 實例ID | 60d420bffb394397b4303be871a481e3 | |
| AccountName | 是 | String | 賬戶名 | root | |
| ProdType | 是 | String | 實例類型，0代表單節點，2代表一主兩從 | 2 | |
| AccountStatus | 是 | String | 賬戶狀態 | Available | |
| AccountDescription | 是 | String | 賬號備注信息 | Administrator |
請求示例
請求頭header
無
請求參數query
/v1/accountsOpenApi/describeRootAccoun?prodInstId=60d420bffb394397b4303be871a481e3
響應示例
{
"statusCode": 800,
"message": "查詢MongoDB實例的數據庫賬號信息成功",
"returnObj": {
"AccountDescription": "Administrator",
"AccountStatus": "Available",
"ProdType": "2",
"ProdInstId": "60d420bffb394397b4303be871a481e3 ",
"AccountName": "root"
}
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 800 | 表示請求成功 |
| 900 | 表示請求失敗 |
錯誤碼
無
