Querying Instances that a Parameter Template Can Be Applied To (a V3 API)

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

None

For details, see Calling APIs.

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 Policies 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
ddm:instance:list	Read	parameterGroup *	g:EnterpriseProjectId g:ResourceTag/<tag-key>	ddm:instance:list	-

GET /v3/{project_id}/configurations/{config_id}/query-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 can contain 32 characters. Only letters and digits are supported. Default Value N/A
config_id	Yes	String	Definition Parameter template ID Constraints N/A Range The value can contain 36 characters. Only letters and digits are allowed. Default Value N/A

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Definition Which page the server starts returning items Constraints N/A Range The value is greater than or equal to 0. Default Value 0
limit	No	Integer	Definition Number of records on each page Constraints N/A Range The value is greater than 0 and less than or equal to 128. Default Value 10

None

Querying instances that a parameter template can be applied to

GET https://{endpoint}//v3/a8e2a5e2a6xxxxxxxxxx5af5b9ddabe5/configurations/849c450a43xxxxxxxxxxf33cff5f0717pr09/query-instances

**Table 3** Response body parameters
Parameter	Type	Description
entities	Array of ApplicableInstance objects	Definition Returned information about the list of instances that the parameter template can be applied to. Range N/A
total	Integer	Definition Total number of instances that a parameter template can be applied to. Range N/A

**Table 4** ApplicableInstance
Parameter	Type	Description
instance_id	String	Definition Instance ID, which uniquely identifies an instance Range The value contains 36 characters with a suffix of in09. Only letters and digits are allowed.
instance_name	String	Definition Instance name Range N/A

Normal response example

{
  "entities" : [ {
    "instance_id" : "34694c59f8xxxxxxxxxx35bd53e06d8bin09",
    "instance_name" : "ddm-test"
  } ],
  "total" : 9
}

For details, see Error Codes.

Parent topic: Parameter Management

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.