查询MongoDB实例的参数配置信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| dds:DescribeParameters | get |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DBInstanceId | string | 是 | 实例 ID。 说明
当本参数传入的是分片集群实例 ID 时，还需要传入 NodeId 参数。
| dds-bpxxxxxxxx |
| NodeId | string | 否 | 分片集群实例中的 Mongos 节点 ID 或 Shard 节点 ID。 说明
当 DBInstanceId 参数传入的是分片集群实例 ID 时，本参数才可用。
| d-bpxxxxxxxx |
| CharacterType | string | 否 | 实例的角色类型，取值说明：
| mongos |
| ExtraParam | string | 否 | 扩展参数。 | terrform |
返回参数
示例
正常返回示例
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 | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 403 | IncorrectDBInstanceType | Current DB instance type does not support this operation. | 当前实例类型不支持该操作。 |
| 404 | InvalidDBInstanceClass.NotFound | The specified DB instance type is not found. | 所选实例规格不存在，请重新选择。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2023-03-15 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |