Updated on 2026-09-22 GMT+08:00

Querying Instances that a Parameter Template Can Be Applied To

This API is used to query instances that a parameter template can be applied to.

This API supports the following instances:

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 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

gaussdbfornosql:instance:list

Read

-

-

nosql:backup:list

-

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
gaussdbfornosql:instance:list	Read	-	-	nosql:backup:list	-

GET /v3/{project_id}/configurations/{config_id}/applicable-instances

**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 contains 32 characters. Only letters and digits are allowed. Default Value N/A
config_id	Yes	String	Definition Parameter template ID. To obtain the value, see Obtaining Parameter Templates. Constraints N/A Range N/A Default Value N/A

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
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 greater than or equal to 0. Default Value The default value is 0, indicating that the query starts from the first data record.
limit	No	Integer	Definition Maximum records to be queried Constraints N/A Range 1 to 100 Default Value If this parameter is not transferred, the first 100 records are queried by default.
instance_name	No	String	Definition Instance name. Fuzzy search is supported. Constraints N/A Range N/A Default Value N/A
instance_id	No	String	Definition Instance ID. Fuzzy search is supported. To obtain the value, call the Querying Instances and Details API. Constraints N/A Range N/A Default Value N/A

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token You can obtain the token by calling the IAM API by following Obtaining a User Token Through Password Authentication. Constraints N/A Range N/A Default Value N/A

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
instances	Array of ApplicableInstanceRsp objects	Definition Instance information list.
count	Integer	Definition Total number of instances that the parameter template can be applied to. Range N/A

**Table 5** ApplicableInstanceRsp
Parameter	Type	Description
id	String	Definition Instance ID Range N/A
name	String	Definition Instance name Range N/A

URI example

GET https://{Endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/configurations/9e80bf6bbd7142f49761c07e9c32dd04pr06/applicable-instances?offset=0&limit=10

Status code: 200

Success

{
  "instances" : [ {
    "id" : "f38e203908bd4fae82714e88f12600f6in06",
    "name" : "test"
  } ],
  "count" : 1000
}

For details, see Status Codes.

For details, see Error Codes.

Parent topic: Parameter Configuration