Domain name for API request: tcaplusdb.tencentcloudapi.com.
This API is used to query the table group list.
A maximum of 20 requests can be initiated per second for this API.
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 parameter. The value used for this API: DescribeTableGroups. |
| Version | Yes | String | Common parameter. The value used for this API: 2019-08-23. |
| Region | Yes | String | Common parameter. For more information, please see the list of regions supported by the product. This API only supports: ap-hongkong, ap-seoul, ap-shanghai, ap-singapore, ap-taipei, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley |
| ClusterId | Yes | String | ID of the cluster where a table group resides |
| TableGroupIds.N | No | Array of String | Table group ID list |
| Filters.N | No | Array of Filter | Filter. Valid values: TableGroupName, TableGroupId |
| Offset | No | Integer | Query list offset |
| Limit | No | Integer | Number of returned results in query list |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Number of table groups |
| TableGroups | Array of TableGroupInfo | Table group information list |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
This example shows you how to query the table group list.
https://tcaplus.tencentcloudapi.com/?Action=DescribeTableGroups
&ClusterId=6179109757
&<common request parameters>{
"Response": {
"RequestId": "dbaf73f4-3d1d-4f7b-b3b3-259d53e546be",
"TotalCount": 2,
"TableGroups": [
{
"CreatedTime": "2019-08-30 18:57:02",
"TableGroupId": "1",
"TableCount": 0,
"TotalSize": 0,
"TableGroupName": "tdr test zone 1"
},
{
"CreatedTime": "2019-08-30 18:58:03",
"TableGroupId": "1001",
"TableCount": 0,
"TotalSize": 0,
"TableGroupName": "tdr production zone 1"
}
]
}
}This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
| FailedOperation.RegionMismatch | The requested region does not match. |
| InternalError | Internal error. |
| InvalidParameterValue | Incorrect parameter value. |
| ResourceNotFound | The resource does not exist. |
Was this page helpful?