All Products
Search
Document Center

Cloud Config:ListResourceRelations

Last Updated:Jun 17, 2024

Queries a list of resources that associate with a specific resource.

Operation description

This topic provides an example on how to query the disks that are associated with an Elastic Compute Service (ECS) instance within the current Alibaba Cloud account.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
config:ListResourceRelationsRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ResourceIdstringYes

The resource ID.

i-j6cajg9yrfoh4sas****
ResourceTypestringYes

The type of the resource.

ACS::ECS::Instance
RegionstringYes

The ID of the region in which the resource resides.

cn-shanghai
NextTokenstringNo

The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextToken.

C2DjqMYSy0is7zSMGf21****
MaxResultsintegerNo

The maximum number of entries to return for a single request. Valid values: 1 to 1000.

10
TargetResourceTypestringNo

The type of the resource that is associated with the object.

ACS::ECS::Disk
TargetResourceIdstringNo

The ID of the resource that is associated with the object.

d-j6c8k731qbrc7fxi****
RelationTypestringNo

The type of the relationship between the resource and the object.

Valid values:

  • IsContained: The object is included as part of the resource.
  • IsAttachedTo: The object is added to the resource.
  • IsAssociatedIn: The object is associated with the resource.
  • Contains: The object contains the resource.
IsAttachedTo

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

6525F8DE-5A8B-5AD3-A241-BBF5A259E5B2
ResourceRelationsobject

The result of the relationship.

ResourceRelationListobject []

An array that contains the relationships.

AccountIdlong

The ID of the Alibaba Cloud account to which the resource belongs.

100931896542****
SourceResourceTypestring

The type of the resource.

ACS::ECS::Instance
SourceResourceRegionIdstring

The ID of the region in which the resource resides.

cn-shanghai
SourceResourceIdstring

The resource ID.

i-j6cajg9yrfoh4sas****
TargetResourceTypestring

The type of the associated resource.

ACS::ECS::Disk
TargetResourceIdstring

The ID of the associated resource.

d-j6c8k731qbrc7fxi****
RelationTypestring

The type of the relationship between the resource and the object.

Valid values:

  • IsContained: The object is included as part of the resource.
  • IsAttachedTo: The object is added to the resource.
  • IsAssociatedIn: The object is associated with the resource.
  • Contains: The object contains the resource.
IsAttachedTo
NextTokenstring

The token that was used to initiate the next request.

C2DjqMYSy0is7zSMGf21****
MaxResultsinteger

The maximum number of entries returned on each page.

10

Examples

Sample success responses

JSONformat

{
  "RequestId": "6525F8DE-5A8B-5AD3-A241-BBF5A259E5B2",
  "ResourceRelations": {
    "ResourceRelationList": [
      {
        "AccountId": 0,
        "SourceResourceType": "ACS::ECS::Instance",
        "SourceResourceRegionId": "cn-shanghai",
        "SourceResourceId": "i-j6cajg9yrfoh4sas****",
        "TargetResourceType": "ACS::ECS::Disk",
        "TargetResourceId": "d-j6c8k731qbrc7fxi****",
        "RelationType": "IsAttachedTo"
      }
    ],
    "NextToken": "C2DjqMYSy0is7zSMGf21****",
    "MaxResults": 10
  }
}

Error codes

HTTP status codeError codeError messageDescription
400NoPermissionYou are not authorized to perform this operation.You are not authorized to perform this operation.
400MemberNotBelongToMasterThe specified member does not belong to your organization.The specified member does not belong to your organization.
404AccountNotExistedYour account does not exist.The specified account does not exist.
503ServiceUnavailableThe request has failed due to a temporary failure of the server.The request has failed due to a temporary failure of the server.

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