调用DescribeDataFlows接口查询指定CPFS文件系统的数据流动信息。

接口说明

  • 仅CPFS 2.2.0及以上版本支持数据流动。您可以在控制台文件系统详情页面查看版本信息。
  • 筛选键（Filters）中，FsetIds、DataFlowlds、SourceStorage、ThroughputList、Status需要做全字匹配，FileSystemPath、Description支持模糊匹配。
  • 支持组合查询。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

请求参数

名称类型是否必选示例值描述
名称 类型 是否必选 示例值 描述
Action String 是 DescribeDataFlows

接口名称。固定取值：DescribeDataFlows。
FileSystemId String 是 cpfs-12345678

文件系统ID。
NextToken String 否 TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=

当请求的返回结果被截断时，您可以使用NextToken再次发起请求，获取从当前截断位置之后的内容。
MaxResults Long 否 20

每次查询结果的个数。

取值范围：10~100。默认值：20。
Filters.N.Key String 否 FsetIds

筛选键的名称。取值：

  • DataFlowIds: 根据DataFlow ID筛选。
  • FsetIds：根据Fileset ID筛选。
  • FileSystemPath：根据Fileset在CPFS文件系统中的路径筛选。
  • SourceStorage：根据源端存储的访问路径筛选。
  • ThroughputList：根据数据流动的传输带宽筛选。
  • Description：根据Fileset的描述筛选。
  • Status：根据数据流动状态筛选。
Filters.N.Value String 否 FsetIds

筛选键的值。该参数不支持通配符。

  • Key取值为DataFlowIds时，Value取值为数据流动ID或数据流动ID的一部分。可以是一个或一组DataFlowId，数据流动ID最多可设置10个。例如，dfid-12345678或dfid-12345678,dfid-12345679。
  • 当Key取值为FsetIds时，Value取值为Fileset Id或Fileset ID的部分。可以是一个或一组Fileset ID，Fileset ID最多可设置10个。例如，fset-12345678或fset-12345678,fset-12345679。
  • 当Key取值为FileSystemPath时，Value取值为Fileset在CPFS文件系统中的路径或路径的一部分。长度为2~1024个英文或中文字符。请您使用UTF-8编码。
  • 当Key取值为SourceStorage时，Value取值为源端存储的访问路径或访问路径的一部分。长度为8~128个英文字符。请您使用UTF-8编码并符合OSS Bucket的命名规范。
  • 当Key取值为ThroughputList时，Value取值为数据流动的传输带宽且支持组合查询。
  • 当Key取值为Description时，Value取值为数据流动的描述或描述的一部分。
  • 当Key取值为Status时，Value取值为数据流动状态。

返回数据

名称类型示例值描述
名称 类型 示例值 描述
RequestId String 2D69A58F-345C-4FDE-88E4-BF518948****

请求ID。
NextToken String TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=

当请求的返回结果被截断时，您可以使用NextToken再次发起请求，获取从当前截断位置之后的内容。
DataFlowInfo Array of DataFlow

数据流动信息合集。
DataFlow
FileSystemId String cpfs-12345678

文件系统ID。
DataFlowId String dfid-123456

数据流动ID。
FsetId String fset-123456

Fileset ID。
Status String Running

数据流动状态。包括：

  • Starting：数据流动正在创建或启动中。
  • Running：数据流动已创建完成，正常运行中。
  • Updating：数据流动正在发生修改，例如提升传输带宽、修改自动更新间隔时间。
  • Deleting：数据流动删除中。
  • Stopping：数据流动停止中。
  • Stopped：数据流动已停止。
  • Misconfigured：数据流动配置异常，例如源端存储无法访问，传输带宽过低无法完成自动更新。
ErrorMessage String 无

错误信息。包括：

  • 无（默认值）：表示该数据流动状态正常。
  • SourceStorageUnreachable：未查询到源端存储的访问路径。
  • ThroughputTooLow：数据流动带宽过低。
SourceStorage String oss://bucket1

源端存储的访问路径。格式：<storage type>://<path>。

其中：

  • storage type：目前只支持OSS。
  • path：OSS的bucket名称。
    • 仅支持小写字母、数字和短划线（-）且必须以小写字母或者数字开头和结尾。
    • 长度为8~128个英文字符。
    • 使用UTF-8编码。
    • 不能以http://和https://开头。
说明
OSS Bucket必须为在该地域已存在的Bucket。
SourceSecurityType String SSL

源端存储的安全保护类型，如果源端存储必须通过安全保护访问，请指定源端存储的安全保护类型。取值：

  • 无（默认值）：表示源端存储不需要通过安全保护方式访问。
  • SSL：通过SSL证书保护访问。
Throughput Long 600

数据流动的传输带宽上限，单位：MB/s 。取值：

  • 600
  • 1200
  • 1500
说明
数据流动的传输带宽必须小于文件系统的IO带宽。
Description String Bucket01数据流动

数据流动的描述。

限制：

  • 长度为2~128个英文或中文字符。
  • 必须以大小写字母或中文开头，不能以http://和https://开头。
  • 可以包含数字、半角冒号（:）、下划线（_）或者短划线（-）。
CreateTime String 2021-09-30T10:08:08Z

