Help Center/ Distributed Database Middleware/ API Reference/ APIs (Recommended)/ Parameter Management/ Querying Parameter Template Application Records (a V3 API)
Updated on 2026-05-30 GMT+08:00

Querying Parameter Template Application Records (a V3 API)

Function

This API is used to query parameter template application records.

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

GET /v3/{project_id}/configurations/{config_id}/apply-histories

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

config_id

Yes

String

Definition

Parameter template ID

Constraints

N/A

Range

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

Default Value

N/A

Table 2 Query parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Definition

Index offset.

Constraints

N/A

Range

The value is greater than or equal to 0.

Default Value

0

limit

No

Integer

Definition

Number of records to be queried.

Constraints

N/A

Range

The value is greater than 0 and less than or equal to 128.

Default Value

10

Request Parameters

None

Example Request

Querying parameter template application records

GET https://{endpoint}/v3/configurations/{config_id}/apply-histories

Response Parameters

  • Normal response
Table 3 Response body parameters

Parameter

Type

Description

histories

Array of ApplyHistory objects

Definition

Information about parameter template application records.

Range

N/A

total

Integer

Definition

Total number of parameter application records.

Range

N/A

Table 4 ApplyHistory

Parameter

Type

Description

target_id

String

Definition

Parameter template ID

Range

N/A

target_name

String

Definition

Parameter template name

Range

N/A

apply_result

String

Definition

Result of applying the parameter template to the instance

Range

  • SUCCESS: The parameter template is successfully applied to the instance.

  • FAILED: The parameter template fails to be applied to the instance.
  • APPLYING: The parameter template is being applied to the instance.

applied_at

String

Definition

Date when the template is applied. The format is yyyy-mm-ddThh:mm:ssZ. T is the separator between the calendar and the hourly notation of time. Z indicates the time zone offset. For example, in the Beijing time zone, the offset is +0800.

Range

N/A

error_message

String

Definition

Error message of applying the parameter template to the instance. If the parameter template is successfully applied to the instance, no error information is returned.

Range

N/A

Example Response

  • Normal response example
    {
      "histories" : [ {
        "target_id" : "59974b82e7xxxxxxxxxx9802d28bbe18in09",
        "target_name" : "ddm-test1",
        "apply_result" : "SUCCESS",
        "applied_at" : "2026-01-06T07:07:51+0000",
        "error_code" : ""
      }, {
        "target_id" : "59974b82e7xxxxxxxxxx9802d28bbe18in09",
        "target_name" : "ddm-test2",
        "apply_result" : "SUCCESS",
        "applied_at" : "2026-01-06T06:22:48+0000",
        "error_code" : ""
      } ],
      "total" : 9
    }
  • Abnormal response

    For details, see Abnormal Request Results.

Status Codes

Error Codes

For details, see Error Codes.