Use ExecuteMultiAccountSQLQuery to Query Cross-Account Resources - Resource Management - Alibaba Cloud - Resource Management

Queries resources across accounts by using SQL.

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

resourcecenter:ExecuteMultiAccountSQLQuery

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Expression	string	Yes	The SQL statement to be executed. The length of the SQL statement to be executed must be less than 2,000 characters. For more information about SQL syntax, see Basic SQL syntax.	SELECT * FROM resources LIMIT 100;
Scope	string	Yes	The account scope for the search. Valid values: Resource directory ID: searches for resources in the management account and all member accounts. Root folder ID: searches for resources in all member accounts under the Root folder and its subfolders. Folder ID: searches for resources in all member accounts under the specified folder. Member ID: searches for resources in the specified member account. Member ID/Resource group ID: searches for resources in the resource group of the specified member account. For more information about how to obtain the resource directory ID, Root folder ID, folder ID, member ID, and resource group ID, see GetResourceDirectory, ListFoldersForParent, ListFoldersForParent, ListAccounts, and ListResourceGroups.	rd-r4****
MaxResults	integer	No	The maximum number of entries per page. Valid values: 1 to 1000. Default value: 1000.	1000
NextToken	string	No	The token used to query the next page of results. If the total number of returned entries exceeds the MaxResults limit, the data is truncated. You can use NextToken to query the next page.	eyJzZWFyY2hBZnRlcnMiOlsiMTAwMTU2Nzk4MTU1OSJd****

Response elements

Element	Type	Description	Example
	object	The response parameters.
Columns	array<object>	The column information.
	object	The column information.
Name	string	The column name.	resource_id
Type	string	The column type.	varchar
MaxResults	integer	The maximum number of entries per page.	1000
NextToken	string	The token used to query the next page of results.	eyJzZWFyY2hBZnRlcnMiOlsiMTAwMTU2Nzk4MTU1OSJd****
RequestId	string	The request ID.	44C8A952-D6B0-5BC8-82D5-93BA02E26F2E
Rows	array	The array of search results.
	any	The result row information.	[ "vsw-xxx“ ]

Examples

Success response

JSON format

{
  "Columns": [
    {
      "Name": "resource_id",
      "Type": "varchar"
    }
  ],
  "MaxResults": 1000,
  "NextToken": "eyJzZWFyY2hBZnRlcnMiOlsiMTAwMTU2Nzk4MTU1OSJd****\n",
  "RequestId": "44C8A952-D6B0-5BC8-82D5-93BA02E26F2E",
  "Rows": [
    "[\n      \"vsw-xxx“\n]"
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	NoPermission	You are not authorized to perform this operation.
403	NoPermission.AccountScope	The operator is not permitted for this account scope.	The operator is not permitted for this account scope.
404	NotExists.ResourceDirectory	The resource directory for the account is not enabled.	No resource directory is enabled for the account.
404	NotExists.ResourceDirectory.FolderId	The specified folder does not exist.	The specified folder does not exist.
409	ExceedLimit.ExecuteTime	The execution time has exceeded the limit. Please check for complex queries or large data volume, and optimize accordingly.
409	SQLExecuteError	Failed to execute the SQL statement.
409	InvalidSearch.SQL	Error: %s
409	InvalidParameter.Scope	The Scope is invalid.
409	ServiceNotEnabled.SpecifiedAccount	ResourceCenter service of the specified account is not enabled.
409	InvalidParameter.NextToken	The specified parameter NextToken is not valid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.