1. 接口描述
接口请求域名： cfs.tencentcloudapi.com 。
创建数据检索
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateDataRetrieval。 |
| Version | 是 | String | 公共参数，本接口取值：2019-07-19。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| FileSystemId | 是 | String | 文件系统实例 ID，通过查询文件系统 DescribeCfsFileSystems 获取 示例值：cfs-xxxxxx 示例值：cfs-4e5e76ff8 |
| DataRetrievalName | 是 | String | 数据检索名称 示例值：DataDive 示例值：default |
| CompoundCondition | 否 | String | 聚合检索条件 示例值：from entries|where size >4096 示例值：WHERE size > 1048576 AND type == "file" |
| QueryCondition | 否 | String | 列表检索条件 示例值：from entries|where size >4096 |
| DayOfMonth | 否 | String | 数据检索按月重复，每月1-31号，选择一天，每月将在这一天自动创建快照；例如1 代表1号；与DayOfWeek二选一 示例值：1 示例值：1 |
| DayOfWeek | 否 | String | 数据检索重复日期，星期一到星期日。 1代表星期一、7代表星期天，与DayOfMonth，二选一 示例值：2,3 示例值：3,4 |
| Hour | 否 | String | 重复时间点,0-23，小时 示例值：1,3,5 示例值：12,13 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| DataRetrievalId | String | 数据检索ID示例值：dataretrieval-123456 示例值：dataretrieval-1234bdbc |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建数据检索策略
输入示例
POST / HTTP/1.1
Host: cfs.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateDataRetrieval
<公共请求参数>
{
"FileSystemId": "cfs-4e5e76ff8",
"DataRetrievalName": "default",
"DayOfWeek": "3,4",
"Hour": "12,13"
}输出示例
{
"Response": {
"DataRetrievalId": "dataretrieval-1234bdbc",
"RequestId": "b3df3eb8-cd14-4c0a-8b8d-11a7ad082b40"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameterValue.DataRetrievalScheduleConflict | 数据检索定时规则冲突 |
