Updated on 2025-12-09 GMT+08:00

Comparing Parameter Templates

Function

This API is used to compare parameter templates.

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

Dependencies

rds:param:get

read

-

-

rds:param:list

-

URI

  • URI format

    PUT /v3/{project_id}/configurations/difference

  • Parameter description
    Table 1 Parameters

    Parameter

    Mandatory

    Description

    project_id

    Yes

    Definition

    Project ID of a tenant in a region.

    To obtain the value, see Obtaining a Project ID.

    Constraints

    The value cannot be empty.

    Range

    N/A

    Default Value

    N/A

Request

Table 2 Parameters

Parameter

Mandatory

Type

Description

source_id

Yes

String

Definition

Source parameter template ID.

Constraints

N/A

Range

N/A

Default Value

N/A

target_id

Yes

String

Definition

Target parameter template ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Example Request

Compare the parameter values of two parameter templates.

PUT https://{Endpoint}/v3/54623db08b174c858ba779d2aa7923a3/configurations/difference

{ 
  "source_id" : "3bc1e9cc0d34404b9225ed7a58fb284epr01", 
  "target_id" : "6f906cd03be84aff81cd41c4c61434e0pr01" 
}

Response

  • Normal response
    Table 3 Parameters

    Parameter

    Type

    Description

    source_id

    String

    Definition

    Source parameter template ID.

    Range

    N/A

    target_id

    String

    Definition

    Target parameter template ID.

    Range

    N/A

    source_name

    String

    Definition

    Source parameter template name.

    Range

    N/A

    target_name

    String

    Definition

    Target parameter template name.

    Range

    N/A

    parameters

    Array of objects

    Definition

    Template parameter differences.

    For details, see Table 4.

    Table 4 parameters element structure description

    Parameter

    Type

    Description

    name

    String

    Definition

    Parameter name.

    Range

    N/A

    source_value

    String

    Definition

    Parameter value in the source template.

    Range

    N/A

    target_value

    String

    Definition

    Parameter value in the target template.

    Range

    N/A

  • Example normal response
    {
      "source_id": "3bc1e9cc0d34404b9225ed7a58fb284epr01",
      "source_name": "parameter-group-1",
      "target_id": "6f906cd03be84aff81cd41c4c61434e0pr01",
      "target_name": "parameter-group-2",
      "parameters": [
        {
          "name": "parameter1",
          "source_value": "OFF",
          "target_value": "ON"
        },
        {
          "name": "parameter2",
          "source_value": "300",
          "target_value": "127"
        }
      ]
    }
  • Abnormal response

    For details, see Abnormal Request Results.

Status Code

Error Code

For details, see Error Codes.