查詢實例當前應用的參數列表v2
更新時間 2025-10-22 18:09:39
最近更新時間: 2025-10-22 18:09:39
分享文章
接口功能介紹
查詢文檔數據庫實例當前應用的參數列表
接口約束
無
URI
GET /DDS2/v2/openApi/queryInstParameters
路徑參數 無
Query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| nodeType | 是 | String | 節點類型，單節點或副本集為：Mongod，對于集群可選：Mongos，Configsvr，Shard | ||
| pageNow | 否 | Integer | 當前頁，不傳默認為1 | 1 | |
| pageSize | 否 | Integer | 每頁數量，不傳默認為10 | 10 | |
| parameterName | 否 | String | 參數名 |
請求參數
請求頭header參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| project-id | 否 | String | 項目id | 0 | |
| prodInstId | 是 | String | 實例id | 60d420bffb394************************* | |
| regionId | 是 | String | 資源池id | bb9fdb42056f11eda1610242ac110002 |
請求體body參數 無
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | String | 返回碼 取值范圍：800 成功 | 800 | |
| message | String | 返回消息 | 查詢實例當前應用的參數列表成功 | |
| returnObj | Object | 返回對象數組 | returnObj | |
| error | String | 錯誤碼。當接口失敗時才返回具體錯誤編碼，成功不返回或者為空。 | ||
| 表 returnObj |
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| lastPage | Integer | 最后一頁的頁碼 | 1 | |
| navigatepageNums | Object | 可用于導航的頁碼數組 | ||
| startRow | Integer | 當前頁的第一行的索引 | 1 | |
| hasNextPage | Boolean | 指示是否有下一頁數據可用 | false | |
| prePage | Integer | 前一頁的頁碼 | 0 | |
| nextPage | Integer | 下一頁的頁碼 | 0 | |
| endRow | Integer | 當前頁的最后一行的索引 | 1 | |
| pageSize | Integer | 每頁包含的數據條目數量 | 10 | |
| list | Array of Objects | 查詢結果主體 | list | |
| pageNum | Integer | 當前頁的頁碼 | 1 | |
| navigatePages | Integer | 導航頁數的數量 | 8 | |
| total | Integer | 總數據條目數量 | 1 | |
| pages | Integer | 總頁數 | 1 | |
| firstPage | Integer | 第一頁的頁碼 | 1 | |
| size | Integer | 當前頁包含的數據條目數量 | 1 | |
| isLastPage | Boolean | 指示當前頁是否是最后一頁 | true | |
| hasPreviousPage | Boolean | 指示是否有前一頁數據可用 | false | |
| isFirstPage | Boolean | 指示當前頁是否是第一頁 | true | |
| 表 list |
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| parameterGroupName | String | 參數組名稱 | Default-Mongo-4.0 | |
| valuetype | String | 參數數據類型 | string | |
| innerVersion | String | 小版本號 | ||
| restart | String | 參數是否重啟才能生效 | 1 | |
| dbVersion | String | 大版本號 | ||
| defaultValue | String | 默認值 | true | |
| groupId | String | 該參數是否允許用戶修改，0表示允許 | 0 | |
| description | String | 對參數的描述 | demo-****** | |
| parameterName | String | 參數名 | storage.directoryPerDB | |
| nodeType | String | 節點類型 | ||
| parameterValue | String | 參數值 | true | |
| userId | Integer | 用戶id | 14656 | |
| tenantId | Integer | 租戶id | ||
| prodInstId | String | 實例id | 60d420bffb394************************* | |
| id | Integer | 主鍵 | 1 | |
| isdefault | String | 該參數是否允許用戶修改，0表示允許 | 0 | |
| permitValue | String | 參數值允許范圍 |
枚舉參數
無
請求示例
請求url
無
請求頭header
prodInstId=60d420bffb394*************************
project-id = 0
regionId=bb9fdb42056f11eda1610242ac110002
請求體body
無
響應示例
{
"statusCode": 800,
"message": "查詢實例當前應用的參數列表成功",
"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
}
}
狀態碼
請參考
錯誤碼
請參考
