tencent cloud

All product documents
APIs
DocumentationAPIsData Lake ComputeData Table APIsGenerateCreateMangedTableSql
GenerateCreateMangedTableSql
Last updated: 2024-08-21 19:10:10
GenerateCreateMangedTableSql
Last updated: 2024-08-21 19:10:10

1. API Description

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

This API is used to generate SQL statements for creating a managed 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: GenerateCreateMangedTableSql.
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 The basic table information.
Columns.N Yes Array of TColumn The table fields.
Partitions.N No Array of TPartition The table partitions.
Properties.N No Array of Property The table properties.
UpsertKeys.N No Array of String The Upsert key for a v2 table (in Upsert mode).

3. Output Parameters

Parameter Name Type Description
Execution Execution The SQL statements for creating the managed 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 Managed Storage Internal Table

This example shows you how to create a managed storage internal table.

Input Example

POST / HTTP/1.1
Host: dlc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GenerateCreateMangedTableSql
<Common request parameters>

{
    "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
                },
                "Index": {
                    "IndexEnable": "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"
        }
    ],
    "UpsertKeys": [
        "abc"
    ]
}

Output Example

{
    "Response": {
        "Execution": {
            "SQL": "<create sql>"
        },
        "RequestId": "RequestId"
    }
}

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
FailedOperation The operation failed.
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.
InvalidParameter.InvalidColumnNameLength The field name is set incorrectly. The field name must be less than or equal to 128 bytes.
InvalidParameter.InvalidColumnNumber The number of fields is set incorrectly. The number of fields must be less than or equal to 4096.
InvalidParameter.InvalidDecimalType The DecimalType setting is invalid. Precision must be greater than or equal to Scale, and Precision must be less than 38.
InvalidParameter.InvalidTableNameLength The table name is set incorrectly. The length of the table name must be less than or equal to 128 bytes.
InvalidParameter.ParameterNotFoundOrBeNone The parameter is not found or empty.
ResourceUnavailable The resource is unavailable.
UnauthorizedOperation Unauthorized operation.
UnsupportedOperation Unsupported operation.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support