文件存储 数据管理任务

接口请求域名: cfs.tencentcloudapi.com 。推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。可以查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

相关产品
文件存储 产品页,含版本规格、价格与购买入口。

一、1. 接口描述

支持主动沉降/预热接口

默认接口请求频率限制:20次/秒。

二、2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数,本接口取值:CreateLifecycleDataTask。
Version 是 String 公共参数,本接口取值:2019-07-19。
Region 是 String 公共参数,详见产品支持的 地域列表。
FileSystemId 是 String 文件系统唯一 ID示例值:cfs-4agcdretg
Type 是 String 生命周期任务类型;archive:沉降;restore:预热;release:数据释放;metaload:元数据加载示例值:archive
TaskName 是 String 任务名称示例值:dataarchive
TaskPath 否 String 需要沉降的路径或文件,仅支持传入1个路径,不允许为空。示例值:/cfs/data
DataFlowId 否 String 数据流动 ID ,该接口可以通过 DescribeDataFlow 查询示例值:cfs-dataflow-abcdefeg
IsOverwrite 否 Boolean 当CFSTurbo内的文件和外置存储存在同名情况时,是否覆盖。 ture:覆盖 false:不覆盖(同时也不会释放热存数据) 为空时,默认为false示例值:false
ListPath 否 String 数据清单文件路径,清单文件内每行为待处理文件的完整路径。所有路径(包括清单文件路径、清单文件内每行表示的待处理文件的路径)必须以 /cfs 开头,指向CFS文件系统内已存在的文件,与 TaskPath 参数二选一填写。示例:若挂载的是CFS根目录 /,清单文件位于挂载路径下的 lists/archive_list.txt,则入参值为 /cfs/lists/archive_list.txt若挂载的是CFS子目录 /subdir,清单文件位于挂载路径下的 lists/archive_list.txt,则入参值为 /cfs/subdir/lists/archive_list.txt示例值:/cfs/datalist

三、3. 输出参数

参数名称 类型 描述
TaskId String 任务 ID示例值:task-20250101abcdef
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

四、输入示例

POST / HTTP/1.1
Host: cfs.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateLifecycleDataTask
<公共请求参数>
{
"FileSystemId": "cfs-4agcdretg",
"Type": "archive",
"TaskPath": "/cfs/data",
"TaskName": "dataarchive"
}

五、输出示例

{
"Response": {
"TaskId": "task-abcdefg",
"RequestId": "req-gagagagagag"
}
}

六、腾讯云 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

九、命令行工具

·Tencent Cloud CLI 3.0

十、6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。

错误码 描述
InvalidParameter.ListPathAndTaskPathConflict ListPath 与 TaskPath 同时传入或同时为空
InvalidParameter.ListPathInvalidPrefix 数据清单路径必须以 /cfs 开头
InvalidParameterValue.InvalidDataFlowId 参数值错误:数据流动ID无效
InvalidParameterValue.InvalidDataFlowSourceStorageType 参数值错误:数据流动源存储类型无效
InvalidParameterValue.InvalidDataFlowTargetPath 参数值错误:数据流动目标路径无效
InvalidParameterValue.InvalidFileSystemId FileSystemId无效。
InvalidParameterValue.InvalidFsStatus 无效的文件系统状态。
InvalidParameterValue.InvalidLifecycleDataTaskType 参数值错误:生命周期任务类型无效
InvalidParameterValue.ListPathFileInvalid 清单文件格式不正确,请以 /cfs/ 开头写入完整的文件路径
InvalidParameterValue.ListPathFileNotFound ListPath 指向的清单文件在 CFS 内不存在
InvalidParameterValue.WaitingTaskLimitExceeded 生命周期数据任务数超限
赞 (0)
上一篇 4天前
下一篇 4天前