tencent cloud

All product documents
APIs
DocumentationAPIs
DescribeTagsSeq
Last updated: 2024-11-22 10:16:54
DescribeTagsSeq
Last updated: 2024-11-22 10:16:54

1. API Description

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

This API is used to query the created 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 Params. The value used for this API: DescribeTagsSeq.
Version Yes String Common Params. The value used for this API: 2018-08-13.
Region No String Common Params. This parameter is not required for this API.
TagKey No String Tag key, which either exists or does not exist with the tag value. If it does not exist, all tags of the user will be queried
TagValue No String Tag value, which either exists or does not exist with the tag key. If it does not exist, all tags of the user will be queried
Offset No Integer Data offset. Default value: 0. It must be an integer multiple of the Limit parameter
Limit No Integer Number of entries per page. Default value: 15
CreateUin No Integer Creator Uin. If this parameter is blank or left empty, only Uin will be used as a condition for query
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 Number of entries per page
Tags Array of TagWithDelete Tag list
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Querying tags

Input Example

https://tag.intl.tencentcloudapi.com/?Action=DescribeTagsSeq
&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

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
FailedOperation The operation failed.
InvalidParameterValue.OffsetInvalid Offset error.
InvalidParameterValue.UinInvalid Uin parameter is invalid.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support