调用 PreviewLocalImport 结果预览本地文件导入结果。

使用说明

仅 Essential 计划支持本地导入预览。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action string 必选示例值：PreviewLocalImport

要执行的操作，取值：PreviewLocalImport。

Version string 必选示例值：2026-06-30

API的版本，取值：2026-06-30。

UploadId string 必选示例值： upl-byxkbgtdrrclvjamv55******

上传 ID。

说明

可通过 CreateImportTask 接口上传本地文件返回的 UploadId 进行查询。

FileType string 必选示例值： CSV

数据格式。取值如下：

CSV：CSV 格式。

Parquet：Parquet 格式。

AURORA_SNAPSHOT：AURORA_SNAPSHOT 格式。

SQL：SQL 格式。

CsvFormat object 可选示例值：

CSV 格式配置。

Header boolean 可选示例值：truetrue

是否包含首行表头。取值如下:

true：包含。

false：不包含。

NotNull boolean 可选示例值：true

是否禁止列为 NULL。取值如下：

true：禁止。

false：不禁止。

NullValue string 可选示例值：\\N

NULL 的字符串表示。

BackslashEscape boolean 可选示例值：true

是否转义反斜杠。取值如下:

true：转义。

false：不转义。

TrimLastSeparator boolean 可选示例值：true

是否去除行尾多余分隔符。取值如下:

true：去除。

false：不去除。

Separator string 可选示例值：,

列分隔符。

Delimiter string 可选示例值：\"

包裹符。

ProjectName string 可选示例值： default

项目名称。

InstanceId string 必选示例值：tidb-eb7cbe******

实例 ID。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

Table object 示例值：

预览的表信息（本地文件仅含一张表）。

database_name string

数据库名。

table_name string

表名。

row_headers string[]

列名。

row_values object[]

样例行数据。

column_values string[]

行内各列值。

row_data_types string[]

各列数据类型。

column_is_pk boolean[]

各列是否为主键。

column_auto_gen boolean[]

各列是否自增/自动生成。

请求示例

