应用参数模板

功能介绍

将参数模板应用到实例，可以指定一个或多个实例。

• 调用接口前，您需要了解API 认证鉴权。
• 调用接口前，您需要提前获取到地区和终端节点，即下文中的Endpoint值。

接口约束

• 支持的数据库引擎：MySQL、PostgreSQL。

URI

• URI格式

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

• 参数说明

  表1 参数说明

  名称	是否必选	说明
  project_id	是	租户在某一region下的project ID。 获取方法请参见获取项目ID。
  config_id	是	参数模板ID。

请求消息

• 参数说明

  表2 参数说明

  名称	是否必选	参数类型	说明
  instance_ids	是	Array of strings	实例ID列表对象。

• 请求样例

{
	"instance_ids": ["73ea2bf70c73497f89ee0ad4ee008aa2in01", "fe5f5a07539c431181fc78220713aebein01"]
}

响应消息

• 正常响应要素说明

  表3 要素说明

  名称	参数类型	说明
  configuration_id	String	参数模板ID。
  configuration_name	String	参数模板名称
  apply_results	Array of objects	参数模板应用具体结果。 详情请参见表4。
  success	Boolean	参数模板是否都应用成功。 “true”表示参数模板都应用成功。 “false”表示存在应用失败的参数模板。

  表4 apply_results字段数据结构说明

  名称	参数类型	说明
  instance_id	String	实例ID。
  instance_name	String	实例名称。
  restart_required	Boolean	实例是否需要重启。 “true”需要重启。 “false”不需要重启。
  success	Boolean	参数模板是否应用成功。 “true”表示应用成功。 “false”表示应用失败。

• 正常响应样例

  {
  	"configuration_id": "cf49bbd7d2384878bc3808733c9e9d8bpr01",
  	"configuration_name": "paramsGroup-bcf9",
  	"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
  }

• 异常响应

  请参见异常请求结果。

状态码

请参见状态码。

错误码

请参见错误码。