Fileset的创建时间。

执行ISO8601标准表示，返回格式：yyyy-MM-ddTHH:mm:ssZ。

UpdateTime String 2021-09-30T10:08:08Z

Fileset的最近一次更新时间。

执行ISO8601标准表示，返回格式：yyyy-MM-ddTHH:mm:ssZ。

AutoRefresh Array of AutoRefresh

自动更新策略信息集合。
AutoRefresh
RefreshPath String /prefix1/prefix2/

自动更新目录，CPFS仅自动检查该目录下的源端数据是否发生更新并自动导入更新的数据。

限制：

  • 长度为2~1024个字符。
  • 使用UTF-8编码。
  • 必须以/开头和结尾。
说明
该目录必须是CPFS上的已有目录，且必须位于开启了数据流动的Fileset中。
FileSystemPath String /a/b/c/

Fileset在CPFS文件系统中的路径。

限制：

  • 长度为2~1024个英文或中文字符。
  • 使用UTF-8编码。
  • 必须以/开头和结尾。
  • 该目录必须是CPFS上的Fileset目录。
FsetDescription String 自动更新01

自动更新的描述。
AutoRefreshInterval Long 10

自动更新间隔时间。每隔该时间间隔，CPFS会检查目录内是否存在数据更新，如果有数据更新，启动自动更新任务。单位：分钟。

取值范围：5~526600。默认值：10。
AutoRefreshPolicy String None

自动更新策略，源端数据更新以后，数据更新导入到CPFS的策略。包括：

  • None：源端的数据更新不自动导入CPFS，用户可通过数据流动任务导入源端的数据更新。
  • ImportChanged：源端的数据更新自动导入CPFS。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeDataFlows
&FileSystemId=cpfs-12345678
&Filters=[{"Key":"FsetIds","Value":"FsetIds"}]
&NextToken=TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=
&MaxResults=20
&公共请求参数

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDataFlowsResponse>
    <RequestId>2D69A58F-345C-4FDE-88E4-BF518948****</RequestId>
    <NextToken>TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=</NextToken>
    <DataFlowInfo>
        <DataFlow>
            <FileSystemId>cpfs-12345678</FileSystemId>
            <DataFlowId>dfid-123456</DataFlowId>
            <FsetId>fset-123456</FsetId>
            <Status>Running</Status>
            <SourceStorage>oss://bucket1</SourceStorage>
            <SourceSecurityType>SSL</SourceSecurityType>
            <Throughput>600</Throughput>
            <Description>Bucket01数据流动</Description>
            <CreateTime>2021-09-30T10:08:08Z</CreateTime>
            <UpdateTime>2021-09-30T10:08:08Z</UpdateTime>
            <AutoRefresh>
                <AutoRefresh>
                    <RefreshPath>/prefix1/prefix2/</RefreshPath>
                </AutoRefresh>
            </AutoRefresh>
            <FileSystemPath>/a/b/c/</FileSystemPath>
            <FsetDescription>自动更新01</FsetDescription>
            <AutoRefreshInterval>10</AutoRefreshInterval>
            <AutoRefreshPolicy>None</AutoRefreshPolicy>
        </DataFlow>
    </DataFlowInfo>
</DescribeDataFlowsResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "2D69A58F-345C-4FDE-88E4-BF518948****",
  "NextToken" : "TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=",
  "DataFlowInfo" : {
    "DataFlow" : [ {
      "FileSystemId" : "cpfs-12345678",
      "DataFlowId" : "dfid-123456",
      "FsetId" : "fset-123456",
      "Status" : "Running",
      "SourceStorage" : "oss://bucket1",
      "SourceSecurityType" : "SSL",
      "Throughput" : 600,
      "Description" : "Bucket01数据流动",
      "CreateTime" : "2021-09-30T10:08:08Z",
      "UpdateTime" : "2021-09-30T10:08:08Z",
      "AutoRefresh" : {
        "AutoRefresh" : [ {
          "RefreshPath" : "/prefix1/prefix2/"
        } ]
      },
      "FileSystemPath" : "/a/b/c/",
      "FsetDescription" : "自动更新01",
      "AutoRefreshInterval" : 10,
      "AutoRefreshPolicy" : "None"
    } ]
  }
}

错误码

HttpCode错误码错误信息描述
HttpCode 错误码 错误信息 描述
400 IllegalCharacters The parameter contains illegal characters. 参数非法。
400 MissingFileSystemId FileSystemId is mandatory for this action. 未指定FileSystemId参数。
403 OperationDenied.NotSupported The operation is denied due to not supported. 文件系统不支持协议机服务。
404 InvalidFilterValue The specified parameter Filter.1.Value is invalid. Filter.1.Value值非法。
404 InvalidFileSystem.NotFound The specified file system does not exist. 指定的文件系统不存在。
404 InvalidParameter.InvalidNextToken The specified NextToken is invaild. 指定的NextToken非法。
404 InvalidFilterParam The specified Filter.N.Key is invalid. 指定的Filter.N.Key参数非法。
404 InvalidParameter.InvalidMaxResults The specified MaxResults is invalid. 指定的MaxResults非法。

访问错误中心查看更多错误码。