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

应用参数模板

接口说明

指定实例变更参数模板。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

  • URI格式

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

  • URI样例

    https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/configurations/7a8d539ba30f43adaf1b16d08b1df4bdpr02/apply

表1 请求参数

名称

参数类型

是否必选

说明

X-Auth-Token

String

是

从IAM服务获取的用户Token。请参考认证鉴权。

project_id

String

是

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

config_id

String

是

参数模板ID。

请求消息

  • 参数说明
    表2 请求Body参数

    名称

    是否必选

    参数类型

    说明

    entity_ids

    是

    Array of strings
    实例ID或组ID或节点ID的列表对象。可以调用“查询实例列表和详情”接口获取。如果未申请实例，可以调用“创建实例”接口创建。
    • 当变更的实例类型是集群，如果变更的是shard组或者config组的参数模板，传值为组ID。如果变更的是mongos节点的参数模板，传值为节点ID。
    • 当变更的实例类型是副本集或单节点，传值为实例ID。

请求示例

变更指定实例参数模板，entity_ids为73ea2bf70c73497f89ee0ad4ee008aa2no02 
{
  "entity_ids": [
    "73ea2bf70c73497f89ee0ad4ee008aa2no02"
  ]
}

响应消息

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

    参数

    参数类型

    描述

    job_id

    String

    应用参数模板的异步任务ID。
  • 响应示例 
    { 
  "job_id" : "bf26cf3c-d046-4080-bb45-f114be7afa5f" 
}

SDK

单击文档数据库服务 DDS SDK，下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。

状态码

详情请参见状态码。

错误码

详情请参见错误码。

父主题： 参数配置

相关文档