Help Center/ GaussDB/ API Reference/ APIs (Recommended)/ Parameter Configuration/ Querying Application Records of a Parameter Template
Updated on 2025-08-11 GMT+08:00

Querying Application Records of a Parameter Template

Function

This API is used to view application records of a parameter template. Before calling this API:

URI

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

Table 1 Parameter description

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

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

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

offset

No

Integer

Definition

Index offset. The query starts from the next piece of data indexed by this parameter. For example, if this parameter is set to 0 and limit is set to 10, only the 1st to 10th data records are displayed.

Constraints

N/A

Range

[0,2^31-1]

Default Value

0: The query starts from the first data record.

limit

No

Integer

Definition

Number of records returned by a query. For example, if this parameter is set to 10, a maximum of 10 records can be displayed.

Constraints

N/A

Range

[1, 100]

Default Value

100

Request Parameters

None

Response Parameters

Table 2 Parameter description

Parameter

Type

Description

histories

Array of objects

Definition

Application records. For details, see Table 3.

total_count

Integer

Definition

Total number of records.

Range

N/A

Table 3 histories field data structure description

Parameter

Type

Description

instance_id

String

Definition

DB instance ID.

Range

N/A

instance_name

String

Definition

DB instance name.

Range

N/A

apply_result

String

Definition

Application status.

Range

  • SUCCESS
  • FAILED
  • APPLYING

applied_at

String

Definition

Application time in the yyyy-mm-ddThh:mm:ssZ format. T is the separator between calendar and hourly notation of time. Z indicates the time zone offset. For example, in the Beijing time zone, the offset is shown as +0800.

Range

N/A

error_code

String

Definition

Error code of the failure cause, for example, DBS.280005.

Range

N/A

Example Request

Querying application records of a parameter template

GET https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/configurations/3ca44134a16d4bbab8eb701e025b19f7pr14/applied-histories

Example Response

Application records of the parameter template queried.

{
    "histories": [
        {
            "instance_id": "1995a67680474481b3e42ac1474e32e0in14",
            "instance_name": "gauss-a283",
            "apply_result" : "SUCCESS", 
            "applied_at" : "2022-08-09T03:06:52+0800", 
            "error_code" : ""
        },
        {
            "instance_id": "8303819fd8744ef69f34595e9710a33din14",
            "instance_name": "gauss-2423-lt-master",
            "apply_result" : "FAILED",
            "applied_at" : "2022-08-09T03:06:52+0800", 
            "error_code" : "DBS.280005"
        }
	],
    "total_count": 2
}

Status Codes

Error Codes

For details, see Error Codes.