Help Center/ GaussDB/ API Reference/ APIs (Recommended)/ Parameter Configuration/ Querying Instances That a Parameter Template Can Be Applied To

Updated on 2024-08-20 GMT+08:00

View PDF

Querying Instances That a Parameter Template Can Be Applied To

Function

This API is used to query the instances that the current parameter template can be applied to. 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}/applicable-instances

**Table 1** Parameter description
Parameter	Mandatory	Type	Description
project_id	Yes	String	Explanation: Project ID of a tenant in a region. For details about how to obtain the project ID, see Obtaining a Project ID. Restrictions: None Value range: The value can contain 32 characters. Only letters and digits are allowed. Default value: None
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 data entry. The default value is 0, indicating that the query starts from the first data entry. 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
instances	Array of objects	Parameter template information. For details, see Table 3.
total_count	Integer	Total number of records.

**Table 3** instances field data structure description
Parameter	Type	Description
instance_id	String	DB instance ID.
instance_name	String	DB instance name.

Example Request

Querying instances that the current parameter template can be applied to

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

Example Response

Instances that the current parameter template can be applied to queried.

{
    "instances": [
        {
            "instance_id": "1995a67680474481b3e42ac1474e32e0in14",
            "instance_name": "gauss-a283"
        },
        {
            "instance_id": "8303819fd8744ef69f34595e9710a33din14",
            "instance_name": "gauss-2423-lt-master"
        }
	],
    "total_count": 2
}