文档首页/文档数据库服务 DDS/API参考（联盟区域）/API v3（推荐）/参数配置/修改指定实例的参数
更新时间：2026-01-07 GMT+08:00
查看PDF
分享

修改指定实例的参数

接口说明

修改指定实例的参数，可以是实例，组，节点的参数模板。

URI

  • URI格式

    PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/configurations

表1 路径参数

名称

类型

IN

是否必选

描述

project_id

string

path

是

租户在某一region下的project ID。请参考获取项目ID章节获取项目编号。

instance_id

string

path

是

实例ID，可以调用“查询实例列表和详情”接口获取。如果未申请实例，可以调用“创建实例”接口创建。

请求参数

表2 请求Header参数

名称

类型

IN

是否必选

描述

X-Auth-Token

string

header

是

用户Token。

表3 请求Body参数

名称

是否必选

参数类型

说明

entity_id

是

String

实例ID或组ID或节点ID。可以调用“查询实例列表和详情”接口获取。如果未申请实例，可以调用“创建实例”接口创建。

  • 当变更的实例类型是集群，如果变更的是shard组或者config组的参数模板，传值为组ID。如果变更的是mongos节点的参数模板，传值为节点ID。
  • 当变更的实例类型是副本集，传值为实例ID。如果变更的是readonly节点的参数模板，传值为readonly节点ID。

parameter_values

是

Map<String,String>

参数名和参数值映射关系。用户可以基于默认参数模板的参数，自定义的参数值。

  • 请求示例 
    { 
  "entity_id" : "73ea2bf70c73497f89ee0ad4ee008aa2no02", 
  "parameter_values" : { 
    "max_connections" : "10" 
  } 
}

响应参数

  • 参数说明
    表4 响应Body参数

    参数

    参数类型

    描述

    job_id

    String

    修改实例参数的异步任务ID。

    restart_required

    Boolean

    参数修改涉及范围（实例，组，节点）否需要重启。

    • 取值为false，不需要重启。
    • 取值为true，需要重启。
  • 响应示例 
    {
	"job_id" : "bf26cf3c-d046-4080-bb45-f114be7afa5f",
	"result_required" : false
}

状态码

详情请参见状态码。

错误码

详情请参见错误码。

父主题：参数配置