Use ListResourcesByAdvancedSearch to query resources with SQL - Cloud Config - Alibaba Cloud - Cloud Config

Operation description

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

Note

Each Cloud Config resource type has a property file named after the resource type. For example, the property file of the ACS::ECS::Instance resource type is named ACS_ECS_Instance.properties.json. Property files are located 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.

The following example uses advanced search to obtain all resources in the current account that have the tag key business and tag value online.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

config:ListResourcesByAdvancedSearch

list

*All Resource

*

None

Request parameters

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

Response elements

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

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
404	AccountNotExisted	Your 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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.