All Products
Search
Document Center

Simple Application Server:ListTagResources

Last Updated:Oct 30, 2024

Queries the tags that are added to simple resources, such as instances, snapshots, disks, images, commands, and firewall rules.

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
swas-open:ListTagResources
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID.

cn-hangzhou
ClientTokenstringNo

The client token that you want to use to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see Ensure idempotence

123e4567-e89b-12d3-a456-426655440000
NextTokenstringNo

The pagination token that is used in the next request to retrieve a new page of results.

AAAAAV3MpHK1AP0pfERHZN5pu6nOc1nj4M9UaAZ/I8db***
ResourceTypestringYes

The resource type. Valid values:

  • instance
  • snapshot
  • customimage
  • command
  • firewallrule
  • disk
instance
ResourceIdarrayNo

The ID of the resource. You can specify up to 50 resource IDs.

stringNo

The resource ID.

s-bw526m1vi6x20c6g****
Tagarray<object>No

The list of tags. You can specify up to 20 tags.

objectNo

The tag that is added to a resource.

KeystringNo

The key of the tag that you want to add to a resource. The tag key can be 1 to 64 characters in length.

TestKey
ValuestringNo

The value of the tag that you want to add to a resource. The tag value can be 1 to 64 characters in length.

TestValue

Response parameters

ParameterTypeDescriptionExample
object

The returned result.

NextTokenstring

A pagination token. It can be used in the next request to retrieve a new page of results. If NextToken is empty, no next page exists.

AAAAAV3MpHK1AP0pfERHZN5pu6nOc1nj4M9UaAZ/I8db***
RequestIdstring

The request ID.

20758A-585D-4A41-A9B2-28DA8F4F534F
TagResourcesarray<object>

A collection of resource IDs and tags. The information includes the resource IDs, resource types, and key-value pairs.

TagResourceobject
ResourceTypestring

The resource type.

ALIYUN::SWAS::INSTANCE
TagValuestring

The tag value.

TestValue
ResourceIdstring

The resource ID.

s-bw526m1vi6x20c6g****
TagKeystring

The tag key.

TestKey

Examples

Sample success responses

JSONformat

{
  "NextToken": "AAAAAV3MpHK1AP0pfERHZN5pu6nOc1nj4M9UaAZ/I8db***",
  "RequestId": "20758A-585D-4A41-A9B2-28DA8F4F534F\t",
  "TagResources": {
    "TagResource": [
      {
        "ResourceType": "ALIYUN::SWAS::INSTANCE",
        "TagValue": "TestValue",
        "ResourceId": "s-bw526m1vi6x20c6g****\n",
        "TagKey": "TestKey"
      }
    ]
  }
}

Error codes

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