tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ImportTableFile

Last updated: 2024-07-26 15:26:01

1. API Description

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

This API is used to import the table file.

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: ImportTableFile.
Version Yes String Common Params. The value used for this API: 2022-11-28.
Region No String Common Params. This parameter is not required for this API.
ProjectId Yes String Project ID associated with the table
Name Yes String Table name: Up to 200 characters in length is supported.
CosUri Yes String Table file COS object path
DataType.N Yes Array of String Data type of each column in the table file. Supported types include Int, Float, String, File, Boolean, Array[Int], Array[Float], Array[String], Array[File], and Array[Boolean].
Description No String Table description: Up to 500 characters in length is supported.

3. Output Parameters

Parameter Name Type Description
TableId String Table ID
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 Importing the Table File

This example shows you how to import the table file.

Input Example

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

{
    "ProjectId": "prj-aggressive-lime-porcupine-752427",
    "Name": "test_table",
    "Description": "Test table",
    "CosUri": "cos://bucket/test.csv",
    "DataType": [
        "String",
        "File"
    ]
}

Output Example

{
    "Response": {
        "TableId": "tab-fancy-saffron-slug-701244",
        "RequestId": "50d781c7-eab9-4339-93ed-c312a2452d9d"
    }
}

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 CAM signature/authentication error.
FailedOperation.DuplicateTableHeader Duplicate table headers.
FailedOperation.EmptyTableHeader Empty table header.
FailedOperation.InvalidTableHeader Incorrect table header.
FailedOperation.InvalidTableLength Incorrect number of table rows.
FailedOperation.TableDataTypeMismatch Mismatch exists between table data and type.
InternalError Internal error.
InvalidParameter Parameter error.
InvalidParameterValue Parameter value error.
InvalidParameterValue.DuplicateName Duplicated name.
InvalidParameterValue.InvalidCosKey Incorrect COS path.
InvalidParameterValue.InvalidCsvFormat Incorrect CSV file format.
InvalidParameterValue.InvalidDescription Incorrect description.
InvalidParameterValue.InvalidName Incorrect name.
InvalidParameterValue.TableDataTypeLengthMismatch Length mismatch exists between table data and type.
InvalidParameterValue.UnsupportedTableDataType Unsupported table data type.
OperationDenied Operation rejected.
ResourceNotFound The resource does not exist.
ResourceNotFound.CosBucketNotExist The bucket does not exist.
ResourceNotFound.CosObjectNotExist The storage object does not exist.
ResourceNotFound.ProjectNotExist The project does not exist.
ResourceNotFound.TableNotExist The table does not exist.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy