Use ListMultiAccountTagKeys to query tag keys across multiple accounts - Resource Management

Queries the tag keys of resources within the management account or a member of your resource directory.

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:SearchMultiAccountResources

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Scope	string	Yes	The search scope. The value of this parameter can be one of the following items: ID of a resource directory: Resources within the management account and all members of the resource directory are searched. You can call the GetResourceDirectory operation to obtain the ID of the resource directory. The ID is indicated by the `ResourceDirectoryId` parameter in the response of the operation. ID of the Root folder: Resources within all members in the Root folder and the subfolders of the Root folder are searched. You can call the GetResourceDirectory operation to obtain the ID of the Root folder. The ID is indicated by the `RootFolderId` parameter in the response of the operation. ID of a folder: Resources within all members in the folder are searched. You can call the ListFoldersForParent operation to obtain the ID of the folder. The ID is indicated by the `FolderId` parameter in the response of the operation. ID of a member: Resources within the member are searched. You can call the ListAccounts operation to obtain the ID of the member. The ID is indicated by the `AccountId` parameter in the response of the operation.	rd-r4****
MaxResults	integer	No	The maximum number of entries to return on each page. Valid values: 1 to 100. Default value: 20.	10
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results. If the total number of entries returned for the current request exceeds the value of the `MaxResults` parameter, the entries are truncated. In this case, you can use the `token` to initiate another request and obtain the remaining entries.	eyJzZWFyY2hBZnRlcnMiOlsiMTAwMTU2Nzk4MTU1OSJd****
TagKey	string	No	The tag key.	test_key
MatchType	string	No	The matching mode. Valid values: Equals: equal match Prefix: match by prefix	Equals

Response elements

Element	Type	Description	Example
	object	The response parameters.
NextToken	string	The pagination token that is used in the next request to retrieve a new page of results.	AAAAARfZmVDe9NvRXloR5+8CK9nNJufMdRA7W1miLC1P****
RequestId	string	The ID of the request.	FA6086F9-6363-51A5-A507-88E3201EBCCB
TagKeys	array	The tag keys.
	string	A tag key.	test_key

Examples

Success response

JSON format

{
  "NextToken": "AAAAARfZmVDe9NvRXloR5+8CK9nNJufMdRA7W1miLC1P****",
  "RequestId": "FA6086F9-6363-51A5-A507-88E3201EBCCB",
  "TagKeys": [
    "test_key"
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	NoPermission	You are not authorized to perform this operation.
400	InvalidParameter.MaxResults	The specified parameter MaxResults is not valid.	The MaxResults parameter is invalid.
400	MultiAccountServiceNotEnabled	Multi account ResourceCenter service is not enabled.
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	NoPermission.ResourceDirectory.MemberAccount	ResourceDirectory Member Account is not authorized to perform this operation.
409	InvalidParameter.Scope	The Scope is invalid.
409	InvalidParameter.MatchType	The specified parameter MatchType is not valid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.