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

应用参数模板

接口说明

指定实例变更参数模板。

URI

  • URI格式

    PUT https://{Endpoint}/v3/{project_id}/configurations/{config_id}/apply

表1 路径参数

名称

参数类型

是否必选

说明

project_id

String

是

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

config_id

String

是

参数模板ID。

请求参数

表2 请求Header参数

名称

类型

IN

是否必选

描述

X-Auth-Token

string

header

是

用户Token。

表3 请求Body参数

名称

是否必选

参数类型

说明

entity_ids

是

Array of strings

实例ID、组ID或节点ID的列表对象。可以调用“查询实例列表和详情”接口获取。如果未申请实例，可以调用“创建实例”接口创建。
  • 当应用的实例类型是集群，如果应用的是shard组或者config组的参数模板，传值为组ID。如果应用的是mongos节点的参数模板，传值为节点ID。
  • 当应用的实例类型是副本集，传值为实例ID。如果应用的是readonly节点的参数模板，传值为节点ID。
  • 请求示例 
    {
  "entity_ids": [
    "73ea2bf70c73497f89ee0ad4ee008aa2no02"
  ]
}

响应参数

表4 响应Body参数

参数

参数类型

描述

job_id

String

应用参数模板的异步任务ID。

  • 响应示例 
    { 
  "job_id" : "bf26cf3c-d046-4080-bb45-f114be7afa5f" 
}

状态码

详情请参见状态码。

错误码

详情请参见错误码。

父主题：参数配置