tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeTags

Last updated: 2024-08-27 11:43:49

    1. API Description

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

    This API is used to obtain all host 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: DescribeTags.
    Version Yes String Common Params. The value used for this API: 2018-02-28.
    Region No String Common Params. This parameter is not required.
    MachineType No String CVM type
  • CVM: indicates Cloud Virtual Machine
  • BM: indicates Blackstone Physical Machine
  • ECM: indicates Edge Computing Server
  • LH: indicates Tencent Cloud Lighthouse
  • Other: indicates hybrid CVMs
    		•
    MachineRegion No String Region where the machine is located, such as ap-guangzhou.
    Filters.N No Array of Filters Filter criteria
  • Keywords - String - required: no - query by keywords (machine name/machine IP)
  • Status - String - required: no - client online status (OFFLINE: offline | ONLINE: online | UNINSTALLED: uninstalled | SHUTDOWN: shut down)
  • Version - String - required: no - current protection version (PRO_VERSION: Professional edition | BASIC_VERSION: Basic edition)
  • Risk - String - required: no - risky host (yes)
  • Os - String - required: no - operating system (DescribeMachineOsList API value)

    • Each filtering criterion supports only one value; queries of multiple values with OR relationship are not supported.

    3. Output Parameters

    Parameter Name Type Description
    List Array of Tag List information
    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 Obtaining All Host Tags

    This example shows you how to obtain all host tags.

    Input Example

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

{}

    Output Example

    {
    "Response": {
        "List": [
            {
                "Id": 2,
                "Name": "Tag Name",
                "Count": 123
            }
        ],
        "RequestId": "b12a5e5a-9393-453f-a4d9-b42de0b2bcec"
    }
}

    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 Operation failed.
    InternalError Internal error
    InvalidParameter Incorrect parameter.
    InvalidParameter.InvalidFormat Incorrect parameter format.
    InvalidParameter.MissingParameter Missing parameter.
    InvalidParameter.ParsingError Incorrect parameter parsing.
    InvalidParameterValue Invalid parameter value.
    MissingParameter Missing parameter error.
    ResourceNotFound The resource does not exist.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy