ListResourceRelationships API Overview - Resource Management - Alibaba Cloud - Resource Management

Operation description

Only resource relationships that the current account has permissions to access are returned.
By default, up to 20 entries are returned. Use the MaxResults parameter to specify a different maximum.
If the response does not contain NextToken, all entries are returned. Otherwise, set NextToken in the next request to the value from the previous response to retrieve additional entries. If NextToken is not specified, the first page is returned by default.
Specify one or more filter conditions to narrow results. For supported filter parameters and matching methods, see the Supported filter parameters section. Multiple filter conditions use logical AND — only entries meeting all conditions are returned. Values within a single filter use logical OR — entries matching any value 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:ListResourceRelationships

list

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
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.	cb-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.	682A3004-38E3-5122-9A11-CCDFAB9C3C4F
MaxResults	integer	The maximum number of entries per page.	10
NextToken	string	A pagination token. It can be used in the next request to retrieve a new page of results.	eyJzZWFyY2hBZnRlcnMiOlsiMTAwMTU2Nzk4MTU1OSJd****
ResourceRelationships	array<object>	The resource relationships.
	object	A resource relationship.
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": "682A3004-38E3-5122-9A11-CCDFAB9C3C4F",
  "MaxResults": 10,
  "NextToken": "eyJzZWFyY2hBZnRlcnMiOlsiMTAwMTU2Nzk4MTU1OSJd****",
  "ResourceRelationships": [
    {
      "RegionId": "cn-hangzhou",
      "ResourceType": "ACS::ACK::Cluster",
      "ResourceId": "m-eb3hji****",
      "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	InvalidParameter.RelatedResourceFilterMatchType	The specified parameter RelatedResourceFilterMatchType.n.MatchType is not valid.	The specified parameter RelatedResourceFilterMatchType.n.MatchType is invalid.
400	MissingParameter.RelatedResourceFilterValue	You must specify RelatedResourceFilterValue.n.Value.	The RelatedResourceFilterValue.N.Value parameter is not configured.
400	InvalidParameter.RelatedResourceFilterKey	The specified parameter RelatedResourceFilterMatchType.n.RelatedResourceFilterKey is not valid.	The specified parameter RelatedResourceFilterMatchType.n.RelatedResourceFilterKey is invalid.
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.ResourceType	The specified parameter ResourceType is not valid.
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.