Updated on 2024-09-11 GMT+08:00

Comparing Parameter Templates

Function

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

URI

POST /v3/{project_id}/configurations/comparison

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

It can be obtained by calling the IAM API used to obtain a user token.

The value of X-Subject-Token in the response header is the token value.

X-Language

No

String

Request language type. The default value is en-us.

Values:

  • en-us
  • zh-cn
Table 3 Request body parameter

Parameter

Mandatory

Type

Description

source_configuration_id

Yes

String

ID of the source parameter template for comparison.

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.

target_configuration_id

Yes

String

ID of the destination parameter template for comparison

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.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

differences

Array of ParamGroupParameterDifferences objects

Differences between parameters.

Table 5 ParamGroupParameterDifferences

Parameter

Type

Description

parameter_name

String

Parameter name.

source_value

String

Parameter value in the source parameter template.

target_value

String

Parameter value in the destination parameter template.

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
  } ]
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.