Updated on 2026-03-16 GMT+08:00

Querying Instances That a Parameter Template Can Be Applied To

Function

This API is used to query DB instances that a parameter template can be applied to. Before calling this API:

Learn how to authenticate it.
Obtain the required region and endpoint.

URI

GET /v3/{project_id}/configurations/{configuration_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
configuration_id	Yes	String	Definition Parameter template ID. To obtain this value, see Querying Parameter Templates. Constraints N/A Range The value contains 36 characters, starting with a UUID and ending with pr07. Only letters and digits are allowed. 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 The value must be an integer and cannot be a negative number. Range ≥ 0 Default Value 0
limit	No	Integer	Definition Number of records to be queried. Constraints The value must be an integer and cannot be a negative number. Range 1–100 Default Value 100

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. To obtain this value, call the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the token value. Constraints N/A Range N/A Default Value N/A
X-Language	No	String	Definition Request language type. Constraints N/A Range en-us zh-cn Default Value en-us

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
instances	Array of ApplicableInstances objects	Definition Response body of instances that the parameter template can be applied to.
total_count	Integer	Definition Number of instances that the parameter template can be applied to. Range N/A

**Table 5** ApplicableInstances
Parameter	Type	Description
instance_id	String	Definition Instance ID. Range The value contains 36 characters with a suffix of in07. Only letters and digits are allowed.
instance_name	String	Definition Instance name. Range The name must start with a letter and consist of 4 to 64 characters. Only letters (case-sensitive), digits, hyphens (-), and underscores (_) are allowed.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Request

Querying instances that a template parameter template can be applied to

GET https://{endpoint}/v3/0483b6b16e954cb88930a360d2c4e663/configurations/0c82974e2354466098d7b4b72e55129dpr07/applicable-instances

Example Response

Status code: 200

Success.

{
  "total_count" : 10,
  "instances" : [ {
    "instance_id" : "75e1935142974ca685357dc784626f22in07",
    "instance_name" : "gauss-ff14-hll"
  }, {
    "instance_id" : "cf72c31a689c40b7883c355a0bb5cc1din07",
    "instance_name" : "tst-bbbnew"
  }, {
    "instance_id" : "4a99fbae95df43648281cdd9e269c1c7in07",
    "instance_name" : "gauss-62d8"
  }, {
    "instance_id" : "fb6244dc9b1443b7ad0aae81283d5d28in07",
    "instance_name" : "gauss-test-1"
  }, {
    "instance_id" : "2260da7e105e485ebc9c060c1663d89ain07",
    "instance_name" : "gauss-f4c6-cx"
  }, {
    "instance_id" : "1cf7357f931448f89229de664c114d05in07",
    "instance_name" : "gauss-wry-0710-3"
  }, {
    "instance_id" : "5280b1a667d142378fe28816afb2e4b8in07",
    "instance_name" : "taurus_WAkJSzVy"
  }, {
    "instance_id" : "56c6924923804259a1b15b846c6b4bf1in07",
    "instance_name" : "tck-update3"
  }, {
    "instance_id" : "72a8f4287e04427985087795825fcddain07",
    "instance_name" : "critBack"
  }, {
    "instance_id" : "c5df1dec75ed48ab85fe52c72ba784bbin07",
    "instance_name" : "gauss-f873-cx"
  } ]
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Parameter Template Management