
# 应用参数模板 - ApplyingaParameterTemplate
#### 功能介绍
将参数模板应用到实例，可以指定一个或多个实例。
![](https://support.huaweicloud.com/api-nosql/public_sys-resources/notice_3.0-zh-cn.png)
该接口计划下线，建议及时切换到新接口[应用参数模板 - ApplyingaParameterTemplate](https://support.huaweicloud.com/api-nosql/nosql_06_0005.html)。
#### 接口约束
该接口支持如下数据库实例：
- GeminiDB Cassandra
- GeminiDB Mongo
- GeminiDB Influx经典部署模式实例
- GeminiDB Redis经典部署模式实例
 
该接口为异步接口，接口响应成功不代表参数模板应用成功。
#### 调试
您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=GaussDBforNoSQL&api=ApplyConfiguration)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-nosql/nosql_05_0023.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                                         | 访问级别  | 资源类型（\*为必须） | 条件键 | 别名                             | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | gaussdbfornosql:instance:applyConfiguration | Write | -           | -   | nosql:instance:modifyParameter | -      |
     
  
 
#### URI
PUT /v3/{project_id}/configurations/{config_id}/apply
表1路径参数 
| 参数         | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|:---|:---|:---|:---|
| project_id | 是    | String | **参数解释：** 租户在某一region下的project ID。获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-nosql/nosql_projectid.html)。 **约束限制：** 不涉及。 **取值范围：** 长度为32个字符，仅由英文字母和数字组成。 **默认取值：** 不涉及。 |
| config_id  | 是    | String | **参数解释：** 参数模板ID。获取方法请参见[获取参数模板列表 - ObtainingParameterTemplates](https://support.huaweicloud.com/api-nosql/nosql_06_0002.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。                                                                                                            |
   
#### 请求参数
表2请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|:---|:---|:---|:---|
| X-Auth-Token | 是    | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 |
   
表3请求Body参数 
| 参数           | 是否必选 | 参数类型             | 描述                                                                                                                           |
|:---|:---|:---|:---|
| instance_ids | 是    | Array of strings | **参数解释：** 实例ID列表对象。 **约束限制：** 不涉及。 |
   
#### 响应参数
**状态码： 200**
表4响应Body参数 
| 参数      | 参数类型    | 描述                                                                                                                                                                                                                                                                                                                                             |
|:---|:---|:---|
| job_id  | String  | **参数解释：** 应用参数模板的异步任务ID。 **取值范围：** 不涉及。                                                                                                                                                                                                            |
| success | Boolean | **参数解释：** 应用参数模板任务是否提交成功。 **取值范围：** - true：表示任务提交成功。  - false：表示任务提交失败。   |
   
#### 请求示例
应用参数模板
```
PUT https://{Endpoint}/v3/375d8d8fad1f43039e23d3b6c0f60a19/configurations/e02e76567ae04662a2753492b77f965bpr06/apply
{
  "instance_ids" : [ "73ea2bf70c73497f89ee0ad4ee008aa2in06" ]
}
```
#### 响应示例
**状态码： 200**
Success
```
{
  "job_id" : "463b4b58-d0e8-4e2b-9560-5dea4552fde9",
  "success" : true
}
```
#### 状态码
请参见[状态码](https://support.huaweicloud.com/api-nosql/nosql_status_code.html)。
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-nosql/nosql_error_code.html)。
