SearchMultiAccountResources - - Alibaba Cloud Documentation Center

Searches for resources within the management account or members of a resource directory.

Operation description

You can use this operation to search for only resources whose types are supported by Resource Center in services that work with Resource Center. For more information about the services and the resource types that are supported by Resource Center, see Services that work with Resource Center.
Before you use a RAM user or a RAM role to call the operation, you must make sure that the RAM user or RAM role is granted the required permissions. For more information, see Grant a RAM user the permissions to use Resource Center.
By default, the operation returns a maximum of 20 entries. You can configure the MaxResults parameter to specify the maximum number of entries to return.
If the response does not contain the NextToken parameter, all entries are returned. Otherwise, more entries exist. If you want to obtain the entries, you can call the operation again to initiate another query request. In the request, set the NextToken parameter to the value of NextToken in the last response of the operation. If you do not configure the NextToken parameter, entries on the first page are returned by default.
You can specify one or more filter conditions to narrow the search scope. For more information about supported filter parameters and matching methods, see the Supported filter parameters section. Multiple filter conditions have logical AND relations. Only resources that meet all filter conditions are returned. The values of a filter condition have logical OR relations. Resources that meet any value of the filter condition are returned.
You can visit Sample Code Center to view more sample queries.

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
resourcecenter:SearchMultiAccountResources	Read	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
Scope	string	Yes	The search scope. You can set the value to 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. 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 ListFoldersForParent operation to obtain the ID. ID of a folder: Resources within all members in the folder are searched. You can call the ListFoldersForParent operation to obtain the ID. ID of a member: Resources within the member are searched. You can call the ListAccounts operation to obtain the ID.	rd-r4****
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****
MaxResults	integer	No	The maximum number of entries to return on each page. Valid values: 1 to 100. Default value: 20.	10
Filter	object []	No	The filter conditions.
Key	string	No	The key of the filter condition. For more information, see `Supported filter parameters`.	ResourceGroupId
Value	array	No	The values of the filter condition.
	string	No	A value of the filter condition.	rg-aekzmrjn4ns****
MatchType	string	No	The matching mode. The value Equals indicates an equal match.	Equals
SortCriterion	object	No	The method that is used to sort the entries returned.
Key	string	No	The attribute based on which the entries are sorted. The value CreateTime indicates the creation time of resources.	CreateTime
Order	string	No	The order in which the entries are sorted. Valid values: ASC: The entries are sorted in ascending order. This value is the default value. DESC: The entries are sorted in descending order.	ASC

Supported filter parameters

Parameter	Description	Supported matching mode
ResourceType	The resource type.	Equals
RegionId	The region ID.	Equals
ResourceId	The resource ID.	Equals and Prefix
ResourceGroupId	The resource group ID.	Equals, Exists, and NotExists
ResourceName	The resource name.	Equals and Contains
Tag	The key-value pair of the tag. The key-value pair must be in the `{ "key": $key, "value": $value }` JSON format. You must specify at least one of key and value. For example, if you want to query the tag key `foo` and tag value `bar`, set this parameter to `{ "key": "foo", "value": "bar" }`. If you want to query only the tag key `foo`, set this parameter to `{ "key": "foo" }`.	Contains, NotContains, and NotExists
VpcId	The ID of the virtual private cloud (VPC).	Equals
VSwitchId	The ID of the vSwitch.	Equals

Response parameters

Parameter	Type	Description	Example
	object	The returned result.
RequestId	string	The ID of the request.	EFA806B9-7F36-55AB-8B7A-D680C2C5EE57
NextToken	string	The pagination token that is used in the next request to retrieve a new page of results.	The pagination token that is used in the next request to retrieve a new page of results.
Scope	string	The search scope. ID of a resource directory: Resources within the management account and all members of the resource directory are searched. ID of the Root folder: Resources within all members in the Root folder and the subfolders of the Root folder are searched. ID of a folder: Resources within all members in the folder are searched. ID of a member: Resources within the member are searched.	rd-r4****
MaxResults	integer	The maximum number of entries returned per page.	10
Filters	object []	The filter conditions.
Key	string	The key of the filter condition.	RegionId
MatchType	string	The matching mode.	Equals
Values	array	The values of the filter condition.
	string	A value of the filter condition.	cn-hangzhou
