Help Center/ Relational Database Service/ API Reference/ API v3 (Recommended)/ Parameter Management/ Querying Application Records of a Parameter Template
Updated on 2025-12-09 GMT+08:00

Querying Application Records of a Parameter Template

Function

This API is used to query application records of a parameter template.

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

-

Constraints

  • The following DB engines are supported: MySQL, Microsoft SQL Server, and PostgreSQL.

URI

  • URI format

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

  • Parameter description
    Table 1 Parameters

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    String

    Definition:

    Project ID of a tenant in a region.

    To obtain the value, see Obtaining a Project ID.

    Constraints:

    N/A

    Range:

    N/A

    Default Value:

    N/A

    config_id

    Yes

    String

    Definition:

    Parameter template ID.

    Constraints:

    N/A

    Range:

    N/A

    Default Value:

    N/A

    offset

    No

    Integer

    Definition:

    Index offset. The query starts from the next piece of data indexed by this parameter.

    Constraints:

    N/A

    Range

    The value is a number greater than or equal to 0.

    Default Value

    0: The query starts from the first data record.

    limit

    No

    Integer

    Definition:

    Number of records returned by a query.

    Constraints:

    N/A

    Range

    [1, 100]

    Default Value

    10

Request

  • Request parameters

    None

  • URI example
    https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/configurations/31fd23f61cc946b898a59adbfa71d18fpr01/apply-histories

Response

  • Normal response
    Table 2 Parameters

    Parameter

    Type

    Description

    total_count

    Integer

    Definition:

    Total number of parameter template application records.

    Range:

    N/A

    histories

    Array of objects

    Definition:

    List of historical application details.

    For details, see Table 3.

    Table 3 Data structure description of field histories

    Parameter

    Type

    Description

    instance_id

    String

    Definition:

    ID of the instance to which the parameter template is applied.

    Range:

    N/A

    instance_name

    String

    Definition:

    Name of the instance to which the parameter template is applied.

    Range:

    N/A

    apply_result

    String

    Definition:

    Result of applying the parameter template.

    Range:

    N/A

    apply_time

    String

    Definition:

    Time when the parameter template is applied.

    Range:

    N/A

    error_code

    String

    Definition:

    Error code displayed when you submit the request to apply the parameter template.

    Range:

    N/A

  • Example normal response
    {
      "histories": [
        {
          "instance_id": "3b197204c9f8421690f2e671ee73a8a2in01",
          "instance_name": "TestInstance",
          "apply_result": "SUCCESS",
          "apply_time": "2025-08-05T11:11:50+0000",
          "error_code": ""
        }
      ],
      "total_count": 1
    }
  • Abnormal response

    For details, see Abnormal Request Results.

Status Code

Error Code

For details, see Error Codes.