Updating a Parameter Template (a V3 API)

Function

This API is used to update a parameter template.

Constraints

None

API Calling

For details, see Calling APIs.

Authorization Information

Each account has permissions to call all APIs, but IAM users must have the required permissions specifically assigned.

If you are using role/policy-based authorization, see the required permissions in Permissions Policies and Supported Actions.
If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

ddm::updateParamGroup

Write

parameterGroup *

-

ddm:param:update

-

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
ddm::updateParamGroup	Write	parameterGroup *	-	ddm:param:update	-

URI

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

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID of a tenant in a region To obtain this value, see Obtaining a Project ID. Constraints N/A Range The value can contain 32 characters. Only letters and digits are supported. Default Value N/A
config_id	Yes	String	Definition Parameter template ID Constraints The default parameter template cannot be updated. Range The value can contain 36 characters. Only letters and digits are allowed. Default Value N/A

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
description	No	String	Definition Parameter template description Constraints N/A Range The value can contain a maximum of 256 characters and cannot contain carriage return characters or the following special characters ! < " = ' > & Default Value N/A
values	Yes	Map<String,String>	Definition Parameter values defined by users based on a default parameter template. Constraints N/A Range key: parameter name, for example, contains_shard_key or connection_idle_timeout. If this parameter is not specified, no parameter value is to be changed. value: parameter value, for example, 6 or 20. If key is not empty, the parameter value cannot be empty, either. Default Value N/A
name	No	String	Definition Parameter template name Constraints N/A Range The template name can contain 1 to 64 characters. Only letters (case-sensitive), digits, hyphens (-), underscores (_), and periods (.) are allowed. Default Value N/A

Example Request

Updating a parameter template

PUT https://{endpoint}/v3/a8e2a5e2a6xxxxxxxxxx5af5b9ddabe5/configurations/849c450a43xxxxxxxxxxf33cff5f0717pr09

{
  "values" : {
    "ddl_flowcontrol_threshold" : "10005"
  }
}

Response Parameters

Normal response

**Table 3** Response body parameters
Parameter	Type	Description
need_restart	Boolean	Definition Whether a DDM instance needs to be restarted. Range false: The DDM instance does not need to be restarted. true: The DDM instance needs to be restarted.