返回示例

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	AuditLogDisabled	Audit logging is disabled for the specified cluster.	指定集群未开启审计日志。
400	AuditLogInvalidParameter	The audit log request is invalid: %s	审计日志请求参数无效：%s
400	DefaultPrivateEndpointCannotBeDeleted	The default private endpoint %s cannot be deleted from the allowlist.	默认私网终端节点 %s 不能从白名单中删除。
400	DefaultPrivateEndpointCannotBeReplaced	The default private endpoint %s cannot be replaced. Only its allowlist rule name can be changed.	默认私网终端节点 %s 不支持替换，只能修改其白名单规则名称。
400	PrivateEndpointServiceMismatch	The specified private endpoint %s is not connected to the TiDB endpoint service for this cluster.	私网终端节点 %s 未连接到当前集群对应的 TiDB 终端节点服务。
400	InvalidPrivateEndpoint	The specified private endpoint %s is invalid: %s.	私网终端节点 %s 无效：%s。
400	DisplayNameNotUnique	Cluster names must be unique. The current name [%s] already exists. Please use a different name.	集群名称需保持唯一，当前名称%s已存在，请使用其他名称。
400	QuotaExceeded	The account quota has been exceeded.	账号配额已超限。
400	OperationUnsupported	The operation is unsupported for the specified cluster. %s	操作不支持。%s
400	InvalidParameterFormat	The input parameter is not valid.	请求参数格式错误。
400	UnsupportedParameter	The specified parameter %s is not support.	当前参数%s值不支持。
400	InvalidParameter	The specified parameter %s is not valid.	参数%s值无效。
400	MissingParameter	The input parameter %s that is mandatory for processing this request is not supplied.	缺少%s参数。
400	MissingParameter	The input parameter %s that is mandatory for processing this request is not supplied.	缺少%s参数。
400	InvalidParameter	The specified parameter %s is not valid.	参数%s值无效。
400	UnsupportedParameter	The specified parameter %s is not support.	当前参数%s值不支持。
400	InvalidParameterFormat	The input parameter is not valid.	请求参数格式错误。
400	OperationUnsupported	The operation is unsupported for the specified cluster. %s	操作不支持。%s
400	QuotaExceeded	The account quota has been exceeded.	账号配额已超限。
400	DisplayNameNotUnique	Cluster names must be unique. The current name [%s] already exists. Please use a different name.	集群名称需保持唯一，当前名称%s已存在，请使用其他名称。
400	InvalidPrivateEndpoint	The specified private endpoint %s is invalid: %s.	私网终端节点 %s 无效：%s。
400	PrivateEndpointServiceMismatch	The specified private endpoint %s is not connected to the TiDB endpoint service for this cluster.	私网终端节点 %s 未连接到当前集群对应的 TiDB 终端节点服务。
400	DefaultPrivateEndpointCannotBeReplaced	The default private endpoint %s cannot be replaced. Only its allowlist rule name can be changed.	默认私网终端节点 %s 不支持替换，只能修改其白名单规则名称。
400	DefaultPrivateEndpointCannotBeDeleted	The default private endpoint %s cannot be deleted from the allowlist.	默认私网终端节点 %s 不能从白名单中删除。
400	AuditLogInvalidParameter	The audit log request is invalid: %s	审计日志请求参数无效：%s
400	AuditLogDisabled	Audit logging is disabled for the specified cluster.	指定集群未开启审计日志。
403	PermissionDenied	You are not authorized to perform this operation.	没有权限执行该操作。
403	PermissionDenied	You are not authorized to perform this operation.	没有权限执行该操作。
404	PrivateEndpointNotFound	The specified private endpoint %s does not exist.	未找到私网终端节点 %s。
404	AuditLogFilterRuleNotFound	The specified audit log filter rule %s does not exist.	未找到审计日志过滤规则 %s。
404	RestoreJobNotFound	No restore job found for the specified cluster.	未找到恢复任务。
404	TableNotFound	The specified table %s does not exist.	未找到Table %s
404	PrivateEndpointAllowlistRuleNotFound	The private endpoint allowlist rule for VpcEndpointId %s does not exist.	未找到 VpcEndpointId 为 %s 的私网白名单规则。
404	BranchNotFound	The specified branch %s does not exist.	未找到BranchId %s。
404	ClusterNotFound	The specified cluster %s does not exist.	未找到ClusterId %s。
404	ProjectNotFound	The specified project %s does not exist.	未找到Project %s。
404	ProjectNotFound	The specified project %s does not exist.	未找到Project %s。
404	ClusterNotFound	The specified cluster %s does not exist.	未找到ClusterId %s。
404	BranchNotFound	The specified branch %s does not exist.	未找到BranchId %s。
404	PrivateEndpointNotFound	The specified private endpoint %s does not exist.	未找到私网终端节点 %s。
404	PrivateEndpointAllowlistRuleNotFound	The private endpoint allowlist rule for VpcEndpointId %s does not exist.	未找到 VpcEndpointId 为 %s 的私网白名单规则。
404	TableNotFound	The specified table %s does not exist.	未找到Table %s
404	RestoreJobNotFound	No restore job found for the specified cluster.	未找到恢复任务。
404	AuditLogFilterRuleNotFound	The specified audit log filter rule %s does not exist.	未找到审计日志过滤规则 %s。
409	AuditLogFilterRuleAlreadyExists	The audit log filter rule %s already exists.	审计日志过滤规则 %s 已存在。
409	PrivateEndpointNotAvailable	The specified private endpoint %s is not available. Current status: %s.	私网终端节点 %s 当前不可用，当前状态：%s。
409	PrivateEndpointAllowlistRuleAlreadyExists	The private endpoint allowlist rule for VpcEndpointId %s already exists.	VpcEndpointId 为 %s 的私网白名单规则已存在。
409	PrivateEndpointAllowlistRuleAlreadyExists	The private endpoint allowlist rule for VpcEndpointId %s already exists.	VpcEndpointId 为 %s 的私网白名单规则已存在。
409	PrivateEndpointNotAvailable	The specified private endpoint %s is not available. Current status: %s.	私网终端节点 %s 当前不可用，当前状态：%s。
409	AuditLogFilterRuleAlreadyExists	The audit log filter rule %s already exists.	审计日志过滤规则 %s 已存在。
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	内部错误。
500	ServiceBusy	The system is busy, please try again later.	系统繁忙，请稍后重试。
500	TiDBError	err from tidb: %s	TiDB错误：%s。
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	内部错误。
500	TiDBError	err from tidb: %s	TiDB错误：%s
500	ServiceBusy	The system is busy, please try again later.	系统繁忙，请稍后重试。
503	ServiceUnavailable	The request has failed due to a temporary failure of the server.	当前服务暂时不可用。
503	ServiceUnavailable	The request has failed due to a temporary failure of the server.	当前服务暂时不可用。

云数据库 TiDB 版