ListResourcesByAdvancedSearch - Cloud Config - Alibaba Cloud Documentation Center

Obtains resources based on the fields in the resource properties by using a SELECT statement.

Operation description

When you write a SELECT statement, you must obtain the fields and the data types of the fields from the property file of the resource type. For more information about property files, see Alibaba Cloud Config Resource Schema.

Note

Each resource type supported by Cloud Config has a property file. Property files are named based on the related resource types. For example, the property file of the ACS::ECS::Instance resource type is named ACS_ECS_Instance.properties.json. Property files of different resource types are placed under the config/properties/resource-types path.
For more information about the examples and limits on SQL query statements, see Examples of SQL query statements and Limits on SQL query statements.

This topic provides an example on how to obtain all resources whose tag key is business and whose tag value is online within the current account by using the advanced search feature.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
config:ListResourcesByAdvancedSearch	list	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
Sql	string	Yes	The SQL query statement.	SELECT ResourceId, ResourceName WHERE Tags.Kvpair='business:online'

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	D241DEBF-67A2-56AF-88CF-57BF78F0A850
QueryResults	object	The query result.
QueryResultList	object	The queried resources. A maximum of 1,000 data records can be returned. To view more data, use the download URL of the resource file.
Columns	array	The field names.
	string	The field name.	ResourceId
Values	array	The resource data.
	any	The resource data.	["eni-2ze5lq7xaluy5kb5****", "test-resource"]

Examples

Sample success responses

JSONformat

{
  "RequestId": "D241DEBF-67A2-56AF-88CF-57BF78F0A850",
  "QueryResults": {
    "QueryResultList": {
      "Columns": [
        "ResourceId"
      ],
      "Values": [
        "[\"eni-2ze5lq7xaluy5kb5****\", \"test-resource\"]"
      ]
    }
  }
}

Error codes

HTTP status code	Error code	Error message	Description
404	AccountNotExisted	Your account does not exist.	The specified account does not exist.
503	ServiceUnavailable	The request has failed due to a temporary failure of the server.	The request has failed due to a temporary failure of the server.

For a list of error codes, visit the Service error codes.