云数据库 TiDB 版
云数据库 TiDB 版
文档指南
请输入
- 文档首页
云数据库 TiDB 版API 参考导出任务管理CreateExportTask - 创建导出任务
复制全文
下载 pdfCreateExportTask - 创建导出任务
文档反馈
问问助手调用 CreateExportTask 接口创建导出任务。
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
Action string 必选 示例值：CreateExportTask
要执行的操作，取值：CreateExportTask。
Version string 必选 示例值：2026-06-30
API的版本，取值：2026-06-30。
ExportOptions object 可选 示例值：{ "FileType": "PARQUET", "Filter": { "Table": { "Patterns": [ "*.*" ] } }, "ParquetFormat": { "Compression": "SNAPPY" } }
导出选项。
FileType string 可选 示例值：PARQUET
数据格式。取值如下：
- SQL：SQL 格式。
- CSV：CSV 格式。
- Parquet：Parquet 格式。
Compression string 可选 示例值：ZSTD
压缩算法。取值如下：
- ZSTD：ZSTD 压缩格式。
- Gzip：Gzip 压缩格式。
- Snappy：Snappy 压缩格式。
- NONE：无压缩。
Filter object 可选 示例值：{ "Table": { "Patterns": [ "test.*" ] } }
过滤条件。
Sql string 可选
SQL 过滤条件。
Table object 可选 示例值：{ "Patterns": [ "*.*" ] }
表过滤规则。
Patterns string[] 可选 示例值：*.*
表匹配规则。例如：
- *.*：匹配该数据源下所有库的全部表。
- test.*：匹配 test 库下面的全部数据表。
- test.name：精准匹配 test 库下面的 name 表。
Where string 可选
WHERE 条件。
CsvFormat object 可选
CSV 格式配置。
Separator string 可选 示例值：,
列分隔符。
Delimiter string 可选 示例值：\"
定界符。
NullValue string 可选 示例值：\\N
NULL 的字符串表示。
SkipHeader boolean 可选 示例值：true
是否跳过表头。取值如下：
- true：跳过表头。
- false：不跳过表头。
ParquetFormat object 可选
Parquet 格式配置。
Compression string 可选 示例值：ZSTD
压缩算法。取值如下：
- ZSTD：ZSTD 压缩格式。
- Gzip：Gzip 压缩格式。
- Snappy：Snappy 压缩格式。
- NONE：无压缩。
Target object 必选 示例值：{ "Type": "TOS", "Tos": { "Uri": "tos://test/", "AuthType": "ACCESS_KEY", "AccessKey": { "Id": "AKLTNGRlYWNiMzJhMTYyNGEzMmIxNzg0YjQ1OGFi********", "Secret": "TWpVME9HUTBOR0UzT0Rka05HTTFOVGxoWTJaaU1XWTVOem**************" } }
目标存储配置。
Type string 可选 示例值：TOS
目标类型。
Tos object 可选 示例值：{ "AccessKey": { "Id": "AKLTNGRlYWNiMzJhMTYyNGEzMmIxNzg0Y*****************" }, "AuthType": "ACCESS_KEY", "Uri": "tos://test/" }
TOS 目标配置。
Uri string 可选 示例值：tos://test/
TOS URI。
AuthType string 可选 示例值：ACCESS_KEY
固定为 ACCESS_KEY。
AccessKey object 可选 示例值： "Id": "AKLTNGRlYWNiMzJhMTYyNGEzMmIxNzg0YjQ1O**********" }
访问凭证。
说明
Id string 可选 示例值：AKLTNGRlYWNiMzJhMTYyNGEzMmIxNz*******************
AccessKey ID。
Secret string 可选 示例值：*********
AccessKey Secret。
ExportTaskName string 可选 示例值：exportname1
导出任务名称。
ProjectName string 可选 示例值：default
项目名称。
InstanceId string 必选 示例值：tidb-cd4a36******
实例 ID。
返回参数
Export_ object 示例值：{ "InstanceId": "tidb-cd4a36******", "CreateTime": "2026-10-26T03:47:54.045Z", "ExportId": "exp-3lqt4545jzfyna5dwcf6******", "ExportOptions": { "Compression": "ZSTD", "FileType": "SQL", "Filter": { "Table": { "Patterns": [ "test.*" ] } } }, "ExportTaskName": "export1", "SnapshotTime": "2026-10-26T03:47:53.268Z", "State": "RUNNING", "Target": { "Tos": { "AccessKey": { "Id": "AKLTN*********IxNzg0YjQ1OGFiMm***" }, "AuthType": "ACCESS_KEY", "Uri": "tos://test/" }, "Type": "TOS" } }
创建成功的导出任务信息。
ExportId string 示例值：exp-q3knvcfwo5csdie7suod******
导出任务 ID。
State string 示例值：RUNNING
任务状态。
ExportOptions object 示例值：{ "Compression": "NONE", "FileType": "PARQUET", "Filter": { "Table": { "Patterns": [ "*.*" ] } }, "ParquetFormat": { "Compression": "SNAPPY" } }
导出选项。
FileType string 示例值：PARQUET
数据格式。取值如下：
- SQL：SQL 格式。
- CSV：CSV 格式。
- Parquet：Parquet 格式。
Compression string 示例值：ZSTD
压缩算法。取值如下：
- ZSTD：ZSTD 压缩格式。
- Gzip：Gzip 压缩格式。
- Snappy：Snappy 压缩格式。
- NONE：无压缩。
Filter object 示例值：{ "Table": { "Patterns": [ "test.*" ] } }
过滤条件。
Sql string
SQL 过滤条件。
Table object 示例值：{ "Patterns": [ "*.*" ] }
表过滤规则。
Patterns string[] 示例值：*.*
表匹配规则。例如：
- *.*：匹配该数据源下所有库的全部表。
- test.*：匹配 test 库下面的全部数据表。
- test.name：精准匹配 test 库下面的 name 表。
Where string
WHERE 条件。
CsvFormat object
CSV 格式配置。
Separator string 示例值：,
列分隔符。
Delimiter string 示例值：\"
定界符。
NullValue string 示例值：\\N
NULL 的字符串表示。
SkipHeader boolean 示例值：true
是否跳过表头。取值如下：
- true：跳过表头。
- false：不跳过表头。
ParquetFormat object
Parquet 格式配置。
Compression string 示例值：ZSTD
压缩算法。取值如下：
- ZSTD：ZSTD 压缩格式。
- Gzip：Gzip 压缩格式。
- Snappy：Snappy 压缩格式。
- NONE：无压缩。
Target object 示例值：{ "Tos": { "AccessKey": { "Id": "AKLTNGRlYWNiMzJhMTYyNGEzMmIxNzg0YjQ1OGFi********" }, "AuthType": "ACCESS_KEY", "Uri": "tos://test/" }, "Type": "TOS" }
目标存储配置。
Type string 示例值：TOS
目标类型。
Tos object 示例值：{ "AccessKey": { "Id": "AKLTNGRlYWNiMzJhMTYyNGEzMmIxNzg0Y*****************" }, "AuthType": "ACCESS_KEY", "Uri": "tos://test/" }
TOS 目标配置。
Uri string 示例值：tos://test/
TOS URI。
AuthType string 示例值：ACCESS_KEY
固定为 ACCESS_KEY。
AccessKey object 示例值： "Id": "AKLTNGRlYWNiMzJhMTYyNGEzMmIxNzg0YjQ1O**********" }
访问凭证。
说明
Id string 示例值：AKLTNGRlYWNiMzJhMTYyNGEzMmIxNz*******************
AccessKey ID。
Secret string 示例值：*********
AccessKey Secret。
Reason string
失败或取消原因。
CreateTime string 示例值：2026-08-24T09:10:32.976Z
创建时间。
UpdateTime string 示例值：2026-08-24T09:10:32.976Z
最近更新时间。
CompleteTime string 示例值：2026-08-24T09:10:32.976Z
完成时间。
SnapshotTime string 示例值：2026-08-24T09:10:32.976Z
快照时间。
ExpireTime string 示例值：2026-08-24T09:10:32.976Z
结果过期时间。
ExportTaskName string
导出任务名称。
InstanceId string 示例值：tidb-cd4a36******
所属实例 ID。
请求示例
返回示例
错误码
最近更新时间：2026.10.30 11:06:00
这个页面对您有帮助吗？
有用
有用
无用
无用