恢復默認參數v2
更新時間 2025-09-11 16:23:53
最近更新時間: 2025-09-11 16:23:53
分享文章
接口功能介紹
文檔數據庫恢復默認參數
接口約束
無
URI
POST /DDS2/v2/openApi/restoreDefaultParameters
路徑參數 無
Query參數 無
請求參數
請求頭header參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| project-id | 否 | String | 項目id | 0 | |
| prodInstId | 是 | String | 實例id | 60d420bffb394************************* | |
| regionId | 是 | String | 資源池id | bb9fdb42056f11eda1610242ac110002 |
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| nodeType | 是 | String | 實例對應的節點類型 | 單節點或副本集為：Mongod，對于集群可選：Mongos，Configsvr，Shard |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | String | 返回碼 取值范圍：800 成功 | 800 | |
| message | String | 返回消息 | 重置參數成功 | |
| returnObj | Object | 返回對象數組 | ||
| error | String | 錯誤碼。當接口失敗時才返回具體錯誤編碼，成功不返回或者為空。 | ||
| 表 returnObj |
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| parameterGroupName | String | 參數組名稱 | Default-Mongo-4.0 | |
| valuetype | String | 參數數據類型 | string | |
| restart | String | 參數是否重啟才能生效 | 1 | |
| defaultValue | String | 默認值 | 600 | |
| groupId | String | 該參數是否允許用戶修改，0表示允許 | null | |
| description | String | 對參數的描述 | test_001 | |
| parameterName | String | 參數名 | storage.directoryPerDB | |
| parameterValue | String | 參數值 | true | |
| userId | Integer | 用戶id | 171 | |
| tenantId | Integer | 租戶id | 688 | |
| prodInstId | String | 實例id | 60d420bffb394************************* | |
| id | Integer | 主鍵 | 1 | |
| isdefault | String | 該參數是否允許用戶修改，0表示允許 | 0 | |
| permitValue | String | 參數值允許范圍 | >5 | |
| lastPage | Integer | 最后一頁的頁碼。 | 1 | |
| navigatepageNums | Object | 可用于導航的頁碼數組。 | ||
| startRow | Integer | 當前頁的第一行的索引。 | 1 | |
| hasNextPage | Boolean | 指示是否有下一頁數據可用。 | false | |
| prePage | Integer | 前一頁的頁碼。 | 0 | |
| nextPage | Integer | 下一頁的頁碼。 | 0 | |
| endRow | Integer | 當前頁的最后一行的索引。 | 1 | |
| pageSize | Integer | 每頁包含的數據條目數量。 | 10 | |
| 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 |
枚舉參數
無
請求示例
請求url
無
請求頭header
prodInstId=60d420bffb394*************************
project-id = 0
regionId=bb9fdb42056f11eda1610242ac110002
**請求參數body**
{
"nodeType": "Mongod"
}
### 響應示例
{
"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": "int",
"restart": "1",
"defaultValue": "600",
"groupId": null,
"description": "表示當前實例與其他mongod實例通信的連接池的最大連接數",
"parameterName": "connPoolMaxConnsPerHost",
"parameterValue": "61111",
"userId": 55555,
"tenantId": 0,
"prodInstId": null,
"id": 5636,
"isdefault": "0",
"permitValue": ""
},
{
"parameterGroupName": "Default-Mongo-4.0",
"valuetype": "int",
"restart": "0",
"defaultValue": "600000",
"groupId": null,
"description": "設置空閑游標的有效時間，如果超過該值，MongoDB將刪除空閑的游標",
"parameterName": "cursorTimeoutMillis",
"parameterValue": "600000",
"userId": 55555,
"tenantId": 0,
"prodInstId": null,
"id": 5637,
"isdefault": "0",
"permitValue": ""
},
{
"parameterGroupName": "Default-Mongo-4.0",
"valuetype": "string",
"restart": "1",
"defaultValue": "true",
"groupId": null,
"description": "是否禁用JavaScript腳本實時編譯的功能",
"parameterName": "disableJavaScriptJIT",
"parameterValue": "true",
"userId": 55555,
"tenantId": 0,
"prodInstId": null,
"id": 5638,
"isdefault": "1",
"permitValue": "true,false"
},
{
"parameterGroupName": "Default-Mongo-4.0",
"valuetype": "string",
"restart": "0",
"defaultValue": "true",
"groupId": null,
"description": "如果設置為false，當文檔的索引字段長度超過Index Key Length Limit，則報錯",
"parameterName": "failIndexKeyTooLong",
"parameterValue": "true",
"userId": 55555,
"tenantId": 0,
"prodInstId": null,
"id": 5639,
"isdefault": "1",
"permitValue": "true,false"
},
{
"parameterGroupName": "Default-Mongo-4.0",
"valuetype": "int",
"restart": "1",
"defaultValue": "65536",
"groupId": null,
"description": "mongos或mongod可接受的最大同時連接數量",
"parameterName": "net.maxIncomingConnections",
"parameterValue": "65536",
"userId": 55555,
"tenantId": 0,
"prodInstId": null,
"id": 5640,
"isdefault": "0",
"permitValue": ">5"
},
{
"parameterGroupName": "Default-Mongo-4.0",
"valuetype": "string",
"restart": "1",
"defaultValue": "slowOp",
"groupId": null,
"description": " 是否開啟慢語句記錄。OFF為關閉，all記錄所有語句。slowOp記錄執行時間大于閥值的語句",
"parameterName": "operationProfiling.mode",
"parameterValue": "slowOp",
"userId": 55555,
"tenantId": 0,
"prodInstId": null,
"id": 5641,
"isdefault": "0",
"permitValue": " off,slowOp,all "
},
{
"parameterGroupName": "Default-Mongo-4.0",
"valuetype": "int",
"restart": "1",
"defaultValue": "100",
"groupId": null,
"description": "operationProfiling.mode設置為slowOp時，數據庫認定的慢語句的閥值（毫秒）",
"parameterName": "operationProfiling.slowOpThresholdMs",
"parameterValue": "100",
"userId": 55555,
"tenantId": 0,
"prodInstId": null,
"id": 5651,
"isdefault": "0",
"permitValue": ""
},
{
"parameterGroupName": "Default-Mongo-4.0",
"valuetype": "string",
"restart": "1",
"defaultValue": "enabled",
"groupId": null,
"description": " 是否開啟基于角色的權限控制，出于安全理由，必須開啟",
"parameterName": "security.authorization",
"parameterValue": "enabled",
"userId": 171,
"tenantId": 0,
"prodInstId": null,
"id": 55555,
"isdefault": "1",
"permitValue": " disabled,enabled "
},
{
"parameterGroupName": "Default-Mongo-4.0",
"valuetype": "string",
"restart": "1",
"defaultValue": "true",
"groupId": null,
"description": "是否為每個數據庫創建一個單獨的目錄來保存數據，目錄名即為數據庫名",
"parameterName": "storage.directoryPerDB",
"parameterValue": "true",
"userId": 55555,
"tenantId": 0,
"prodInstId": null,
"id": 5643,
"isdefault": "1",
"permitValue": "true,false "
},
{
"parameterGroupName": "Default-Mongo-4.0",
"valuetype": "string",
"restart": "1",
"defaultValue": "wiredTiger",
"groupId": null,
"description": "MONGODB的存儲引擎，天翼云MONGODB目前只支持WIREDTIGER",
"parameterName": "storage.engine",
"parameterValue": "wiredTiger",
"userId": 55555,
"tenantId": 0,
"prodInstId": null,
"id": 5644,
"isdefault": "1",
"permitValue": " mmapv1,wiredTiger, inmem"
}
],
"pageNum": 1,
"navigatePages": 8,
"total": 17,
"pages": 2,
"firstPage": 1,
"size": 10,
"isLastPage": false,
"hasPreviousPage": false,
"isFirstPage": true
}
}
### 狀態碼
| **狀態碼** | 描述 |
|---------|---------------------|
| 800 | 表示請求成功。 |
| 900 | 請求響應失敗，失敗原因見message |
### 錯誤碼
請求體body
無
響應示例
無
狀態碼
請參考
錯誤碼
請參考
