
# 应用参数模板
#### 功能介绍
将参数模板应用到实例，可以指定一个或多个实例。
**当前页面API为历史版本API，未来可能停止维护。建议及时切换到新接口[应用参数模板 - ApplyConfigurationAsync](https://support.huaweicloud.com/api-rds/rds_09_0304.html)。**
- 调用接口前，您需要了解API[认证鉴权](https://support.huaweicloud.com/api-rds/rds_03_0001.html)。
- 调用接口前，您需要了解[请求Header参数说明](https://support.huaweicloud.com/api-rds/rds_03_0005.html#rds_03_0005__section479119143310)。
 
#### 调试
您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=RDS&api=EnableConfiguration)中调试该接口。
#### 接口约束
- 支持的数据库引擎：MySQL、PostgreSQL、Microsoft SQL Server。
 
#### URI
- URI格式 PUT /v3/{*project_id*}/configurations/{config_id}/apply
  
- 参数说明
  表1参数说明 
  | 名称         | 是否必选 | 说明                                                                                                                                      |
  |:---|:---|:---|
  | project_id | 是    | 租户在某一region下的project ID。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-rds/rds_03_0002.html)。 |
  | config_id  | 是    | 参数模板ID。                                                                                                                                 |
     
  
 
#### 请求消息
参数说明
表2参数说明 
| 名称           | 是否必选 | 参数类型             | 说明        |
|:---|:---|:---|:---|
| instance_ids | 是    | Array of strings | 实例ID列表对象。 |
   
#### 请求样例
```
https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/configurations/463b4b58-d0e8-4e2b-9560-5dea4552fde9/apply
{
"instance_ids": ["73ea2bf70c73497f89ee0ad4ee008aa2in01", "fe5f5a07539c431181fc78220713aebein01"]
}
```
#### 响应消息
- 正常响应要素说明
  表3要素说明 
  | 名称                 | 参数类型             | 说明                                                                                                                                                                                                                                                                                                |
  |:---|:---|:---|
  | configuration_id   | String           | 参数模板ID。                                                                                                                                                                                                                                                                                           |
  | configuration_name | String           | 参数模板名称。                                                                                                                                                                                                                                                                                           |
  | apply_results      | Array of objects | 参数模板应用具体结果。 详情请参见[表4]。                                                                                                                                                                                            |
  | success            | Boolean          | 参数模板是否都应用成功。 - "true"表示参数模板都应用成功。  - "false"表示存在应用失败的参数模板。   |
  | job_id             | String           | 任务流ID。                                                                                                                                                                                                                                                                                            |
     
   表4apply_results字段数据结构说明 
  | 名称               | 参数类型    | 说明                                                                                                                                                                                                                                                                                  |
  |:---|:---|:---|
  | instance_id      | String  | 实例ID。                                                                                                                                                                                                                                                                               |
  | instance_name    | String  | 实例名称。                                                                                                                                                                                                                                                                               |
  | restart_required | Boolean | 实例是否需要重启。 - "true"需要重启。  - "false"不需要重启。          |
  | success          | Boolean | 参数模板是否应用成功。 - "true"表示应用成功。  - "false"表示应用失败。   |
     
  

- 正常响应样例
  ```
  {
  "configuration_id": "cf49bbd7d2384878bc3808733c9e9d8bpr01",
  "configuration_name": "paramsGroup-bcf9",
          "job_id":"e4942c94-9d66-458e-beb7-90601664641e",
  "apply_results": [{
  "instance_id": "fe5f5a07539c431181fc78220713aebein01",
  "instance_name": "zyy1",
  "restart_required": false,
  "success": false
  }, {
  "instance_id": "73ea2bf70c73497f89ee0ad4ee008aa2in01",
  "instance_name": "zyy2",
  "restart_required": false,
  "success": false
  }],
  "success": false
  }
  ```
  
- 异常响应 请参见[异常响应结果](https://support.huaweicloud.com/api-rds/rds_01_0010.html)。
  
 
#### 状态码
- 正常 200
  
- 异常 请参见[状态码](https://support.huaweicloud.com/api-rds/rds_10_0200.html)。
  
 
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-rds/rds_10_0201.html)。
