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.
URI
POST /v3/{project_id}/configurations/comparison
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 allowed. Default value: N/A |
Request 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: Default value: en-us |
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
Parameter |
Type |
Description |
---|---|---|
differences |
Array of ParamGroupParameterDifferences objects |
Definition: Differences between parameters. |
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
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 500
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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.