tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeTagsOfInstanceIds

Last updated: 2024-11-20 11:13:05

    1. API Description

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

    This API (DescribeTagsOfInstanceIds) is used to query the tag information of a TencentDB instance.

    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: DescribeTagsOfInstanceIds.
    Version Yes String Common Params. The value used for this API: 2017-03-20.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product.
    InstanceIds.N Yes Array of String List of instances.
    Offset No Integer Pagination offset.
    Limit No Integer Number of entries per page.

    3. Output Parameters

    Parameter Name Type Description
    Offset Integer Pagination offset.
    Limit Integer Number of entries per page.
    Rows Array of TagsInfoOfInstance Instance tag 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 Getting the instance tag information

    This example shows you how to get the instance tag information.

    Input Example

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

{
    "Limit": "10",
    "InstanceIds": [
        "cdb-uns231ns"
    ],
    "Offset": "0"
}

    Output Example

    {
    "Response": {
        "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
        "Offset": 0,
        "Limit": 10,
        "Rows": [
            {
                "InstanceId": "cdb-uns231ns",
                "Tags": [
                    {
                        "TagKey": "test",
                        "TagValue": "1231"
                    }
                ]
            }
        ]
    }
}

    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
    AuthFailure CAM signature/authentication error.
    CdbError Backend or process error.
    InternalError.AuthError Authentication failed.
    InternalError.CdbCgwError Internal system error.
    InternalError.CdbError System error.
    InternalError.CosError Failed to obtain file information.
    InternalError.TaskError Task exception
    InternalError.TimeWindowError Time window error
    InternalError.UnknownError Unknown error
    InvalidParameter Parameter error.
    OperationDenied Operation denied.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy