All Products
Search
Document Center

Global Accelerator:ListTagResources

Last Updated:Jul 31, 2024

Queries the tags that are added to Global Accelerator (GA) resources.

Operation description

  • You must specify ResourceId or Tag in the request to specify the object that you want to query.********
  • Tag is a resource tag that consists of a key-value pair (Key and Value). If you specify only Key, all tag values that are associated with the specified tag key are returned. If you specify only Value, an error message is returned.
  • If you specify Tag and ResourceId to filter tags, ResourceId must match all specified key-value pairs.
  • If you specify multiple key-value pairs, resources that contain the key-value pairs are returned.

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
ga:ListTagResourceslist
  • Accelerator
    acs:ga:{#regionId}:{#accountId}:ga/*
  • Acl
    acs:ga:{#regionId}:{#accountId}:acl/*
  • BandwidthPackage
    acs:ga:{#regionId}:{#accountId}:bandwidthpackage/*
  • BasicAccelerator
    acs:ga:{#regionId}:{#accountId}:ga/*
  • EndpointGroup
    acs:ga:{#regionId}:{#accountId}:endpointgroup/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region where the GA instance is deployed. Set the value to cn-hangzhou.

cn-hangzhou
ClientTokenstringNo

The client token that is used 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.

Note If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request.
123e4567-e89b-12d3-a456-426655440000
NextTokenstringNo

The token that determines the start point of the next query. Valid values:

  • If this is your first query and no next queries are to be sent, ignore this parameter.
  • If a subsequent query is to be sent, set the parameter to the value of NextToken that is returned from the last call.
FFmyTO70tTpLG6I3FmYAXGKPd****
ResourceTypestringYes

The type of the resource whose tag information you want to query. Valid values:

  • accelerator: a standard GA instance
  • basicaccelerator: a basic GA instance
  • bandwidthpackage: a bandwidth plan
  • acl: an access control list (ACL).
  • endpointgroup: an endpoint group
accelerator
ResourceIdarrayNo

The IDs of the resources whose tag information you want to query.

  • If you set ResourceType to accelerator, set the value of ResourceId to the ID of a standard GA instance.
  • If you set ResourceType to basicaccelerator, set the value of ResourceId to the ID of a basic GA instance.
  • If you set ResourceType to bandwidthpackage, set the value of ResourceId to the ID of a bandwidth plan.
  • If you set ResourceType to acl, set the value of ResourceId to the ID of an ACL.
  • If you set ResourceType to endpointgroup, set the value of ResourceId to the ID of an endpoint group.

You can specify up to 50 GA resource IDs.

stringNo

The ID of the resource whose tag information you want to query.

  • If you set ResourceType to accelerator, set the value of ResourceId to the ID of a standard GA instance.
  • If you set ResourceType to basicaccelerator, set the value of ResourceId to the ID of a basic GA instance.
  • If you set ResourceType to bandwidthpackage, set the value of ResourceId to the ID of a bandwidth plan.
  • If you set ResourceType to acl, set the value of ResourceId to the ID of an ACL.
  • If you set ResourceType to endpointgroup, set the value of ResourceId to the ID of an endpoint group.

You can specify up to 50 GA resource IDs.

ga-bp149u6o36qt1as9b****
Tagarray<object>No

An array of tags of GA resources.

You can specify up to 20 tags.

objectNo

The tags of GA resources.

You can specify up to 20 tags.

KeystringNo

The tag key of the GA resource. The tag key cannot be an empty string.

The tag key can be up to 64 characters in length and cannot contain http:// or https://. It cannot start with aliyun or acs:.

You can specify up to 20 tag keys.

KeyTest
ValuestringNo

The tag value of the GA resource. The tag value can be an empty string.

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

You can specify up to 20 tag values.

valueTest

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The ID of the request.

54B48E3D-DF70-471B-AA93-08E683A1B45
TotalCountinteger

The number of entries returned.

1
NextTokenstring

The token that determines the start point of the next query. Valid values:

  • If NextToken is empty, it indicates that no subsequent query is to be sent.
  • If a value is returned for NextToken, the value is the token that determines the start point of the next query.
FFmyTO70tTpLG6I3FmYAXGKPd****
TagResourcesarray<object>

The information about the resources to which tags are added.

object

The information about the resources to which tags are added.

ResourceTypestring

The type of the resource.

  • accelerator: a standard GA instance
  • basicaccelerator: a basic GA instance
  • bandwidthpackage: a bandwidth plan
  • acl: an ACL
  • endpointgroup: an endpoint group
accelerator
TagValuestring

The tag value.

KeyTest
ResourceIdstring

The ID of the resource.

ga-bp149u6o36qt1as9b****
TagKeystring

The tag key.

valueTest

Examples

Sample success responses

JSONformat

{
  "RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45",
  "TotalCount": 1,
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "TagResources": {
    "TagResource": [
      {
        "ResourceType": "accelerator",
        "TagValue": "KeyTest",
        "ResourceId": "ga-bp149u6o36qt1as9b****",
        "TagKey": "valueTest"
      }
    ]
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history