All Products
Search
Document Center

Anti-DDoS:DescribeTagResources

Last Updated:Oct 23, 2024

Queries the information about the tags that are added to an Anti-DDoS Proxy (Chinese Mainland) instance.

Operation description

You can call the DescribeTagResources operation to query the information about the tags that are added to an Anti-DDoS Proxy (Chinese Mainland) instance.

Note Only Anti-DDoS Proxy (Chinese Mainland) supports tags.

QPS limits

You can call this operation up to 10 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.

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
yundun-ddoscoo:DescribeTagResourcesget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the instance. Set the value to cn-hangzhou, which indicates an Anti-DDoS Proxy (Chinese Mainland) instance.

cn-hangzhou
ResourceGroupIdstringNo

The ID of the resource group to which the instance belongs in Resource Management.

If you do not configure this parameter, the instance belongs to the default resource group.

rg-acfm2pz25js****
ResourceTypestringYes

The type of the resource to which the tag belongs. Set the value to INSTANCE, which indicates an Anti-DDoS Pro instance.

INSTANCE
NextTokenstringNo

The query token. Set the value to the value of NextToken that is returned in the last call.

Note You do not need to configure this parameter if you call this operation for the first time.
RGuYpqDdKhzXb8C3.D1BwQgc1tMBsoxdGiEKHHUUCf****
ResourceIdsarrayNo

The IDs of the Anti-DDoS Proxy (Chinese Mainland) instances that you want to query.

stringNo

The ID of the Anti-DDoS Proxy (Chinese Mainland) instance that you want to query.

Note
  • You must specify at least one of the ResourceIds.N and Tags.N.Key parameters.

  • You can call the DescribeInstanceIds operation to query the IDs of instances.

ddoscoo-cn-zz121ogz****
Tagsarray<object>No

An array consisting of tags that you want to query. Each tag consists of a tag key and a tag value.

objectNo
KeystringNo

The key of the tag that you want to query.

Note
  • You must specify at least one of the ResourceIds.N and Tags.N.Key parameters.

  • You can call the DescribeTagKeys operation to query all tag keys.

testkey
ValuestringNo

The value of the tag that you want to query.

testvalue

All Alibaba Cloud API operations must include common request parameters. For more information about common request parameters, see Common parameters.

For more information about sample requests, see the "Examples" section of this topic.

Response parameters

ParameterTypeDescriptionExample
object
NextTokenstring

The query token that is returned in this call.

RGuYpqDdKhzXb8C3.D1BwQgc1tMBsoxdGiEKHHUUCf****
RequestIdstring

The ID of the request.

36E698F7-48A4-48D0-9554-0BB4BAAB99B3
TagResourcesarray<object>

The tags that are added to the Anti-DDoS Proxy (Chinese Mainland) instance.

TagResourceobject
TagValuestring

The value of the tag that is added to the Anti-DDoS Proxy (Chinese Mainland) instance.

testkey
ResourceTypestring

The resource type. The value is fixed as INSTANCE, which indicates an Anti-DDoS Proxy instance.

INSTANCE
ResourceIdstring

The ID of the Anti-DDoS Proxy (Chinese Mainland) instance.

ddoscoo-cn-zz121ogz****
TagKeystring

The key of the tag that is added to the Anti-DDoS Proxy (Chinese Mainland) instance.

testvalue

Examples

Sample success responses

JSONformat

{
  "NextToken": "RGuYpqDdKhzXb8C3.D1BwQgc1tMBsoxdGiEKHHUUCf****",
  "RequestId": "36E698F7-48A4-48D0-9554-0BB4BAAB99B3",
  "TagResources": {
    "TagResource": [
      {
        "TagValue": "testkey",
        "ResourceType": "INSTANCE",
        "ResourceId": "ddoscoo-cn-zz121ogz****",
        "TagKey": "testvalue"
      }
    ]
  }
}

Error codes

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