Querying Application Records of a Parameter Template

Function

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

Learn how to authenticate this API.
Obtain the required region and endpoint.

URI

GET https://{Endpoint}/v3/{project_id}/configurations/{config_id}/applied-histories

**Table 1** Parameter description
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID of a tenant in a region. For details about how to obtain the project ID, see Obtaining a Project ID.
config_id	Yes	String	Parameter template ID.
offset	No	Integer	Index offset. If offset is set to N, the resource query starts from the N+1 piece of data. The value is 0 by default, indicating that the query starts from the first piece of data. The value cannot be a negative number. For example, if this parameter is set to 0 and limit is set to 10, only the 1st to 10th records are displayed.
limit	No	Integer	Number of records to be queried. The default value is 100. The value cannot be a negative number. The minimum value is 1 and the maximum value is 100. For example, if this parameter is set to 10, a maximum of 10 records can be displayed.

Request Parameters

None

Response Parameters

**Table 2** Parameter description
Parameter	Type	Description
histories	Array of objects	Application records. For details, see Table 3.
total_count	Integer	Total number of records.

**Table 3** histories field data structure description
Parameter	Type	Description
instance_id	String	DB instance ID.
instance_name	String	DB instance name.
apply_result	String	Application status. SUCCESS FAILED APPLYING
applied_at	String	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.
error_code	String	Error code of the failure cause, for example, DBS.280005.

Example Request

Querying application records of a parameter template

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

Example Response

Application records of the parameter template queried.

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