tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateDLCTable

Last updated: 2024-08-21 19:10:34

1. API Description

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

This API is used to create a table.

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: CreateDLCTable.
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.
TableBaseInfo Yes TableBaseInfo Data table configuration information
TableType Yes String Table type
Columns.N No Array of TColumn Data table column information
Partitions.N No Array of TPartition Data table partition information
Properties.N No Array of Property Data table attribute information
ExternalDataConfiguration No ExternalDataConfiguration External table configuration information
DataEngineName No String Engine name
ResourceGroupname No String Resource group name

3. Output Parameters

Parameter Name Type Description
DLCTable DLCTable DLC table information object
Note: This field may return null, indicating that no valid values can be obtained.
Execution String The SQL statement for creating a managed storage internal table
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 Creating a Table

Input Example

POST / HTTP/1.1
Host: dlc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateDLCTable

{
    "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"
                }
            }
        }
    },
    "TableType": "abc",
    "Columns": [
        {
            "Name": "abc",
            "Type": "abc",
            "Comment": "abc",
            "Default": "abc",
            "NotNull": true,
            "Precision": 0,
            "Scale": 0
        }
    ],
    "Partitions": [
        {
            "Name": "abc",
            "Type": "abc",
            "Comment": "abc",
            "PartitionType": "abc",
            "PartitionFormat": "abc",
            "PartitionDot": 0,
            "Transform": "abc",
            "TransformArgs": [
                "abc"
            ]
        }
    ],
    "Properties": [
        {
            "Key": "abc",
            "Value": "abc"
        }
    ],
    "ExternalDataConfiguration": {
        "Sds": {
            "Location": "abc",
            "InputFormat": "abc",
            "OutputFormat": "abc",
            "NumBuckets": 0,
            "Compressed": true,
            "StoredAsSubDirectories": true,
            "SerdeLib": "abc",
            "SerdeName": "abc",
            "BucketCols": [
                "abc"
            ],
            "SerdeParams": [
                {
                    "Key": "abc",
                    "Value": "abc"
                }
            ],
            "Params": [
                {
                    "Key": "abc",
                    "Value": "abc"
                }
            ],
            "SortCols": {
                "Col": "abc",
                "Order": 0
            },
            "Cols": [
                {
                    "Name": "abc",
                    "Description": "abc",
                    "Type": "abc",
                    "Position": 0,
                    "Params": [
                        {
                            "Key": "abc",
                            "Value": "abc"
                        }
                    ],
                    "IsPartition": true
                }
            ],
            "SortColumns": [
                {
                    "Col": "abc",
                    "Order": 0
                }
            ]
        },
        "ViewOriginalText": "abc",
        "ViewExpandedText": "abc",
        "Retention": 0,
        "LifeTime": 0,
        "Partitions": [
            {
                "DatabaseName": "abc",
                "SchemaName": "abc",
                "TableName": "abc",
                "DataVersion": 0,
                "Name": "abc",
                "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",
                    "BucketCols": [
                        "abc"
                    ],
                    "SortCols": {
                        "Col": "abc",
                        "Order": 0
                    },
                    "Cols": [
                        {
                            "Name": "abc",
                            "Description": "abc",
                            "Type": "abc",
                            "Position": 0,
                            "IsPartition": true
                        }
                    ]
                }
            }
        ]
    },
    "DataEngineName": "abc",
    "ResourceGroupname": "abc"
}

Output Example

{
    "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
                                }
                            ]
                        }
                    }
                ]
            }
        },
        "Execution": "create table `table1` ()",
        "RequestId": "abc"
    }
}

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
InternalError An internal error occurred.
InvalidParameter The parameter is incorrect.
ResourceNotFound The resource does not exist.
UnauthorizedOperation Unauthorized operation.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy