DescribeDataFlows API Reference for CPFS DataFlows - Cloud Parallel File Storage - Alibaba Cloud - Cloud Parallel File Storage

Queries the data flow information of a CPFS file system.

Operation description

Data flow is supported only by CPFS 2.2.0 and later, and CPFS for Lingjun 2.4.0 and later. You can view the version information on the file system details page in the console.
Among the filter keys in Filters, FsetIds, DataFlowIds, SourceStorage, ThroughputList, and Status require exact match, while FileSystemPath, Description, and SourceStoragePath support fuzzy match.
Combined queries are supported.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

nas:DescribeDataFlows

list

*DataFlow

acs:nas:{#regionId}:{#accountId}:filesystem/{#filesystemId}

None

Request parameters

Parameter	Type	Required	Description	Example
FileSystemId	string	Yes	The ID of the file system. CPFS: The ID must start with `cpfs-`, such as cpfs-125487**. CPFS for Lingjun: The ID must start with `bmcpfs-`, such as bmcpfs-0015**.	cpfs-099394bd928c****
Filters	array<object>	No	The filter keys used to query data flows.
	object	No
Key	string	No	The name of the filter key. Valid values: DataFlowIds: Filters data flows by data flow ID. FsetIds: Filters data flows by Fileset ID. FileSystemPath: Filters data flows by the path of the Fileset in the CPFS file system. SourceStorage: Filters data flows by the access path of the source storage. ThroughputList: Filters data flows by the transmission bandwidth. Description: Filters data flows by the description of the Fileset. Status: Filters data flows by the data flow status. Valid values: FileSystemPath : Filters data flows by the path of the Fileset in the CPFS file system. Status : Filters data flows by the data flow status. SourceStorage : Filters data flows by the access path of the source storage. Description : Filters data flows by the description of the Fileset. SourceStoragePath : Filters data flows by the access path in the source storage. ThroughputList : Filters data flows by the transmission bandwidth. DataFlowIds : Filters data flows by data flow ID. FsetIds : Filters data flows by Fileset ID.	FsetIds
Value	string	No	The value of the filter key. This parameter does not support wildcards. If Key is set to DataFlowIds, Value is set to a data flow ID or a part of a data flow ID. You can specify one or more data flow IDs. A maximum of 10 data flow IDs can be specified. Example: `df-194433a5be31**` or `df-194433a512a2,df-234533a5be31`. If Key is set to FsetIds, Value is set to a Fileset ID or a part of a Fileset ID. You can specify one or more Fileset IDs. A maximum of 10 Fileset IDs can be specified. Example: `fset-1902718ea0ae` or `fset-235718ea0ae,fset-5122718ea0ae**`. If Key is set to FileSystemPath, Value is set to a path or a part of a path in the CPFS file system. The value must be 1 to 1,024 characters in length. If Key is set to SourceStorage, Value is set to the access path of the source storage. The value can be up to 1,024 characters in length. If Key is set to ThroughputList, Value is set to the transmission bandwidth of the data flow. Combined queries are supported. If Key is set to Description, Value is set to the description or a part of the description of the data flow. If Key is set to Status, Value is set to the data flow status. If Key is set to SourceStoragePath, Value is set to the access path or a part of the access path in the source storage. The value can be up to 1,024 characters in length.	FsetIds
NextToken	string	No	The pagination token. If the returned results are truncated, you can use this token to retrieve the remaining results.	TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=
MaxResults	integer	No	The maximum number of results to return per query. Valid values: 10 to 100. Default value: 20.	20

Response elements

Element	Type	Description	Example
	object
DataFlowInfo	object
DataFlow	array<object>	The collection of data flow information.
	array<object>
AutoRefresh	object
AutoRefresh	array<object>	The collection of auto-refresh policy information. Note This feature is supported only by CPFS.
	object
RefreshPath	string	The auto-refresh directory. CPFS automatically checks whether the source data in this directory is updated and automatically imports the updated data. Limits: The value must be 2 to 1,024 characters in length. The value must be encoded in UTF-8. The value must start and end with a forward slash (/). Note The directory must be an existing directory in CPFS and must be located in a Fileset for which data flow is enabled.	/prefix1/prefix2/
AutoRefreshInterval	integer	The auto-refresh interval. CPFS checks whether data in the directory is updated at this interval. If data is updated, an auto-refresh task is started. Unit: minutes. Valid values: 5 to 526600. Default value: 10. Note This feature is supported only by CPFS.	10
AutoRefreshPolicy	string	The auto-refresh policy, which specifies how updated source data is imported to CPFS. Valid values: None: Updated source data is not automatically imported to CPFS. You can import updated source data by using data flow tasks. ImportChanged: Updated source data is automatically imported to CPFS. Note This feature is supported only by CPFS.	None
CreateTime	string	The time when the Fileset was created. The time follows the ISO 8601 standard and is returned in the `yyyy-MM-ddTHH:mm:ssZ` format. Note This feature is supported only by CPFS.	2021-09-30T10:08:08Z
DataFlowId	string	The ID of the data flow.	df-194433a5be31****
Description	string	The description of the data flow. Limits: The value must be 2 to 128 characters in length. The value must start with a letter or a Chinese character, and cannot start with `http://` or `https://`. The value can contain digits, colons (:), underscores (_), and hyphens (-).	Bucket01 data flow
ErrorMessage	string	The error message. Valid values: None (default): The data flow is in a normal state. SourceStorageUnreachable: The access path of the source storage cannot be found. ThroughputTooLow: The data flow bandwidth is too low.	SourceStorageUnreachable
FileSystemId	string	The ID of the file system.	cpfs-099394bd928c****
FileSystemPath	string	The path of the Fileset in the CPFS file system. Limits: The value must be 2 to 1,024 characters in length. The value must be encoded in UTF-8. The value must start and end with a forward slash (/). The directory must be a Fileset directory in CPFS. Note This feature is supported only by CPFS.	/a/b/c/
FsetDescription	string	The description of the auto-refresh. Note This feature is supported only by CPFS.	Auto-refresh 01
FsetId	string	The ID of the Fileset. Note This feature is supported only by CPFS.	fset-1902718ea0ae****
SourceSecurityType	string	The security protection type of the source storage. If the source storage must be accessed through security protection, specify the security protection type. Valid values: None (default): The source storage does not require security protection for access. SSL: Access is protected by an SSL certificate.	SSL
SourceStorage	string	The access path of the source storage. Format: `<storage type>://[<account id>:]<path>`. where: storage type: Only OSS is supported. account id: The UID of the account to which the source storage belongs. path: The name of the OSS bucket. The name can contain only lowercase letters, digits, and hyphens (-), and must start and end with a lowercase letter or a digit. The name must be 8 to 128 characters in length. The name must be encoded in UTF-8. The name cannot start with http:// or https://. Note The OSS bucket must exist in the current region. The account id parameter is supported only by CPFS for Lingjun 2.6.0 and later.	oss://178321033379****:bucket-01
SourceStoragePath	string	The access path in the source storage bucket. Note This feature is supported only by CPFS for Lingjun.	/prefix/
Status	string	The status of the data flow. Valid values: Starting: The data flow is being created or started. Running: The data flow is created and running normally. Updating: The data flow is being modified, such as increasing the transmission bandwidth or modifying the auto-refresh interval. Deleting: The data flow is being deleted. Stopping: The data flow is being stopped. Stopped: The data flow is stopped. Misconfigured: The data flow configuration is abnormal, such as the source storage being inaccessible or the transmission bandwidth being too low to complete the auto-refresh.	Running
Throughput	integer	The maximum transmission bandwidth of the data flow. Unit: MB/s. Valid values: 600 1200 1500 Note The transmission bandwidth of the data flow must be less than the I/O bandwidth of the file system. This feature is supported only by CPFS.	600
UpdateTime	string	The last time the Fileset was updated. The time follows the ISO 8601 standard and is returned in the `yyyy-MM-ddTHH:mm:ssZ` format. Note This feature is supported only by CPFS.	2021-09-30T10:08:08Z
NextToken	string	The pagination token. If the returned results are truncated, you can use this token to retrieve the remaining results.	TGlzdFJlc291cmNlU****mVzJjE1MTI2NjY4NzY5MTAzOTEmMiZORnI4NDhVeEtrUT0=
RequestId	string	The ID of the request.	2D69A58F-345C-4FDE-88E4-BF518948****

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalCharacters	The parameter contains illegal characters.	The parameter contains illegal characters.
400	MissingFileSystemId	FileSystemId is mandatory for this action.	The FileSystemId parameter is not specified.
400	InvalidFilesystemVersion.NotSupport	This Api does not support this fileSystem version.	This Api does not support this fileSystem version.
403	OperationDenied.DataFlowNotSupported	The operation is not supported.	The file system does not support data flows.
404	InvalidFilterValue	The specified parameter Filter.1.Value is invalid.
404	InvalidFileSystem.NotFound	The specified file system does not exist.	The specified file system does not exist.
404	InvalidFilterParam	The specified Filter.N.Key is invalid.	The specified Filter.N.Key parameter is invalid.
404	InvalidParameter.InvalidMaxResults	The specified MaxResults is invalid.	The specified MaxResults parameter is invalid.
404	InvalidParameter.InvalidNextToken	The specified NextToken is invalid.	The specified NextToken parameter is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.