更新时间:2024-03-28 GMT+08:00
应用参数模板
功能介绍
将参数模板应用到实例,可以指定一个或多个实例。该接口应用参数模板任务将异步执行,可以根据返回结果中的job_id,使用获取指定ID的任务信息来查询参数模板应用到实例执行状态和结果。
- 调用接口前,您需要了解API 认证鉴权。
接口约束
- 支持的数据库引擎:MySQL、PostgreSQL、Microsoft SQL Server。
URI
- URI格式
- 参数说明
表1 参数说明 名称
是否必选
说明
project_id
是
租户在某一Region下的项目ID。
获取方法请参见获取项目ID。
config_id
是
参数模板ID。
请求消息
名称 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
instance_ids |
是 |
Array of strings |
实例ID列表对象。 |
请求示例
将参数模板应用到多个实例。
PUT https://{endpoint}/v3.1/0483b6b16e954cb88930a360d2c4e663/configurations/463b4b58-d0e8-4e2b-9560-5dea4552fde9/apply { "instance_ids": ["73ea2bf70c73497f89ee0ad4ee008aa2in01", "fe5f5a07539c431181fc78220713aebein01"] }
响应消息
- 正常响应要素说明
表3 要素说明 名称
参数类型
说明
configuration_id
String
参数模板ID。
configuration_name
String
参数模板名称。
success
Boolean
参数模板是否都应用成功。
- “true”表示参数模板都应用成功。
- “false”表示存在应用失败的参数模板。
job_id
String
任务流ID。
- 正常响应样例
{ "configuration_id": "cf49bbd7d2384878bc3808733c9e9d8bpr01", "configuration_name": "paramsGroup-bcf9", "job_id":"e4942c94-9d66-458e-beb7-90601664641e", "success":true }
- 异常响应
请参见异常请求结果。
状态码
- 正常
- 异常
请参见状态码。
错误码
请参见错误码。
父主题: API v3.1(推荐)