Updated on 2026-05-30 GMT+08:00

Comparing Two Parameter Templates (a V3 API)

Function

This API is used to compare two parameter templates.

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

    Read

    parameterGroup *

    -

    ddm:param:list

    -

URI

PUT /v3/{project_id}/configurations/diff

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

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

source_id

Yes

String

Definition

Source parameter template ID

Constraints

N/A

Range

The value can contain 36 characters. Only letters and digits are allowed.

Default Value

N/A

target_id

Yes

String

Definition

Target parameter template ID

Constraints

N/A

Range

The value can contain 36 characters. Only letters and digits are allowed.

Default Value

N/A

Example Request

Comparing two parameter templates

PUT https://{endpoint}/v3/a8e2a5e2a6xxxxxxxxxx5af5b9ddabe5/configurations/diff

{
  "source_id" : "849c450a43xxxxxxxxxxf33cff5f0717pr09",
  "target_id" : "8368f6642dxxxxxxxxxx9d683c00b7f0pr09"
}

Response Parameters

  • Normal response

Table 3 Response body parameters

Parameter

Type

Description

source_id

String

Definition

Source parameter template ID

Range

The value can contain 36 characters. Only letters and digits are allowed.

source_name

String

Definition

Source parameter template name

Range

N/A

target_id

String

Definition

Target parameter template ID

Range

The value can contain 36 characters. Only letters and digits are allowed.

target_name

String

Definition

Target parameter template name

Range

N/A

parameters

Array of ParamGroupParameterDiffV3 objects

Definition

Returned information about parameter template comparison

Range

N/A

Table 4 ParamGroupParameterDiffV3

Parameter

Type

Description

name

String

Definition

Parameter name

Range

N/A

source_value

String

Definition

Source parameter value

Range

N/A

target_value

String

Definition

Target parameter value

Range

N/A

Example Response

  • Normal response example
    {
      "parameters" : [ {
        "name" : "ddl_flowcontrol_threshold",
        "source_value" : "1005",
        "target_value" : "10000"
      } ],
      "source_id" : "849c450a43xxxxxxxxxxf33cff5f0717pr09",
      "source_name" : "paramTemplate-test",
      "target_id" : "8368f6642dxxxxxxxxxx9d683c00b7f0pr09",
      "target_name" : "paramTemplate-2b7f"
    }
  • Abnormal response

    For details, see Abnormal Request Results.

Status Codes

Error Codes

For details, see Error Codes.