文件存储查询数据流动信息

1. 接口描述

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

查询数据流动信息接口

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeDataFlow。
Version	是	String	公共参数，本接口取值：2019-07-19。
Region	是	String	公共参数，详见产品支持的地域列表。
FileSystemId	否	String	文件系统 ID ，通过查询文件系统 DescribeCfsFileSystems 获取示例值：cfs-4gagkckgl
DataFlowId	否	String	数据流动 ID ，由创建数据流动返回示例值：cfs-dataflow-abcdefgh
Limit	否	Integer	每次查询返回值个数，默认20；最大100 示例值：10
Offset	否	Integer	偏移量，默认为0 示例值：1
CfsVersion	否	String	文件系统版本；版本号：v1.5，v3.0，v3.1，v4.0 示例值：v1.5

3. 输出参数

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

4. 示例

示例1 查询数据流动

输入示例

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

{}

输出示例

{
    "Response": {
        "DataFlows": [
            {
                "CreationTime": "2025-06-10 10:23:28",
                "DataFlowId": "cfs-dataflow-23e12b77",
                "DataFlowName": "aileen-test",
                "FileSystemId": "cfs-4551ef87e",
                "SourcePath": "test3",
                "SourceStorageAddress": "https://aileen-data-flow-1251000004.cos.ap-guangzhou.myqcloud.com",
                "SourceStorageType": "S3_COS",
                "Status": "available",
                "TargetPath": "/cfs/test3/"
            },
            {
                "CreationTime": "2025-06-10 15:01:26",
                "DataFlowId": "cfs-dataflow-dcee19a7",
                "DataFlowName": "aileen-test",
                "FileSystemId": "cfs-4551ef87e",
                "SourcePath": "test4",
                "SourceStorageAddress": "https://aileen-data-flow-1251000001.cos.ap-guangzhou.myqcloud.com",
                "SourceStorageType": "S3_COS",
                "Status": "available",
                "TargetPath": "/cfs/test4/"
            },
            {
                "CreationTime": "2025-06-10 15:01:45",
                "DataFlowId": "cfs-dataflow-13ff99f9",
                "DataFlowName": "aileen-test",
                "FileSystemId": "cfs-44d53b63e",
                "SourcePath": "test4",
                "SourceStorageAddress": "https://aileen-data-flow-1251000001.cos.ap-guangzhou.myqcloud.com",
                "SourceStorageType": "S3_COS",
                "Status": "available",
                "TargetPath": "/cfs/test8/"
            },
            {
                "CreationTime": "2025-06-10 15:01:53",
                "DataFlowId": "cfs-dataflow-7368df7c",
                "DataFlowName": "aileen-test",
                "FileSystemId": "cfs-44d53b63e",
                "SourcePath": "test3",
                "SourceStorageAddress": "https://aileen-data-flow-1251000001.cos.ap-guangzhou.myqcloud.com",
                "SourceStorageType": "S3_COS",
                "Status": "available",
                "TargetPath": "/cfs/test9/"
            },
            {
                "CreationTime": "2025-06-10 15:23:25",
                "DataFlowId": "cfs-dataflow-4f827203",
                "DataFlowName": "test",
                "FileSystemId": "cfs-44d53b63e",
                "SourcePath": "test3",
                "SourceStorageAddress": "https://aileen-data-flow-1251000001.cos.ap-guangzhou.myqcloud.com",
                "SourceStorageType": "S3_COS",
                "Status": "available",
                "TargetPath": "/cfs/test11/"
            }
        ],
        "RequestId": "adf187c6-a557-4331-b103-dded23e9bfeb",
        "TotalCount": 5
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
InvalidParameterValue.InvalidDataFlowId	参数值错误：数据流动ID无效
InvalidParameterValue.InvalidDataFlowName	无效的数据流动名称
InvalidParameterValue.InvalidFileSystemId	FileSystemId无效。
ResourceNotFound.FileSystemNotFound	该文件系统不存在。

查询数据流动信息

本页目录：