接口功能介紹

查詢文檔數據庫實例默認的參數模板列表

接口約束

無

URI

GET /DDS2/v2/openApi/describeParameterTemplates

路徑參數 無

Query參數

請求參數

請求頭header參數

請求體body參數 無

響應參數

枚舉參數

無

請求示例

請求url

/v1/openApi/describeParameterTemplates?prodInstId=60d420bffb394*************************&parameterGroupUsed=Default-Mongo-4.0

請求頭header

project-id=0
regionId=bb9fdb42056f11eda1610242ac110002

請求體body

無

響應示例

{
  "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": "int",
        "restart": "1",
        "defaultValue": "600",
        "groupId": null,
        "description": "表示當前實例與其他mongod實例通信的連接池的最大連接數",
        "parameterName": "connPoolMaxConnsPerHost",
        "parameterValue": "61111",
        "userId": 171,
        "tenantId": 688,
        "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": 171,
        "tenantId": 688,
        "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": 171,
        "tenantId": 688,
        "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": 171,
        "tenantId": 688,
        "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": 171,
        "tenantId": 688,
        "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": 171,
        "tenantId": 688,
        "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": 171,
        "tenantId": 688,
        "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": 688,
        "prodInstId": null,
        "id": 5642,
        "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": 171,
        "tenantId": 688,
        "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": 171,
        "tenantId": 688,
        "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
  }
}

狀態碼

請參考

錯誤碼

請參考