Domain name for API request: dlc.tencentcloudapi.com.
This API is used to obtain the table.
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: DescribeDLCTable. |
Version | Yes | String | Common Params. The value used for this API: 2021-01-25. |
Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
DbName | No | String | Database name |
Name | No | String | Data table name |
Catalog | No | String | Catalog name |
Keyword | No | String | Keyword |
Pattern | No | String | Match rules |
Type | No | String | Table type |
Parameter Name | Type | Description |
---|---|---|
DLCTable | DLCTable | Data table information object Note: This field may return null, indicating that no valid values can be obtained. |
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. |
POST / HTTP/1.1
Host: dlc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDMSTable
<Common request parameters>
{
"DbName": "api_test",
"Catalog": "",
"Name": "test",
"Keyword": "",
"Pattern": "*",
"Type": " INTERNAL_TABLE"
}
{
"Response": {
"DLCTable": {
"TableBaseInfo": {
"DatabaseName": "abc",
"TableName": "abc",
"DatasourceConnectionName": "abc",
"TableComment": "abc",
"Type": "abc",
"TableFormat": "abc",
"UserAlias": "abc",
"UserSubUin": "abc",
"GovernPolicy": {
"RuleType": "abc",
"GovernEngine": "abc"
},
"DbGovernPolicyIsDisable": "abc",
"SmartPolicy": {
"BaseInfo": {
"Uin": "abc",
"PolicyType": "abc",
"Catalog": "abc",
"Database": "abc",
"Table": "abc",
"AppId": "abc"
},
"Policy": {
"Inherit": "abc",
"Resources": [
{
"AttributionType": "abc",
"ResourceType": "abc",
"Name": "abc",
"Instance": "abc",
"Favor": [
{
"Priority": 0,
"Catalog": "abc",
"DataBase": "abc",
"Table": "abc"
}
],
"Status": 0
}
],
"Written": {
"WrittenEnable": "abc"
},
"Lifecycle": {
"LifecycleEnable": "abc",
"Expiration": 0,
"DropTable": true,
"ExpiredField": "abc",
"ExpiredFieldFormat": "abc"
},
"Index": {
"IndexEnable": "abc"
}
}
}
},
"Columns": [
{
"Name": "abc",
"Type": "abc",
"Comment": "abc",
"Default": "abc",
"NotNull": true,
"Precision": 0,
"Scale": 0,
"Position": 0,
"IsPartition": true
}
],
"Partitions": [
{
"Name": "abc",
"Type": "abc",
"Comment": "abc",
"PartitionType": "abc",
"PartitionFormat": "abc",
"PartitionDot": 0,
"Transform": "abc",
"TransformArgs": [
"abc"
]
}
],
"Location": "abc",
"Properties": [
{
"Key": "abc",
"Value": "abc"
}
],
"ModifiedTime": "abc",
"CreateTime": "abc",
"InputFormat": "abc",
"StorageSize": 0,
"RecordCount": 0,
"MapMaterializedViewName": "abc",
"HeatValue": 0,
"ExternalDataConfiguration": {
"Sds": {
"Location": "abc",
"InputFormat": "abc",
"OutputFormat": "abc",
"NumBuckets": 0,
"Compressed": true,
"StoredAsSubDirectories": true,
"SerdeLib": "abc",
"SerdeName": "abc",
"Params": [],
"SerdeParams": [],
"SortColumns": [],
"BucketCols": [
"abc"
],
"SortCols": {
"Col": "abc",
"Order": 0
},
"Cols": [
{
"Name": "abc",
"Description": "abc",
"Type": "abc",
"Position": 0,
"IsPartition": true
}
]
},
"ViewOriginalText": "abc",
"ViewExpandedText": "abc",
"Retention": 0,
"LifeTime": 0,
"Partitions": [
{
"DatabaseName": "abc",
"SchemaName": "abc",
"TableName": "abc",
"DataVersion": 0,
"Name": "abc",
"Params": [],
"Values": [
"abc"
],
"StorageSize": 0,
"RecordCount": 0,
"CreateTime": "2020-09-22T00:00:00+00:00",
"ModifiedTime": "2020-09-22T00:00:00+00:00",
"LastAccessTime": "2020-09-22T00:00:00+00:00",
"Sds": {
"Location": "abc",
"InputFormat": "abc",
"OutputFormat": "abc",
"NumBuckets": 0,
"Compressed": true,
"StoredAsSubDirectories": true,
"SerdeLib": "abc",
"SerdeName": "abc",
"Params": [],
"SerdeParams": [],
"SortColumns": [],
"BucketCols": [
"abc"
],
"SortCols": {
"Col": "abc",
"Order": 0
},
"Cols": [
{
"Name": "abc",
"Description": "abc",
"Type": "abc",
"Position": 0,
"IsPartition": true
}
]
}
}
]
}
},
"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 |
---|---|
InternalError | An internal error occurred. |
InternalError.InternalSystemException | The business system is abnormal. Please try again or submit a ticket to contact us. |
InvalidParameter | The parameter is incorrect. |
ResourceNotFound | The resource does not exist. |
UnauthorizedOperation | Unauthorized operation. |
문제 해결에 도움이 되었나요?