Domain name for API request: tcaplusdb.tencentcloudapi.com.
This API is used to query table details.
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 Params. The value used for this API: DescribeTables. |
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 |
SelectedTables.N | No | Array of SelectedTableInfoNew | Information list of tables to be queried. If you need to filter the tables, use theFilter parameter. |
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 |
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. |
This example shows you how to query the table list.
https://tcaplusdb.tencentcloudapi.com/?Action=DescribeTables
&ClusterId=5674209986
&<Common request parameters>
{
"Response": {
"TotalCount": 1,
"TableInfos": [
{
"TableName": "abc",
"TableInstanceId": "abc",
"TableType": "abc",
"TableIdlType": "abc",
"ClusterId": "abc",
"ClusterName": "abc",
"TableGroupId": "abc",
"TableGroupName": "abc",
"KeyStruct": "abc",
"ValueStruct": "abc",
"ShardingKeySet": "abc",
"IndexStruct": "abc",
"ListElementNum": 1,
"IdlFiles": [
{
"FileName": "abc",
"FileType": "abc",
"FileExtType": "abc",
"FileSize": 0,
"FileId": 0,
"FileContent": "abc"
}
],
"ReservedVolume": 0,
"ReservedReadQps": 0,
"ReservedWriteQps": 0,
"TableSize": 0,
"Status": "abc",
"CreatedTime": "abc",
"UpdatedTime": "abc",
"Memo": "abc",
"Error": {
"Code": "abc",
"Message": "abc"
},
"ApiAccessId": "abc",
"SortFieldNum": 0,
"SortRule": 0,
"DbClusterInfoStruct": "abc",
"TxhBackupExpireDay": 1,
"SyncTableInfo": {
"TargetTableSplitNum": 1,
"TargetTableNamePrefix": [
"abc"
],
"TargetSyncDBInstanceId": "abc",
"TargetDatabaseName": "abc",
"Status": 0,
"ClusterId": "abc",
"TableGroupId": 1,
"TableName": "abc",
"TableId": "abc",
"KeyFieldMapping": [
{
"SourceName": "abc",
"TargetName": "abc"
}
],
"ValueFieldMapping": [
{
"SourceName": "abc",
"TargetName": "abc"
}
]
}
}
],
"RequestId": "abc"
}
}
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?