Multi-Account Resource Relationship Overview - Resource Management - Alibaba Cloud - Resource Management

Operation description

Before you use a RAM user or RAM role to call this operation, make sure the RAM user or RAM role has the required permissions. For more information, see Grant a RAM user the permissions to use Resource Center.
By default, the operation returns up to 20 entries. You can set 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. To retrieve the remaining entries, call the operation again and set the NextToken parameter to the value of NextToken in the previous response. If you do not set the NextToken parameter, entries on the first page are returned by default.
You can specify one or more filter conditions to narrow the search results. For more information about supported filter parameters and matching methods, see the Supported filter parameters section. Multiple filter conditions are evaluated with logical AND. Only resources that meet all filter conditions are returned. Values within a single filter condition are evaluated with logical OR. Resources that match any value of the filter condition are returned.

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

list

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
Scope	string	Yes	The search scope. Valid values: ID of a resource directory: searches resources within the management account and all members of the resource directory. You can call the GetResourceDirectory operation to query the ID. ID of the Root folder: searches resources within all members in the Root folder and its subfolders. You can call the ListFoldersForParent operation to query the ID. ID of a folder: searches resources within all members in the folder. You can call the ListFoldersForParent operation to query the ID. ID of a member: searches resources within the member. You can call the ListAccounts operation to query the ID.	rd-r4****
RegionId	string	Yes	The region ID of the resource.	cn-hangzhou
ResourceType	string	Yes	The type of the resource.	ACS::ACK::Cluster
ResourceId	string	Yes	The ID of the resource.	m-eb3hji****
RelatedResourceFilter	array<object>	No	The filter conditions for resources associated with the resource.
	object	No	A filter condition for resources associated with the resource.
Key	string	No	The key of the filter condition. For more information, see `Supported filter parameters`.	RelatedResourceRegionId
Value	array	No	The values of the filter condition.
	string	No	A value of the filter condition.	cn-shanghai
MatchType	string	No	The matching method.	Equals
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results.	eyJzZWFyY2hBZnRlcnMiOlsiMTAwMTU2Nzk4MTU1OSJd****
MaxResults	integer	No	The maximum number of entries per page. Valid values: 1 to 500. Default value: 20.	10

Supported filter parameters

Parameter	Description	Supported matching method
RelatedResourceRegionId	The region ID of the associated resource.	Equals
RelatedResourceType	The type of the associated resource.	Equals
RelatedResourceId	The ID of the associated resource.	Equals

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	BCAB07BA-82FA-5DC0-9322-FB7ED726481D
MaxResults	integer	The maximum number of entries per page.	10
NextToken	string	The pagination token used to retrieve the next page of results.	eyJzZWFyY2hBZnRlcnMiOlsiMTAwMTU2Nzk4MTU1OSJd****
Scope	string	The search scope. Valid values: ID of a resource directory: searches resources within the management account and all members of the resource directory. ID of the Root folder: searches resources within all members in the Root folder and its subfolders. ID of a folder: searches resources within all members in the folder. ID of a member: searches resources within the member.	rd-r4****
ResourceRelationships	array<object>	The resource relationships.
	object	A resource relationship.
AccountId	string	The ID of the management account or member.	193396142051****
RegionId	string	The region ID of the resource.	cn-hangzhou
ResourceType	string	The type of the resource.	ACS::ACK::Cluster
ResourceId	string	The ID of the resource.	m-eb3hji****
RelatedResourceRegionId	string	The region ID of the associated resource.	cn-shanghai
RelatedResourceType	string	The type of the associated resource.	ACS::VPC::VPC
RelatedResourceId	string	The ID of the associated resource.	vpc-uf6m5okksddm6c9lh7***

Examples

Success response

JSON format

{
  "RequestId": "BCAB07BA-82FA-5DC0-9322-FB7ED726481D",
  "MaxResults": 10,
  "NextToken": "eyJzZWFyY2hBZnRlcnMiOlsiMTAwMTU2Nzk4MTU1OSJd****",
  "Scope": "rd-r4****\n",
  "ResourceRelationships": [
    {
      "AccountId": "193396142051****",
      "RegionId": "cn-hangzhou",
      "ResourceType": "ACS::ACK::Cluster\n",
      "ResourceId": "m-eb3hji****\n",
      "RelatedResourceRegionId": "cn-shanghai",
      "RelatedResourceType": "ACS::VPC::VPC",
      "RelatedResourceId": "vpc-uf6m5okksddm6c9lh7***"
    }
  ]
}

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.	The Resource Meta Center (RMC) service is not activated.
400	MissingParameter.RelatedResourceFilterValue	You must specify RelatedResourceFilterValue.n.Value.	The RelatedResourceFilterValue.N.Value parameter is not configured.
400	InvalidParameter.RelatedResourceFilterMatchType	The specified parameter RelatedResourceFilterMatchType.n.MatchType is not valid.	The specified parameter RelatedResourceFilterMatchType.n.MatchType is invalid.
400	InvalidParameter.RelatedResourceFilterKey	The specified parameter RelatedResourceFilterMatchType.n.RelatedResourceFilterKey is not valid.	The specified parameter RelatedResourceFilterMatchType.n.RelatedResourceFilterKey is invalid.
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.
404	MissingParameter.RegionId	The specified parameter RegionId is missing.
404	MissingParameter.ResourceType	The specified parameter ResourceType is missing.
404	MissingParameter.ResourceId	The specified parameter ResourceId is missing.
404	ExceedLimit.RelatedResourceFilter	The maximum length of RelatedResourceFilter is exceeded.	The number of objects specified in the RelatedResourceFilter parameter exceeds the upper limit.
409	InvalidParameter.Scope	The Scope 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.ResourceType	The specified parameter ResourceType is not valid.	The ResourceType parameter is invalid.
409	ExceedLimit.RelatedResourceFilterValue	The number of objects specified in the RelatedResourceFilterValue parameter exceeds the upper limit.	The number of parameter RelatedResourceFilterValue exceeds the upper limit.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.