Comparing Parameter Templates

Function

This API is used to compare two parameter templates. Before calling this API:

Learn how to authorize and authenticate it.
Obtain the required region and endpoint.

Authorization Information

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

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

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	Dependency
gaussdbformysql:param:get	Read	-	-	gaussdb:param:list	-

URI

POST /v3/{project_id}/configurations/comparison

**Table 1** URI parameter
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 contains 32 characters. Only letters and digits are allowed. Default Value N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. To obtain this value, call the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the token value. Constraints N/A Range N/A Default Value N/A
X-Language	No	String	Definition Request language type. Constraints N/A Range en-us zh-cn Default Value en-us

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
source_configuration_id	Yes	String	Definition ID of the source parameter template for comparison. Constraints N/A Range To obtain this value, see Querying Parameter Templates. After the request is processed, the value of id in the response body is the value of source_configuration_id. Default Value N/A
target_configuration_id	Yes	String	Definition ID of the target parameter template for comparison. Constraints N/A Range To obtain this value, see Querying Parameter Templates. After the request is processed, the value of id in the response body is the value of target_configuration_id. Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response body parameter
Parameter	Type	Description
differences	Array of ParamGroupParameterDifferences objects	Definition Differences between parameters.

**Table 5** ParamGroupParameterDifferences
Parameter	Type	Description
parameter_name	String	Definition Parameter name. Range N/A
source_value	String	Definition Parameter value in the source parameter template. Range N/A
target_value	String	Definition Parameter value in the target parameter template. Range N/A

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Request

Comparing parameter templates

POST https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/configurations/comparison

{
  "source_configuration_id" : "a2069d40256f40078c52d90d6a91ee63pr07",
  "target_configuration_id" : "0cd8ef851dc4422f98e7717205ed13e6pr07"
}

Example Response

Status code: 200

Success.

{
  "differences" : [ {
    "parameter_name" : "innodb_purge_threads",
    "source_value" : 1,
    "target_value" : 4
  }, {
    "parameter_name" : "connect_timeout",
    "source_value" : 10,
    "target_value" : 20
  } ]
}