All Products
Search
Document Center

Resource Access Management:ListTagResources

Last Updated:May 08, 2024

Queries the tags that are added resources.

Operation description

You must specify at least one of the following parameters or parameter pairs in a request to determine a query object:

  • ResourceId.N
  • Tag.N.Key
  • Tag.N.Key and Tag.N.Value

Debugging

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

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
ResourcePrincipalNamearrayNo

The name of resource N.

Valid values of N: 1 to 50. If ResourceType is set to user, the resource name is the name of the RAM user.

Note You must specify only one of the following parameters: ResourceId and ResourcePrincipalName.
stringNo

The name of resource N.

Valid values of N: 1 to 50. If ResourceType is set to user, the resource name is the name of the RAM user.

Note You must specify only one of the following parameters: ResourceId and ResourcePrincipalName.
test@example.onaliyun.com
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.

caeba0bbb2be03f84eb48b699f0a4883
PageSizeintegerNo

The number of entries per page. If a response is truncated because it reaches the value of PageSize, the value of IsTruncated will be true. Valid values: 1 to 100. Default value: 100.

2
ResourceTypestringYes

The type of the resource. Valid value:

  • user: a RAM user
user
ResourceIdarrayNo

The ID of resource N.

Valid values of N: 1 to 50. If ResourceType is set to user, the resource ID is the ID of the RAM user.

Note You must specify only one of the following parameters: ResourceId and ResourcePrincipalName.
stringNo

The ID of resource N.

Valid values of N: 1 to 50. If ResourceType is set to user, the resource ID is the ID of the RAM user.

Note You must specify only one of the following parameters: ResourceId and ResourcePrincipalName.
20732900249392****
Tagobject []No

The tag value.

Valid values of N: 1 to 20. N must be consecutive.

KeystringNo

The key of tag N.

Valid values of N: 1 to 20. N must be consecutive.

operator
ValuestringNo

The value of tag N.

Valid values of N: 1 to 20. N must be consecutive.

alice

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

NextTokenstring

The marker. This parameter is returned only if the value of IsTruncated is true. If the parameter is returned, you can call this operation again and set this parameter to obtain the truncated part.

caeba0bbb2be03f84eb48b699f0a****
RequestIdstring

The request ID.

4BE83135-0B08-467C-B3A2-27B312FD0F57
TagResourcesobject []

The tag key.

ResourceTypestring

The type of the resource. Valid values:

  • user: a RAM user
user
TagValuestring

The tag value.

alice
ResourceIdstring

The ID of the resource.

20732900249392****
TagKeystring

The tag key.

operator
IsTruncatedboolean

Indicates whether the response is truncated. Valid values:

  • true
  • false
true

Examples

Sample success responses

JSONformat

{
  "NextToken": "caeba0bbb2be03f84eb48b699f0a****",
  "RequestId": "4BE83135-0B08-467C-B3A2-27B312FD0F57",
  "TagResources": {
    "TagResource": [
      {
        "ResourceType": "user",
        "TagValue": "alice",
        "ResourceId": "20732900249392****",
        "TagKey": "operator"
      }
    ]
  },
  "IsTruncated": true
}

Error codes

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

Change history

Change timeSummary of changesOperation
2023-09-19The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.