All Products
Search
Document Center

Cloud Parallel File Storage:StartDataFlow

Last Updated:Dec 03, 2025

Enables a dataflow.

Operation description

  • This operation is available only to Cloud Parallel File Storage (CPFS) file systems.
  • Only CPFS V2.2.0 and later support data flows. You can view the version information on the file system details page in the console.
  • You can enable the data flows that are only in the Stopped state.
  • If the value of DryRun is true, you can check whether sufficient resources are available to enable the specified data flow. If the resources are insufficient, the data flow cannot be enabled.
  • It generally takes 2 to 5 minutes to enable a data flow. You can query the data flow status by calling the DescribeDataFlows operation.

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:StartDataFlowupdate
*DataFlow
acs:nas:{#regionId}:{#accountId}:filesystem/{#filesystemId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
FileSystemIdstringYes

The ID of the file system.

cpfs-099394bd928c****
DataFlowIdstringYes

The ID of the dataflow.

df-194433a5be31****
DryRunbooleanNo

Specifies whether to perform only a dry run, without performing the actual request.

During the dry run, the system checks whether the request parameters are valid and whether the requested resources are available. The dry run does not enable the specified dataflow or incur fees.

Valid values:

  • true: performs only a dry run. The system checks the required parameters, request syntax, service limits, and available NAS resources. If the request fails the dry run, an error message is returned. If the request passes the dry run, the HTTP status code 200 is returned.
  • false (default): performs a dry run and sends the request. If the request passes the dry run, the specified dataflow is enabled.
false
ClientTokenstringNo

The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests.

The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see How do I ensure the idempotence?

Note If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID may be different for each request.
123e4567-e89b-12d3-a456-42665544****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

98696EF0-1607-4E9D-B01D-F20930B6****

Examples

Sample success responses

JSONformat

{
  "RequestId": "98696EF0-1607-4E9D-B01D-F20930B6****"
}

Error codes

HTTP status codeError codeError messageDescription
400IllegalCharactersThe parameter contains illegal characters.The parameter contains illegal characters.
400MissingFileSystemIdFileSystemId is mandatory for this action.-
400MissingDataFlowIdDataFlowId is mandatory for this action.-
403OperationDenied.InvalidStateThe operation is not permitted when the status is processing.The operation is not permitted when the status is processing.
403OperationDenied.DependencyViolationThe operation is denied due to dependancy violation.-
403OperationDenied.NoStockThe operation is denied due to no stock.-
403OperationDenied.ConflictOperationThe operation is denied due to a conflict with an ongoing operation.-
403OperationDenied.DataFlowNotSupportedThe operation is not supported.-
404InvalidFileSystem.NotFoundThe specified file system does not exist.The specified file system does not exist.
404InvalidDataFlow.NotFoundThe specified data flow does not exist.-

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

Change history

Change timeSummary of changesOperation
2024-09-05The Error code has changedView Change Details