Cloud Parallel File Storage:StopDataFlow - Cloud Parallel File Storage - Alibaba Cloud - Cloud Parallel File Storage

Operation description

This operation applies only to CPFS file systems.
Only CPFS 2.2.0 and later support data flows. You can view the version information on the file system details page in the console.
Only data flows in the Running (normal) state can be disabled.
After a data flow is disabled, you cannot create data flow tasks for the data flow. If automatic update is configured, data updates that occur on the source are not synchronized to CPFS.
After a data flow is disabled, the data flow bandwidth is no longer billed because resources are reclaimed. However, restarting the data flow may fail due to insufficient inventory.
Disabling a data flow typically takes 2 to 5 minutes. You can call DescribeDataFlows to query the data flow status.

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

update

*DataFlow

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

None

Request parameters

Parameter	Type	Required	Description	Example
FileSystemId	string	Yes	The file system ID.	cpfs-099394bd928c****
DataFlowId	string	Yes	The data flow ID.	df-194433a5be31****
DryRun	boolean	No	Specifies whether to perform a dry run on this creation request. A dry run checks the validity of parameters and inventory, but does not actually create an instance or incur fees. Valid values: true: Sends a check request. No instance is created. Checks include whether required parameters are specified, the request format, business limits, and NAS inventory. If the check fails, the corresponding error is returned. If the check succeeds, the 200 HTTP status code is returned, but FileSystemId is empty. false (default): Sends a normal request and directly creates the instance after the check succeeds.	false
ClientToken	string	No	Specifies the client token that ensures request idempotence. Generate a parameter value from your client to ensure that this parameter value is unique across different requests. The ClientToken parameter supports only ASCII characters and cannot exceed 64 characters. For more information, see How to ensure idempotence. Note If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId of each API request may be different.	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.	The FileSystemId parameter is not specified.
400	MissingDataFlowId	DataFlowId is mandatory for this action.	The DataFlowId parameter is not specified.
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.	The conditions for performing this operation are not met.
403	OperationDenied.ConflictOperation	The operation is denied due to a conflict with an ongoing operation.	The data flow cannot be created due to conflicts with current file system operations.
403	OperationDenied.DataFlowNotSupported	The operation is not supported.	The file system does not support data flow.
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.	The specified data flow does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.