1. 接口描述
接口请求域名: cfs.tencentcloudapi.com 。
创建数据流动接口
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateDataFlow。 |
Version | 是 | String | 公共参数,本接口取值:2019-07-19。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
FileSystemId | 是 | String | 文件系统 ID ,通过查询文件系统 DescribeCfsFileSystems 获取 示例值:cfs-4abkgaga |
SourceStorageType | 是 | String | 源端数据类型;包含S3_COS,S3_L5 示例值:S3_COS |
SourceStorageAddress | 是 | String | 源端存储地址 示例值:https://cfs-test-1251000014.cos.ap-shanghai.myqcloud.com |
SourcePath | 是 | String | 源端路径 示例值:/cos/test |
TargetPath | 是 | String | 文件系统内目标路径 示例值:/cfs/123 |
SecretId | 是 | String | 密钥 ID 示例值:asafsafsa |
SecretKey | 是 | String | 密钥 key 示例值:ssafsafas |
DataFlowName | 否 | String | 数据流动名称;支持不超过64字符长度,支持中文、数字、_、- 示例值:default |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
DataFlowId | String | 数据流动管理 ID 示例值:cfs-dataflow-abcdefgh |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建数据流动
输入示例
POST / HTTP/1.1
Host: cfs.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateDataFlow
<公共请求参数>
{
"FileSystemId": "cfs-44d53b63e",
"SourceStorageType": "S3_COS",
"SourceStorageAddress": "https://aileen-data-flow-1251000004.cos.ap-guangzhou.myqcloud.com",
"SourcePath": "test3",
"TargetPath": "/cfs/test11",
"SecretId": "AKIDbzzYj65vue75sC1yg8P4cyBHBpLk",
"SecretKey": "onE8m9NN82ik6h3FCvXt2uc3Sjp",
"DataFlowName": "test"
}
输出示例
{
"Response": {
"DataFlowId": "cfs-dataflow-4f827203",
"RequestId": "c5369436-a47c-4504-9cfa-f1f40c2c969f"
}
}
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: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InvalidParameterValue.InvalidDataFlowName | 无效的数据流动名称 |
InvalidParameterValue.InvalidDataFlowSourceInfo | 参数值错误:数据流动源信息无效,请检查密钥及路径 |
InvalidParameterValue.InvalidDataFlowSourceStorageType | 参数值错误:数据流动源存储类型无效 |
InvalidParameterValue.InvalidDataFlowTargetPath | 参数值错误:数据流动目标路径无效 |
InvalidParameterValue.InvalidFileSystemId | FileSystemId无效。 |
InvalidParameterValue.InvalidLifecycleDataTaskType | 参数值错误:生命周期任务类型无效 |
ResourceInsufficient.DataFlowLimitExceeded | 资源不足:数据流动数超限 |
ResourceNotFound.FileSystemNotFound | 该文件系统不存在。 |