查詢實例默認的參數模板列表
更新時間 2023-08-29 15:13:53
最近更新時間: 2023-08-29 15:13:53
分享文章
接口功能介紹
調用DescribeParameterTemplates接口查詢MongoDB查詢默認參數模板列表。
接口約束
無
URI
GET /v1/openApi/describeParameterTemplates
請求參數
請求頭header參數
無
請求體query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| prodInstId | 是 | String | 實例id | 555b89493b1a40e1b97ea05e50dd8170 | |
| parameterGroupUsed | 是 | String | 參數組名，標志參數組版本 | ||
| pageNow | 否 | Integer | 當前頁 | 1 | |
| pageSize | 否 | Integer | 每頁數量 | 10 | |
| parameterName | 否 | String | 參數名 |
響應參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| statusCode | 是 | String | 返回碼 取值范圍：800 成功 |
800 | |
| message | 是 | String | 返回消息 | ||
| returnObj | 是 | Object[] | 返回對象數組 | returnObj |
returnObj
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| parameterGroupName | 是 | String | 參數組名稱 | ||
| valuetype | 是 | String | 參數數據類型 | ||
| restart | 是 | String | 參數是否重啟才能生效 | ||
| defaultValue | 是 | String | 默認值 | ||
| groupId | 是 | String | 該參數是否允許用戶修改，0表示允許 | ||
| description | 是 | String | 對參數的描述 | ||
| parameterName | 是 | String | 參數名 | ||
| parameterValue | 是 | String | 參數值 | ||
| userId | 是 | Integer | 用戶id | ||
| prodInstId | 是 | String | 實例id | ||
| id | 是 | Integer | 主鍵 | ||
| isdefault | 是 | String | 該參數是否允許用戶修改，0表示允許 | ||
| permitValue | 是 | String | 參數值允許范圍 |
請求示例
請求頭header
無
請求參數query
/v1/openApi/describeParameterTemplates?prodInstId=a649077e15f349cb8b4cde6f7285a568
響應示例
{
"statusCode": 800,
"message": "查詢MongoDB實例默認的參數模板列表",
"returnObj": {
"lastPage": 2,
"navigatepageNums": [
1,
2
],
"startRow": 1,
"hasNextPage": true,
"prePage": 0,
"nextPage": 2,
"endRow": 10,
"pageSize": 10,
"list": [
{
"parameterGroupName": "Default-Mongo-4.0",
"valuetype": "string",
"restart": "1",
"defaultValue": "true",
"groupId": null,
"description": "????????????????????????????????",
"parameterName": "storage.directoryPerDB",
"parameterValue": "true",
"userId": 149,
"prodInstId": null,
"id": 62238,
"isdefault": "1",
"permitValue": "true,false"
}
],
"pageNum": 1,
"navigatePages": 8,
"total": 17,
"pages": 2,
"firstPage": 1,
"size": 10,
"isLastPage": false,
"hasPreviousPage": false,
"isFirstPage": true
}
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 800 | 表示請求成功。 |
| 900 | 請求響應失敗，失敗原因見message |
錯誤碼
無
