1. API Description
Domain name for API request: tcaplusdb.intl.tencentcloudapi.com.
This API is used to query the details of a table in recycle bin.
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.
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: DescribeTablesInRecycle. |
| 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 |
No |
String |
ID of the cluster where the table to be queried resides |
| TableGroupIds.N |
No |
Array of String |
List of IDs of the table groups where the table to be queried resides |
| Filters.N |
No |
Array of Filter |
Filter. Valid values: TableName, TableInstanceId |
| Offset |
No |
Integer |
Query result offset |
| Limit |
No |
Integer |
Number of returned query results |
3. Output Parameters
| Parameter Name |
Type |
Description |
| TotalCount |
Integer |
Number of tables |
| TableInfos |
Array of TableInfoNew |
Table details result 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 the list of tables in recycle bin
This example shows you how to query the list of tables in the recycle bin.
POST / HTTP/1.1
Host: tcaplusdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTablesInRecycle
<Common request parameters>
{
"TableGroupIds": [
"xx"
],
"ClusterId": "5674209986",
"Limit": 0,
"Filters": [
{
"Name": "xx",
"Value": "xx"
}
],
"Offset": 0
}
Output Example
{
"Response": {
"RequestId": "5d7da70a-2aa6-4e61-9389-46a92770974c",
"TableInfos": [
{
"ApiAccessId": "10",
"ClusterName": "gz test App",
"ClusterId": "5674209986",
"CreatedTime": "2019-08-29 22:03:27",
"Error": null,
"IdlFiles": [
{
"FileContent": null,
"FileExtType": "proto",
"FileId": 551,
"FileName": "tb_example",
"FileSize": 266,
"FileType": "PROTO"
}
],
"IndexStruct": null,
"KeyStruct": null,
"ListElementNum": 1,
"TableGroupId": "101",
"Memo": null,
"ReservedReadQps": 80,
"ReservedVolume": 1,
"ReservedWriteQps": 26,
"ShardingKeySet": "key",
"Status": "RECYCLING",
"TableIdlType": "PROTO",
"TableInstanceId": "tcaplus-1f224454",
"TableName": "tb_example",
"TableSize": 48566336,
"TableType": "GENERIC",
"UpdatedTime": "",
"ValueStruct": null,
"SortFieldNum": null,
"SortRule": null,
"TableGroupName": "test_zone_1"
}
],
"TotalCount": 1
}
}
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.UnauthorizedOperation |
API operation authentication error. |
| FailedOperation |
Operation failed. |
| InternalError |
Internal error. |
| InvalidParameterValue |
Incorrect parameter value. |
| ResourceNotFound |
The resource does not exist. |