All Products
Search

This Product

    Cloud Parallel File Storage:CancelDataFlowAutoRefresh

    Document Center

    Cloud Parallel File Storage:CancelDataFlowAutoRefresh

    Last Updated:Oct 26, 2026

    Cancels the auto-update configuration of a specified data flow.

    Operation description

    • This operation is applicable only to Cloud Parallel File Storage (CPFS) file systems.

    • Data flows are supported only in CPFS 2.2.0 and later. You can view the version information on the file system details page in the console.

    • You can cancel the auto-update configuration only for data flows in the Running or Stopped state.

    • Canceling the auto-update configuration typically takes 2 to 5 minutes. You can call the DescribeDataFlows operation to query the status of the cancel task.

    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: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 data flow.

    df-194433a5be31****
    RefreshPath

    string

    Yes

    The directory for which you want to cancel the auto-update configuration.

    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 already exist in the CPFS file system and must be located in a Fileset for which the data flow feature is enabled.

    /prefix1/prefix2/
    DryRun

    boolean

    No

    Specifies whether to perform a dry run on this request.

    A dry run checks parameter validity and resource availability. It does not actually perform the operation or incur fees.

    Valid values:

    • true: performs a dry run without performing the operation. The system checks whether required parameters are specified, whether the request format is valid, and whether business limits are met. If the request fails the dry run, an error is returned. If the request passes the dry run, HTTP status code 200 is returned, but DataFlowId is empty.

    • false (default): sends a regular request. If the request passes the check, the operation is performed.

    false
    ClientToken

    string

    No

    The client token that is used to ensure the idempotence of the request. You can generate the value on your client and ensure that the value is unique across different requests.

    The client token can contain only ASCII characters and cannot exceed 64 characters in length. 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 client token. The RequestId of each API request may be different.

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

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The ID of the request.

    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.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.
    404 InvalidRefreshPath.InvalidParameter Refresh path is invalid. The path of the specified auto-refresh directory is invalid.
    404 InvalidRefreshPath.NotFound Refresh path does not exist. The specified auto-refresh directory does not exist.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.