修改MongoDB实例的参数。
接口说明
注意事项
- 调用本接口时,云数据库MongoDB实例的状态为运行中。
- 如果修改的参数中包含需要重启才能生效的参数,调用本接口后实例将自动重启。您可以调用DescribeParameterTemplates接口查询哪些参数修改后需要重启实例才能生效。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
dds:ModifyParameters | WRITE |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 否 | 地域ID。您可以通过调用DescribeRegions接口查询。 | cn-hangzhou |
DBInstanceId | string | 是 | 实例ID。 说明当本参数传入的是分片集群实例ID时,还需要传入NodeId参数。 | dds-bp19f409d75**** |
NodeId | string | 否 | 分片集群实例中的Mongos节点ID或Shard节点ID。 说明当DBInstanceId参数传入的是分片集群实例ID时,本参数才可用。 | d-bp1b7bb3bbe**** |
Parameters | string | 是 | 需要修改的参数及参数值,格式为JSON串,例如:{"ParameterName1":"ParameterValue1","ParameterName2":"ParameterValue2"}。 说明您可以通过调用DescribeParameterTemplates接口查询默认的参数模板列表。 | {"operationProfiling.mode":"all","operationProfiling.slowOpThresholdMs":"200"} |
CharacterType | string | 否 | 实例的角色类型,取值说明:
| db |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "36923CC2-DDAB-4B48-A144-DA92C1E19537"
}
错误码
HTTP status code | 错误码 | 错误信息 |
---|---|---|
400 | InvalidParameters.Format | Specified parameters is not valid. |
访问错误中心查看更多错误码。