DescribeTags

Last updated: 2020-07-03 11:00:02

1. API Description

Domain name for API request: tag.tencentcloudapi.com.

This API is used to query existing tag lists.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: DescribeTags.
Version Yes String Common parameter. The value used for this API: 2018-08-13.
Region No String Common parameter. This parameter is not required for this API.
TagKey No String Tag key. Either exists or does not exist alongside the tag value. If it does not exist, all of the user’s tags will be queried.
TagValue No String Tag value. Either exists or does not exist alongside the tag key. If it does not exist, all of the user’s tags will be queried.
Offset No Integer Data offset. The default value is 0. Must be an integral multiple of the Limit parameter.
Limit No Integer Page size. The default value is 0.
CreateUin No Integer Creator Uin. If not specified, Uin is only used as the query condition.
TagKeys.N No Array of String Tag key array, which either exists or does not exist with the tag value. If it does not exist, all tags of the user will be queried. If it is passed in together with TagKey, it will be used and the TagKey will be ignored
ShowProject No Integer Whether to show project tag

3. Output Parameters

Parameter Name Type Description
TotalCount Integer Total number of results.
Offset Integer Data offset.
Limit Integer Page size.
Tags Array of TagWithDelete Tag list.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying tags

Input Example

https://tag.tencentcloudapi.com/?Action=DescribeTags
&TagKey=testTagKey
&TagValue=testTagValue
&<common request parameters>

Output Example

{
  "Response": {
    "TotalCount": 1,
    "Offset": 0,
    "Limit": 15,
    "Tags": [
      {
        "TagKey": "abc",
        "TagValue": "123",
        "CanDelete": 1
      }
    ],
    "RequestId": "0eebf6af-7ae1-44ec-9cae-3752e8bb911a"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InvalidParameterValue.UinInvalid Uin parameter is invalid.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help