All Products
Search
Document Center

Resource Management:ListTagResources

Last Updated:Nov 28, 2024

Queries the tags that are added to resource shares.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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
resourcesharing:ListTagResourceslist
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ResourceTypestringYes

The resource type.

Set the value to ResourceShare.

ResourceShare
ResourceIdarrayNo

The ID of the resource share.

You can specify up to 20 resource shares.

stringNo

The ID of the resource share.

rs-PqysnzIj****
RegionIdstringYes

The region ID of the resource shares.

cn-hangzhou
Tagarray<object>No

The tags.

This parameter specifies a filter condition for the query. You can specify up to 20 tags.

objectNo

The tags.

KeystringNo

The tag key.

Note The tag key cannot be an empty string. The tag key can be up to 128 characters in length and cannot start with acs: or aliyun. The tag key cannot contain http:// or https://.
k1
ValuestringNo

The tag value.

Note The tag value can be up to 128 characters in length and cannot start with acs:. The tag value cannot contain http:// or https://.
v1
NextTokenstringNo

The token that is used to initiate the next request if the response of the current request is truncated. You can use the token to initiate another request and obtain the remaining records.

caeba0bbb2be03f84eb48b699f0a****

Response parameters

ParameterTypeDescriptionExample
object

The returned result.

NextTokenstring

The token that is used to initiate the next request if the response of the current request is truncated. You can use the token to initiate another request and obtain the remaining records.

caeba0bbb2be03f84eb48b699f0a****
RequestIdstring

The request ID.

8054B059-6B36-53BF-AA45-B8C9A0ED05AB
TagResourcesarray<object>

The tags.

TagResourceobject

The tags.

ResourceIdstring

The ID of the resource share.

rs-PqysnzIj****
ResourceTypestring

The resource type.

The value can be only ResourceShare.

ResourceShare
TagKeystring

The tag key.

k1
TagValuestring

The tag value.

v1

Examples

Sample success responses

JSONformat

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
  "RequestId": "8054B059-6B36-53BF-AA45-B8C9A0ED05AB",
  "TagResources": {
    "TagResource": [
      {
        "ResourceId": "rs-PqysnzIj****",
        "ResourceType": "ResourceShare",
        "TagKey": "k1",
        "TagValue": "v1"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidParameter.NextTokenThe NextToken is invalid.The NextToken parameter is invalid.
400MissingParameter.ResourceIdOrTagYou must specify ResourceId or Tag.You must specify ResourceId or Tag.
400InvalidParameter.ResourceTypeThe ResourceType parameter is invalid.The ResourceType parameter is invalid.
400MissingParameter.ResourceTypeYou must specify ResourceType.The resource type parameter cannot be empty.
400MissingParameter.TagKeyYou must specify TagKey.You must specify TagKey.
400NumberExceed.ResourceIdsThe maximum number of ResourceIds is exceeded.The maximum number of ResourceIds is exceeded.
400NumberExceed.TagsThe maximum number of Tags is exceeded.The maximum number of Tags is exceeded.
400Duplicate.TagKeyThe TagKey contains duplicate keys.The TagKey contains duplicate keys.
403NoPermissionYou are not authorized to perform this action.You are not authorized to perform this action.
500InternalErrorThe request processing has failed due to some unknown error.The request processing has failed due to some unknown error.

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