全部文档
当前文档
最近更新时间：2026-02-10 11:23:18
本接口（DescribeDataFlows）用于查询数据流动。
GET
请求参数包含公共请求参数和接口请求参数。其中，公共请求参数是每个接口都会用到的请求参数，具体参见公共参数及签名机制；接口请求参数是各个接口所特有的，具体参见下方说明：
请求头
名称 | 是否必须 | 值 |
Content-Type | 是 | application/json |
Accept | 否 | application/json |
请求体
名称 | 类型 | 是否必须 | 描述 |
FileSystemId | string | 是 | 文件系统ID。 |
DataFlowId | string | 否 | 数据流动ID。 |
PageSize | number | 否 | 分页大小，默认为10。 |
PageNum | number | 否 | 页码，默认为1。 |
Action | string | 是 | 该参数为公共参数，取值：DescribeDataFlows。 |
Version | string | 是 | 该参数为公共参数，取值：2024-09-30。 |
名称 | 类型 | 描述 |
Data | object[] | |
—Name | string | 数据流动名称。 |
—DataFlowId | string | 数据流动ID。 |
—FileSystemId | string | KPFS文件系统ID。 |
—DirPath | string | 数据流动关联的KPFS文件系统目录完整绝对路径。若返回/，代表整个文件系统。 |
—Bucket | string | KS3 Bucket名称。 |
—BucketPrefix | string | KS3 Bucket前缀。若返回空，代表整个存储桶。 |
—Status | string | 数据流动状态。
|
—CreateTime | string | 数据流动创建时间。 |
—UpdateTime | string | 数据流动更新时间。 |
—Description | string | 描述信息。 |
PageSize | number | 分页大小。 |
PageNum | number | 页码。 |
TotalCount | number | 数据流动总数。 |
RequestId | string | 唯一请求ID，每次请求都会返回。 |
请求示例
curl --location --request GET 'kpfs.api.ksyun.com/?Action=DescribeDataFlows&Version=2024-09-30&FileSystemId=f81e17eafcfe488bb3dbd33f5bcf8792' \
--header 'X-KSC-ACCOUNT-ID: 2000074729' \
--header 'X-KSC-API: DescribeDataFlows' \
--header 'X-Amz-Date: 20260209T022155Z' \
--header 'Authorization: AWS4-HMAC-SHA256 Credential=AKLTZ3cTib9eQNm9jQv37smn/20260209/cn-beijing-6/kpfs/aws4_request, SignedHeaders=host;x-amz-date;x-ksc-account-id;x-ksc-api, Signature=4438c46879a61d376c5ce26519c61bf698001c04658505635697e85d93e242f2'返回示例
{
"RequestId": "c76c67e1-72bb-41da-90fa-6d0099fc11af",
"Data": [
{
"Name": "xlf0206",
"DataFlowId": "8227e45699884ed9bb4a8d4015346601",
"FileSystemId": "f81e17eafcfe488bb3dbd33f5bcf8792",
"DirPath": "/fromks3/test",
"Bucket": "xlftestimport",
"BucketPrefix": "/tokpfs/test",
"Status": "running",
"CreateTime": "2026-02-06T17:39:30",
"UpdateTime": "2026-02-06T17:39:30",
"Description": "xlf test"
}
],
"PageSize": 10,
"PageNum": 1,
"TotalCount": 1
}纯净模式