文件存储查询数据检索任务

1. 接口描述

接口请求域名： cfs.tencentcloudapi.com 。

查询数据检索任务

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

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeDataRetrievalTask。
Version	是	String	公共参数，本接口取值：2019-07-19。
Region	是	String	公共参数，详见产品支持的地域列表。
StartTime	是	String	开始时间。须早于 EndTime ，仅支持查询最近3个月内的任务数据参数格式：2024-11-19 10:15:37 示例值：2026-03-11 11:50:42
EndTime	是	String	结束时间。须晚于 StartTime ，仅支持查询最近3个月内的任务数据。参数格式：2024-10- 19 10:15:37 示例值：2026-03-12 11:50:42
DataRetrievalId	是	String	数据检索ID示例值：dataretrieval-123456 示例值：dataretrieval-589fa03c
Offset	否	Integer	分页的偏移量，默认值为0。示例值：0 示例值：0
Limit	否	Integer	分页单页限制数目，默认值为20，最大值100。示例值：20 示例值：8
Filters.N	否	Array of Filter	DataRetrievalTaskID按照【数据检索任务id】进行过滤。类型：String

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	数据检索任务总量示例值：0 示例值：20
DataRetrievalTasks	Array of DataRetrievalTaskInfo	检索任务详情
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询数据检索任务

输入示例

POST / HTTP/1.1
Host: cfs.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDataRetrievalTask
<公共请求参数>

{
    "StartTime": "2026-03-11 11:50:42",
    "EndTime": "2026-03-12 11:50:42",
    "DataRetrievalId": "dataretrieval-589fa03c",
    "Offset": 0,
    "Limit": 8
}

输出示例

{
    "Response": {
        "DataRetrievalTasks": [
            {
                "CompoundCondition": "from entries|where size &gt;4096",
                "CreateTime": "2026-03-12 11:05:15",
                "DataRetrievalId": "dataretrieval-589fa03c",
                "DataRetrievalTaskID": "dataretrievaltask-d54f5d2c",
                "DirNum": 0,
                "FileList": "",
                "FileNum": 0,
                "FileSystemId": "cfs-44b3b2f23",
                "QueryCondition": "from entries|where size &gt;4096",
                "Size": 0,
                "State": "waiting"
            }
        ],
        "TotalCount": 20,
        "RequestId": "6cf33841-7379-4801-9c6b-d55be465680f"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
InvalidParameterValue.InvalidDataRetrievalId	无效的数据检索ID