Executes an SQL statement to query the resources that can be accessed within the current account.
Debugging
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:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis 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 |
|---|---|---|---|---|
| resourcecenter:ExecuteSQLQuery | none | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| Expression | string | Yes | The SQL statement to be executed. The number of characters in the SQL statement must be less than 2,000. For more information about the SQL syntax, see Basic SQL syntax. | SELECT * FROM resources LIMIT 100; |
| Scope | string | No | The search scope. Set this parameter to the ID of a resource group. For information about how to obtain the ID of a resource group, see ListResourceGroups . | rg-acfmzawhxxc**** |
| MaxResults | integer | No | The number of entries per page.
| 1000 |
| NextToken | string | No | The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextToken. | eyJzZWFyY2hBZnRlcnMiOlsiMTAwMTU2Nzk4MTU1OSJd**** |
Response parameters
Examples
Sample success responses
JSONformat
{
"Columns": [
{
"Name": "resource_id",
"Type": "varchar"
}
],
"MaxResults": 1000,
"NextToken": "eyJzZWFyY2hBZnRlcnMiOlsiMTAwMTU2Nzk4MTU1OSJd****\n",
"RequestId": "D696E6EF-3A6D-5770-801E-4982081FE4D0",
"Rows": [
[
"vsw-xxx"
]
]
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 409 | ExceedLimit.ExecuteTime | The execution time has exceeded the limit. Please check for complex queries or large data volume, and optimize accordingly. | The time consumed for the query exceeds the limit. Check and optimize the complexity of or data size in the SQL statement. |
| 409 | SQLExecuteError | Failed to execute the SQL statement. | Failed to perform the query. Check whether the query statement is correct. |
| 409 | InvalidSearch.SQL | Error: %s | Error:%s |
| 409 | InvalidParameter.Scope | The Scope is invalid. | The Scope parameter is invalid |
| 409 | LengthExceedLimit.Expression | The length of parameter Expression exceed limit. | The length of the query expression exceeds the limit. |
| 409 | InvalidParameter.NextToken | The specified parameter NextToken is not valid. | The specified parameter NextToken is not valid. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|