tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

GetTags

Last updated: 2024-03-20 15:31:09

    1. API Description

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

    This API is used to get the list of created tags.

    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: GetTags.
    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.
    PaginationToken No String The token value of the next page obtained from the response of the previous page.
    Leave it empty for the first request.
    MaxResults No Integer Number of data entries to return per page (up to 1,000).
    Default value: 50.
    TagKeys.N No Array of String Tag key.
    All tags corresponding to the list of tag keys.
    Maximum length: 20
    Category No String Tag type. Valid values: Custom: custom tag; System: system tag; All: all tags. Default value: All.

    3. Output Parameters

    Parameter Name Type Description
    PaginationToken String Token value obtained for the next page
    Tags Array of Tag 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 tag list

    Input Example

    POST / HTTP/1.1
Host: tag.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetTags
<Common request parameters>

{
    "PaginationToken": "Ab9jDQQcwdAXTyU2IUabQzkIKltlrX19nJCB8MIuJD9Ck8*********",
    "MaxResults": "2"
}

    Output Example

    {
    "Response": {
        "PaginationToken": "t1eWpVGSKbAxvaIwRPttZIQq-Eu7e2hWKvN5iMyULmtF*********",
        "Tags": [
            {
                "TagKey": "key1",
                "TagValue": "value1"
            },
            {
                "TagKey": "key2",
                "TagValue": "value2"
            }
        ],
        "RequestId": "0ba573a8-0fdc-44eb-96d7-8f7f*********"
    }
}

    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.
    InvalidParameter Incorrect parameter.
    InvalidParameter.PaginationTokenInvalid The PaginationToken parameter is invalid.
    InvalidParameter.ReservedTagKey System reserved tag keys qcloud, tencent and project cannot be created.
    InvalidParameterValue.TagKeyEmpty Tag key cannot be empty.
    LimitExceeded The quota limit is exceeded.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy