文档首页/ 云数据库 GaussDB/ API参考/ API（推荐）/ 参数配置/ 应用参数模板 - ApplyingaParameterTemplate
更新时间：2026-07-16 GMT+08:00
查看PDF
分享

应用参数模板 - ApplyingaParameterTemplate

功能介绍

应用参数模板。

调试

您可以在API Explorer中调试该接口。

URI

PUT /v3/{project_id}/configurations/{config_id}/apply

表1 参数说明

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一Region下的项目ID。

获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认取值：

不涉及。

config_id

是

String

参数解释：

参数模板ID。

请参考获取参数模板列表 - ObtainingParameterTemplates获取参数模板ID。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为36个字符。

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

X-Language

否

String

参数解释：

指定接口返回信息的语言类型。

约束限制：

不涉及。

取值范围：

  • zh-cn：中文
  • en-us：英文

默认取值：

en-us
表3 参数说明

参数

是否必选

参数类型

描述

instance_ids

是

Array of strings

参数解释：

实例ID列表。请参考查询可应用实例列表 - QueryingInstancesThataParameterTemplateCanBeAppliedTo获取可应用的实例ID列表。

约束限制：

不涉及。

响应参数

表4 参数说明

参数

参数类型

描述

job_id

String

参数解释：

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

取值范围：

不涉及。

请求示例

应用参数模板。

PUT https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/configurations/3ca44134a16d4bbab8eb701e025b19f7pr14/apply
{ 
   "instance_ids" : [ "5362449138da4e408dbae5152ca26640in14", "ea926816f0154066830d12ebebc8562din14" ] 
 }

响应示例

应用参数模板成功。

{ 
  "job_id" : "bf26cf3c-d046-4080-bb45-f114be7afa5f" 
}

状态码

错误码

请参见错误码。

父主题： 参数配置