1. 接口描述
接口请求域名: goosefs.tencentcloudapi.com 。
创建数据流通任务,包括从将文件系统的数据上传到存储桶下, 以及从存储桶下载到文件系统里。
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CreateDataRepositoryTask。 |
| Version | 是 | String | 公共参数,本接口取值:2022-05-19。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| TaskType | 是 | String | 数据流通任务类型, FS_TO_COS(文件系统到COS Bucket),或者COS_TO_FS(COS Bucket到文件系统) 示例值:FS_TO_COS |
| Bucket | 是 | String | COS存储桶名 示例值:mybucket-1250000 |
| FileSystemId | 是 | String | 文件系统ID 示例值:x_c60_r3c4fa1f |
| TaskPath | 是 | String | 对于FS_TO_COS, TaskPath是Bucket映射目录的相对路径, 对于COS_TO_FS是COS上的路径。如果置为空, 则表示全部数据 示例值:aaa/bbb |
| TaskName | 是 | String | 任务名称 示例值:DOWNLOAD |
| IsTaskPathAbsolute | 否 | Boolean | 任务路径是否表示绝对路径(暂时仅支持沉降使用) 示例值:false |
| RepositoryType | 否 | String | 数据流通方式 MSP_AFM 手动加载 RAW_AFM 按需加载 示例值:MSP_AFM |
| TextLocation | 否 | String | 文件列表下载地址,以http开头 示例值:https://location.com/list.txt |
| EnableCustomDestPath | 否 | Boolean | 是否开启自定义目的路径(预热任务表示本地路径,沉降任务表示COS桶前缀) 示例值:false |
| CustomDestPath | 否 | String | 自定义目的路径(预热任务表示本地路径,沉降任务表示COS桶前缀) 示例值:dst/ |
| OutputBucket | 否 | String | 输出的COS桶,用于存放任务执行的相关结果(当前用于存放任务失败时的失败文件列表) 示例值:example-11111111 |
| OutputPrefix | 否 | String | 输出的COS桶的前缀,用于存放任务执行的相关结果(当前用于存放任务失败时的失败文件列表) 示例值:goosefsx/data_task/ |
| EnableCustomSrcPath | 否 | Boolean | 是否支持自定义数据源路径(暂时仅支持清单过滤使用) 示例值:false |
| CustomSrcPath | 否 | String | 自定义数据源路径(暂时仅支持清单过滤使用) 示例值:src/ |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TaskId | String | 任务ID 示例值:c1a2b3f4 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 调用
输入示例
POST / HTTP/1.1
Host: goosefs.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateDataRepositoryTask
<公共请求参数>
{
"TaskType": "COS_TO_FS",
"Bucket": "ace-bj-donot-del-xxxxx",
"FileSystemId": "x-c60-xxxx",
"TaskPath": "dup/",
"TaskName": "预热测试_1",
"EnableCustomDestPath": false,
"OutputBucket": "ace-bj-donot-del-xxxxx",
"OutputPrefix": "data-repository-task-results/"
}
输出示例
{
"Response": {
"TaskId": "x_task_1787660399825",
"RequestId": "17015b3c-9d94-4c0a-8e00-5d53cc86fca5"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。