文档

DescribeParameters - 查询实例的参数配置信息

查询MongoDB实例的参数配置信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dds:DescribeParametersRead
  • dbinstance
    acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

请求参数

名称类型必填描述示例值
DBInstanceIdstring

实例 ID。

说明 当本参数传入的是分片集群实例 ID 时,还需要传入 NodeId 参数。
dds-bpxxxxxxxx
NodeIdstring

分片集群实例中的 Mongos 节点 ID 或 Shard 节点 ID。

说明 DBInstanceId 参数传入的是分片集群实例 ID 时,本参数才可用。
d-bpxxxxxxxx
CharacterTypestring

实例的角色类型,取值说明:

  • db:shard 角色。
  • cs:config server 角色。
  • mongos:mongos 角色。
mongos
ExtraParamstring

拓展参数

terrform

返回参数

名称类型描述示例值
object
RunningParametersobject []

当前运行的参数配置信息列表。

CheckingCodestring

参数取值范围。

[33554432-268435456]
ParameterNamestring

参数名。

setParameter.internalQueryExecMaxBlockingSortBytes
ParameterValuestring

参数值。

33554432
ForceRestartstring

修改参数后是否需要重启生效。

  • false:无需重启,提交后即生效。
  • true:需要重启生效。
false
ParameterDescriptionstring

参数描述。

The maximum memory bytes that sort stage may use, default is 33554432(i.e. 32MB)
ModifiableStatusstring

参数是否处于可修改的状态。

  • false:不可修改。
  • true:可修改。
true
CharacterTypestring

实例的角色类型,取值说明:

  • db:shard 角色。
  • cs:config server 角色。
  • mongos:mongos 角色。
db
EngineVersionstring

数据库版本号。

4.0
RequestIdstring

请求 ID。

3ADD0C7D-2D2A-4F15-88FF-E7AC9B9FDCC8
ConfigParametersobject []

配置中的参数配置信息列表。

CheckingCodestring

参数取值范围。

[0-65536]
ParameterNamestring

参数名。

operationProfiling.slowOpThresholdMs
ParameterValuestring

参数值。

200
ForceRestartboolean

修改参数后是否需要重启生效。

  • false:无需重启,提交后即生效。
  • true:需要重启生效。
true
ParameterDescriptionstring

参数描述。

The threshold in milliseconds at which the database profiler considers a query slow, default is 100.
ModifiableStatusboolean

参数是否处于可修改的状态。

  • false:不可修改。
  • true:可修改。
true
Enginestring

数据库引擎,默认返回 mongodb

mongodb

示例

正常返回示例

JSON格式

{
  "RunningParameters": {
    "Parameter": [
      {
        "CheckingCode": "[33554432-268435456]",
        "ParameterName": "setParameter.internalQueryExecMaxBlockingSortBytes",
        "ParameterValue": "33554432",
        "ForceRestart": "false",
        "ParameterDescription": "The maximum memory bytes that sort stage may use, default is 33554432(i.e. 32MB)",
        "ModifiableStatus": "true",
        "CharacterType": "db"
      }
    ]
  },
  "EngineVersion": "4.0",
  "RequestId": "3ADD0C7D-2D2A-4F15-88FF-E7AC9B9FDCC8",
  "ConfigParameters": {
    "Parameter": [
      {
        "CheckingCode": "[0-65536]",
        "ParameterName": "operationProfiling.slowOpThresholdMs",
        "ParameterValue": "200",
        "ForceRestart": true,
        "ParameterDescription": "The threshold in milliseconds at which the database profiler considers a query slow, default is 100.",
        "ModifiableStatus": true
      }
    ]
  },
  "Engine": "mongodb"
}

错误码

HTTP status code错误码错误信息描述
403IncorrectDBInstanceTypeCurrent DB instance type does not support this operation.当前实例类型不支持该操作。
404InvalidDBInstanceClass.NotFoundThe specified DB instance type is not found.所选实例规格不存在,请重新选择。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-03-15OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:403
    删除错误码:404
入参OpenAPI 入参发生变更
    新增入参:ExtraParam
  • 本页导读 (1)
文档反馈