All Products
Search
Document Center

Cloud Parallel File Storage:StartDataFlow

Last Updated:Aug 28, 2026

Enables a dataflow.

Operation description

  • 该接口仅适用于 CPFS 文件系统。

  • 仅 CPFS 2.2.0 及以上版本支持数据流动。您可以在控制台文件系统详情页面查看版本信息。

  • 只能启动Stopped(停止)状态的数据流动。

  • 当 DryRun 为true时,可校验启动该规格的数据流动的资源是否充足。如果库存资源不足,数据流动则无法启动。

  • 启动数据流动一般耗时 2~5 分钟,您可通过 DescribeDataFlows 查询数据流动状态。

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:StartDataFlow

update

*DataFlow

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

None None

Request parameters

Parameter

Type

Required

Description

Example

FileSystemId

string

Yes

The ID of the file system.

cpfs-099394bd928c****

DataFlowId

string

Yes

The ID of the dataflow.

df-194433a5be31****

DryRun

boolean

No

Whether to perform a dry run without sending the actual request.

A dry run validates request parameters and resource availability without enabling the dataflow or incurring fees.

Valid values:

  • true: performs a dry run only. 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 it passes, 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

ClientToken

string

No

A client token that ensures the idempotence of the request. You can use the client to generate the token, but the token must be unique across 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 uses the request ID as the client token. The request ID may differ for each request.

123e4567-e89b-12d3-a456-42665544****

Response elements

Element

Type

Description

Example

object

RequestId

string

The request ID.

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

Examples

Success response

JSON format

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

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.
400 MissingDataFlowId DataFlowId is mandatory for this action.
403 OperationDenied.InvalidState The operation is not permitted when the status is processing. The operation is not permitted when the status is processing.
403 OperationDenied.DependencyViolation The operation is denied due to dependancy violation.
403 OperationDenied.NoStock The operation is denied due to no stock.
403 OperationDenied.ConflictOperation The operation is denied due to a conflict with an ongoing operation.
403 OperationDenied.DataFlowNotSupported The operation is not supported.
404 InvalidFileSystem.NotFound The specified file system does not exist. The specified file system does not exist.
404 InvalidDataFlow.NotFound The specified data flow does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.