DescribeTagKeys - Anti-DDoS - Alibaba Cloud Documentation Center

Queries all tag keys and the number of Anti-DDoS Proxy (Chinese Mainland) instances to which each tag key is added.

Operation description

You can call this operation to query all tag keys and the Anti-DDoS Pro instances to which the tag keys are added by page.

Note The tag feature is suitable only for Anti-DDoS Pro.

Limits

You can call this operation up to 10 times per second per account. If the number of the 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

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

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-ddoscoo:DescribeTagKeys	Read	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the instance. Set the value to cn-hangzhou, which indicates an Anti-DDoS Pro instance in the Chinese mainland.	cn-hangzhou
ResourceGroupId	string	No	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****
ResourceType	string	Yes	The type of the resource to which the tag belongs. Set the value to INSTANCE, which indicates an Anti-DDoS Pro instance.	INSTANCE
PageSize	integer	No	The number of entries to return on each page. Default value: 10.	10
PageNumber	integer	No	The number of the page to return. Default value: 1.	1

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

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	6623EA1F-30FB-5BC8-BEC9-74D55F6F08F1
PageNumber	integer	The page number of the returned page.	1
PageSize	integer	The number of entries returned on each page.	10
TotalCount	integer	The total number of entries returned.	1
TagKeys	object []	An array that consists of the details of the tag key.
TagCount	integer	The number of Anti-DDoS Pro instances to which the tag key is added.	2
TagKey	string	The tag key.	aa1

Examples

Sample success responses

JSONformat

{
  "RequestId": "6623EA1F-30FB-5BC8-BEC9-74D55F6F08F1",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 1,
  "TagKeys": [
    {
      "TagCount": 2,
      "TagKey": "aa1"
    }
  ]
}

Error codes

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