查詢實例的參數配置信息
更新時間 2023-08-29 15:13:53
最近更新時間: 2023-08-29 15:13:53
分享文章
接口功能介紹
調用describeParameters接口查詢實例的參數配置信息。
接口約束
無
URI
GET /v1/openApi/describeParameters
路徑參數
無
Query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| prodInstId | 是 | String | 實例id | 555b89493b1a40e1b97ea05e50dd8170 | |
| pageNow | 否 | Integer | 當前頁 | 1 | |
| pageSize | 否 | Integer | 每頁數量 | 1 | |
| parameterName | 否 | String | 參數名稱 |
請求參數
請求頭header參數
無
響應參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| statusCode | 是 | String | 返回碼 取值范圍：800 成功 |
800 | |
| message | 是 | String | 返回消息 | ||
| returnObj | 是 | Object[] | 返回對象數組 | returnObj |
表retunObj
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| userId | 是 | String | 用戶id | ||
| isdefault | 是 | String | 參數是否可以修改 | ||
| parameterGroupName | 是 | String | 參數組名稱 | ||
| parameterValue | 是 | String | 參數值 | ||
| parameterName | 是 | String | 參數名 | ||
| permitValue | 是 | string | 參數允許范圍 | ||
| valuetype | 是 | String | 參數數據類型 | ||
| restart | 是 | String | 參數是否重啟才能生效 | ||
| description | 是 | String | 參數描述 |
請求示例
請求頭header
無
請求參數query
/v1/openApi/describeParameters?prodInstId=a649077e15f349cb8b4cde6f7285a568
響應示例
{
"statusCode":800,
"message":"接口查詢MongoDB實例的參數配置信息成功",
"returnObj":{
"startRow":1,
"hasNextPage":false,
"prePage":0,
"nextPage":0,
"endRow":1,
"pageSize":10,
"list":[
{
"id":"52",
"userId":"0",
"groupId":"0",
"isdefault":"0",
"parameterGroupName":"Default-Mongo-3.4",
"parameterValue":"600",
"permitValue":"",
"parameterName":"connPoolMaxConnsPerHost",
"valuetype":"int",
"restart":"1",
"description":"表示當前實例與其他mongod實例通信的連接池的最大連接數"
}
],
"pageNum":1,
"navigatePages":8,
"total":1,
"pages":1,
"firstPage":1,
"size":1,
"isLastPage":true,
"hasPreviousPage":false,
"isFirstPage":true
}
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 800 | 表示請求成功。 |
| 900 | 請求響應失敗，失敗原因見message |
錯誤碼
無
