CancelDataFlowAutoRefresh - Cloud Parallel File Storage - Alibaba Cloud Documentation Center

Cancels the AutoRefresh configuration for 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 cancel AutoRefresh configurations only for the dataflows that are in the Running or Stopped state.
It generally takes 2 to 5 minutes to cancel the AutoRefresh configurations. You can call the DescribeDataFlows operation to query the status of the AutoRefresh tasks.

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
nas:CancelDataFlowAutoRefresh	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****
RefreshPath	string	Yes	The directory for which you want to cancel AutoRefresh configurations. 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/
DryRun	boolean	No	Specifies whether to perform a dry run. During the dry run, the system checks whether the request parameters are valid and whether the requested resources are available. During the dry run, no file system is created and no fee is incurred. Valid values: true: performs a dry run. The system checks the request format, service limits, prerequisites, and whether the required parameters are specified. 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. No value is returned for the DataFlowld parameter. false (default): performs a dry run and sends the request. If the request passes the dry run, a file system is created.	false
ClientToken	string	No	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 value of RequestId may be different for each API request.	123e4567-e89b-12d3-a456-42665544****

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	98696EF0-1607-4E9D-B01D-F20930B6****

Examples

Sample success responses

JSONformat

{
  "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.DependencyViolation	The operation is denied due to dependancy violation.	-
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.	-
404	InvalidRefreshPath.InvalidParameter	Refresh path is invalid.	-
404	InvalidRefreshPath.NotFound	Refresh path does not exist.	-

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

Change history

Change time	Summary of changes	Operation
2024-09-05	The Error code has changed	View Change Details