All Products
Search

This Product

    Cloud Parallel File Storage:DescribeDataFlows

    Document Center

    Cloud Parallel File Storage:DescribeDataFlows

    Last Updated:Jan 26, 2026

    Queries the dataflows of a CPFS file system.

    Operation description

    • Only Cloud Parallel File Storage (CPFS) V2.2.0 and later and CPFS for Lingjun V2.4.0 and later support dataflows. You can view the version information on the file system details page in the console.
    • In Filters, FsetIds, DataFlowlds, SourceStorage, ThroughputList, and Status support exact match only. FileSystemPath, Description, and SourceStoragePath support fuzzy match.
    • Combined query is supported.

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • For mandatory resource types, indicate with a prefix of * .
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    nas:DescribeDataFlowslist
    *DataFlow
    acs:nas:{#regionId}:{#accountId}:filesystem/{#filesystemId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    FileSystemIdstringYes

    The ID of the file system.

    • The IDs of CPFS file systems must start with cpfs-. Example: cpfs-125487****.
    • The IDs of CPFS for Lingjun file systems must start with bmcpfs-. Example: bmcpfs-0015****.
    		bmcpfs-290w65p03ok64ya****
    Filtersarray<object>No

    The filter that is used to query dataflows.

    objectNo
    KeystringNo

    The filter name. Valid value:

    • DataFlowIds: filters dataflow tasks by dataflow ID.
    • FsetIds: filters dataflows by fileset ID.
    • FileSystemPath: filters dataflows based on the path of a fileset in a CPFS file system.
    • SourceStorage: filters dataflows based on the access path of the source storage.
    • ThroughputList: filters dataflows based on dataflow throughput.
    • Description: filters dataflows based on the fileset description.
    • Status: filters dataflows based on dataflow status.
    		FsetIds
    ValuestringNo

    The value of the filter. This parameter does not support wildcards.

    • If Key is set to DataFlowIds, set Value to a dataflow ID or a part of the dataflow ID. You can specify a dataflow ID or a group of dataflow IDs. You can specify a maximum of 10 dataflow IDs. Example: df-194433a5be31**** or df-194433a512a2****,df-234533a5be31****.
    • If Key is set to FsetIds, set Value to a fileset ID or a part of the fileset ID. You can specify a fileset ID or a group of fileset IDs. You can specify a maximum of 10 fileset IDs. For example, fset-1902718ea0ae**** or fset-235718ea0ae****,fset-5122718ea0ae****.
    • If Key is set to FileSystemPath, set Value to the path or a part of the path of a fileset in a CPFS file system. The value of the parameter must be 1 to 1,024 characters in length.
    • If Key is set to SourceStorage, set Value to the access path or a part of the access path of the source storage. The path can be up to 1,024 characters in length.
    • If Key is set to ThroughputList, set Value to the dataflow throughput. Combined query is supported.
    • If Key is set to Description, set Value to a dataflow description or a part of the dataflow description.
    • If Key is set to Status, set Value to the dataflow status.
    • If Key is set to SourceStoragePath, set Value to the access path or a part of the access path of the source storage. The path can be up to 1,024 characters in length.
    		FsetIds
    NextTokenstringNo

    The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextToken.

    		TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=
    MaxResultslongNo

    The number of results for each query.

    Valid values: 10 to 100. Default value: 20.

    		20

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The request ID.

    		2D69A58F-345C-4FDE-88E4-BF518948****
    NextTokenstring

    A pagination token. It can be used in the next request to retrieve a new page of results.

    		TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=
    DataFlowInfoarray<object>

    The dataflow details.

    DataFlowobject
    FileSystemIdstring

    The ID of the file system.

    		cpfs-099394bd928c****
    DataFlowIdstring

    The ID of the dataflow.

    		df-194433a5be31****
    FsetIdstring

    The fileset ID.

    Note Only CPFS supports this parameter.
    		fset-1902718ea0ae****
    Statusstring

    The dataflow status. The following information is displayed:

    • Starting: The dataflow is being created or enabled.
    • Running: The dataflow has been created and is running properly.
    • Updating: The dataflow is being modified. For example, the dataflow throughput is increased and the automatic update interval is modified.
    • Deleting: The dataflow is being deleted.
    • Stopping: The dataflow is being disabled.
    • Stopped: The dataflow has been disabled.
    • Misconfigured: The dataflow configuration is abnormal. For example, the source storage is inaccessible, and the automatic update cannot be completed due to low dataflow throughput.
    		Running
    ErrorMessagestring

    The error message. Valid values:

    • None (default): The dataflow status is normal.
    • SourceStorageUnreachable: The access path of the source storage is not found.
    • ThroughputTooLow: The dataflow throughput is low.
    		SourceStorageUnreachable
    SourceStoragestring

    The access path of the source storage. Format: <storage type>://[<account id>:]<path>.

    Among them:

    • storage type: Only OSS is supported.

    • account id: The UID of the account of the source storage.

    • path: The name of the OSS bucket.

      • The name can contain only lowercase letters, digits, and hyphens (-). The name must start and end with a lowercase letter or digit.
      • The name must be 8 to 128 characters in length.
      • Must be encoded in UTF-8.
      • The name cannot start with http:// or https://.
    Note

    • The OSS bucket must be an existing bucket in the region.

    • Only CPFS for Lingjun V2.6.0 and later support the account id parameter.

    		oss://bucket1
    SourceSecurityTypestring

    The type of security mechanism for the source storage. This parameter must be specified if the source storage is accessed with a security mechanism. Valid value:

    • Null (default): The OSS bucket can be accessed without a security mechanism.
    • SSL: The source storage must be accessed with an SSL certificate.
    		SSL
    Throughputlong

    The maximum dataflow throughput. Unit: MB/s. Valid value:

    • 600
    • 1200
    • 1500
    Note

    • The dataflow throughput must be less than the I/O throughput of the file system.

    • Only CPFS supports this parameter.

    		600
    Descriptionstring

    The description of the dataflow.

    Limits:

    • The name must be 2 to 128 characters in length and
    • start with a letter but cannot start with http:// or https://.
    • The name can contain digits, letters, colons (:), underscores (_), and hyphens (-).
    		test
    CreateTimestring

    The time when the fileset was created.

    The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format.

    Note Only CPFS supports this parameter.
    		2021-09-30T10:08:08Z
    UpdateTimestring

    The time when the fileset was last updated.

    The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format.

    Note Only CPFS supports this parameter.
    		2021-09-30T10:08:08Z
    AutoRefresharray<object>

    The details about automatic update policies.

    Note Only CPFS supports this parameter.
    AutoRefreshobject
    RefreshPathstring

    The automatic update directory. CPFS automatically checks whether the source data only in the directory is updated and imports the updated data.

    Limits:

    • The directory must be 2 to 1,024 characters in length.
    • The directory must be encoded in UTF-8.
    • The directory must start and end with a forward slash (/).
    Note The directory must be an existing directory in the CPFS file system and must be in a fileset where the dataflow is enabled.
    		/prefix1/prefix2/
    FileSystemPathstring

    The directory of the fileset in the CPFS file system.

    Limits:

    • The directory must be 2 to 1024 characters in length.
    • The directory must be encoded in UTF-8.
    • The directory must start and end with a forward slash (/).
    • The directory must be a fileset directory in the CPFS file system.
    Note Only CPFS is supported.
    		/a/b/c/
    FsetDescriptionstring

    The description of the automatic update.

    Note Only CPFS supports this parameter.
    		FsetTest
    AutoRefreshIntervallong

    The automatic update interval. CPFS checks whether data is updated in the directory at the interval specified by this parameter. If data is updated, CPFS starts an automatic update task. Unit: minutes.

    Valid values: 5 to 526600. Default value: 10.

    Note Only CPFS supports this parameter.
    		10
    AutoRefreshPolicystring

    The automatic update policy. The updated data in the source storage is imported into the CPFS file system based on the policy. The following information is displayed:

    • None: Updated data in the source storage is not automatically imported into the CPFS file system. You can run a dataflow task to import the updated data from the source storage.
    • ImportChanged: Updated data in the source storage is automatically imported into the CPFS file system.
    Note Only CPFS is supported.
    		None
    SourceStoragePathstring

    The access path in the bucket of the source storage.

    Note Only CPFS for Lingjun supports this parameter.
    		/prefix/

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "2D69A58F-345C-4FDE-88E4-BF518948****",
  "NextToken": "TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=",
  "DataFlowInfo": {
    "DataFlow": [
      {
        "FileSystemId": "cpfs-099394bd928c****\n",
        "DataFlowId": "df-194433a5be31****\n",
        "FsetId": "fset-1902718ea0ae****",
        "Status": "Running",
        "ErrorMessage": "SourceStorageUnreachable",
        "SourceStorage": "oss://bucket1",
        "SourceSecurityType": "SSL",
        "Throughput": 600,
        "Description": "test",
        "CreateTime": "2021-09-30T10:08:08Z",
        "UpdateTime": "2021-09-30T10:08:08Z",
        "AutoRefresh": {
          "AutoRefresh": [
            {
              "RefreshPath": "/prefix1/prefix2/"
            }
          ]
        },
        "FileSystemPath": "/a/b/c/",
        "FsetDescription": "FsetTest",
        "AutoRefreshInterval": 10,
        "AutoRefreshPolicy": "None",
        "SourceStoragePath": "/prefix/\n"
      }
    ]
  }
}

    Error codes

    HTTP status codeError codeError messageDescription
    400IllegalCharactersThe parameter contains illegal characters.The parameter contains illegal characters.
    400MissingFileSystemIdFileSystemId is mandatory for this action.-
    400InvalidFilesystemVersion.NotSupportThis Api does not support this fileSystem version.This Api does not support this fileSystem version.
    403OperationDenied.DataFlowNotSupportedThe operation is not supported.-
    404InvalidFilterValueThe specified parameter Filter.1.Value is invalid.The specified parameter Filter.1.Value is invalid.
    404InvalidFileSystem.NotFoundThe specified file system does not exist.The specified file system does not exist.
    404InvalidFilterParamThe specified Filter.N.Key is invalid.-
    404InvalidParameter.InvalidMaxResultsThe specified MaxResults is invalid.-
    404InvalidParameter.InvalidNextTokenThe specified NextToken is invalid.-

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2024-09-14The Error code has changedView Change Details
    2024-09-05The Error code has changedView Change Details
    2024-02-29The Error code has changed. The response structure of the API has changedView Change Details