接口功能介绍

查询文档数据库实例默认的参数模板列表

接口约束

无

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
  }
}

状态码

请参考 状态码

错误码

请参考 错误码