tencent cloud



Last updated: 2022-09-16 15:39:01

1. API Description

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

This API is used to get the associated tag list of a table group.

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: DescribeTableGroupTags.
Version Yes String Common Params. The value used for this API: 2019-08-23.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
ClusterId Yes String The ID of the cluster where table group tags need to be queried
TableGroupIds.N Yes Array of String The list of IDs of the table groups whose tags need to be queried

3. Output Parameters

Parameter Name Type Description
Rows Array of TagsInfoOfTableGroup The information list of table group tags
TotalCount Integer The number of returned results
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Getting the associated tag list of a table group

This example shows you how to get the associated tag list of a table group.

Input Example

Host: tcaplusdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTableGroupTags
<Common request parameters>

    "ClusterId": "5674209986",
    "TableGroupIds": [

Output Example

    "Response": {
        "RequestId": "abd7111a-62d4-4bbb-a781-3646040e9530",
        "TotalCount": 1,
        "Rows": [
                "ClusterId": "5674209986",
                "TableGroupId": "1",
                "Tags": {
                    "TagKey": "test1",
                    "TagValue": "value1"

5. Developer Resources


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.UnauthorizedOperation API operation authentication error.
FailedOperation Operation failed.
InternalError Internal error.
InvalidParameterValue Incorrect parameter value.
ResourceNotFound The resource does not exist.
Contact Us

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

Technical Support

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

7x24 Phone Support