Resources	object []	The information about the resources.
ResourceType	string	The resource type.	ACS::VPC::RouteTable
CreateTime	string	The time when the resource was created. Note Whether this parameter is returned is determined by the Alibaba Cloud service to which the resource belongs.	2021-06-30T09:20:08Z
ResourceGroupId	string	The resource group ID.	rg-acfmzawhxxc****
ZoneId	string	The zone ID. Note Whether this parameter is returned is determined by the Alibaba Cloud service to which the resource belongs.	cn-hangzhou-k
AccountId	string	The ID of the management account or member of the resource directory.	151266687691****
ResourceId	string	The resource ID.	vtb-bp11lbh452fr8940s****
ResourceName	string	The resource name.	group1
RegionId	string	The region ID.	cn-hangzhou
Tags	object []	The tags.
Key	string	The key of tag N.	test_key
Value	string	The value of tag N.	test_value
IpAddresses	array	The IP addresses. Note Whether this parameter is returned is determined by the Alibaba Cloud service to which the resource belongs.
	string	The IP address. Note Whether this parameter is returned is determined by the Alibaba Cloud service to which the resource belongs.	192.168.1.2
IpAddressAttributes	object []	The attributes of the IP address.
IpAddress	array	The IP address.
	string	The IP address.	172.19.xxx.xxx
NetworkType	string	The network type. Valid values: Public: the Internet Private: internal network	Public
Version	string	The version.	Ipv4
ExpireTime	string	The time when the resource expires.	2023-06-14T14:35:45Z

Examples

Sample success responses

JSONformat

{
  "RequestId": "EFA806B9-7F36-55AB-8B7A-D680C2C5EE57",
  "NextToken": "The pagination token that is used in the next request to retrieve a new page of results.\n",
  "Scope": "rd-r4****\n",
  "MaxResults": 10,
  "Filters": [
    {
      "Key": "RegionId",
      "MatchType": "Equals",
      "Values": [
        "cn-hangzhou"
      ]
    }
  ],
  "Resources": [
    {
      "ResourceType": "ACS::VPC::RouteTable",
      "CreateTime": "2021-06-30T09:20:08Z",
      "ResourceGroupId": "rg-acfmzawhxxc****\t\n",
      "ZoneId": "cn-hangzhou-k",
      "AccountId": "151266687691****",
      "ResourceId": "vtb-bp11lbh452fr8940s****",
      "ResourceName": "group1",
      "RegionId": "cn-hangzhou",
      "Tags": [
        {
          "Key": "test_key",
          "Value": "test_value"
        }
      ],
      "IpAddresses": [
        "192.168.1.2"
      ],
      "IpAddressAttributes": [
        {
          "IpAddress": [
            "172.19.xxx.xxx"
          ],
          "NetworkType": "Public",
          "Version": "Ipv4"
        }
      ],
      "ExpireTime": "2023-06-14T14:35:45Z"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	NoPermission	You are not authorized to perform this operation.	You are not authorized to perform the 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.	The Resource Meta Center (RMC) service is not activated.
404	NotExists.Resource	The specified resource does not exist.	The specified resource does not exist.
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	InvalidParameter.Scope	The Scope is invalid.	The Scope parameter is invalid
409	NoPermission.ResourceDirectory.MemberAccount	ResourceDirectory Member Account is not authorized to perform this operation.	You are not allowed to use a member of a resource directory to perform this operation. Use the management account of the resource directory to perform the operation.
409	InvalidParameter.SortCriterion.Key	The specified parameter SortCriterion.Key is not valid.	The SortCriterion.Key parameter is invalid.
409	ExceedLimit.Filter	The maximum length of Filters is exceeded.	The number of objects specified in the Filter parameter exceeds the upper limit.
409	ServiceNotEnabled.SpecifiedAccount	ResourceCenter service of the specified account is not enabled.	The Resource Center service is not activated for the specified account.

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

Change history

Change time

Summary of changes

Operation

2023-11-21

The Error code has changed. The response structure of the API has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 400
	delete Error Codes: 404
	delete Error Codes: 409
Output Parameters	The response structure of the API has changed.

2023-11-10

The Error code has changed. The response structure of the API has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 400
	delete Error Codes: 404
	delete Error Codes: 409
Output Parameters	The response structure of the API has changed.

2023-05-05

The Error code has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	Error Codes 400 change
	delete Error Codes: 404
	delete Error Codes: 409

2023-03-30

The Error code has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 400
	delete Error Codes: 404
	delete Error Codes: 409

2023-03-07

The Error code has changed

see changesets

Change item	Change content
Error Codes	The Error code has changed.
	delete Error Codes: 400
	delete Error Codes: 404
	delete Error Codes: 409