Querying Instances That a Parameter Template Is Applied to

Function

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

Before calling this API, learn how to authenticate it.
Before calling this API, learn about request header parameters.

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:instance:listAll	read	-	-	rds:instance:list	-

Constraints

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

URI

URI format
GET /v3/{project_id}/configurations/{config_id}/query-instances

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 an integer 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/54623db08b174c858ba779d2aa7923a3/configurations/0fb680b064cb496ca7acc7634070a652pr01/query-instances

Response

Normal response

**Table 2** Parameters
Parameter	Type	Description
entities	Arrays of Object	Definition List of instances. For details, see Table 3.
instance_count_limit	Integer	Definition Limit on the number of instances. Range N/A
total_count	Integer	Definition Total number of instances that the parameter template is applied to. Range N/A

**Table 3** entities field data structure description
Parameter	Type	Description
entity_id	String	Definition Instance ID. Range N/A
entity_name	String	Definition Instance name. Range N/A

Example normal response

{
  "entities": [
    {
      "entity_id": "70308e5ca5dd4555be02a596ecd3e5acin01",
      "entity_name": "instance01"
    }
  ],
  "instance_count_limit": 1000,
  "total_count": 1
}