Use ModifyDataFlowAutoRefresh to change a dataflow's AutoRefresh configuration - Cloud Parallel File Storage - Alibaba Cloud - Cloud Parallel File Storage

Modifies the automatic update configuration of a dataflow.

Operation description

This operation applies only to Cloud Parallel File Storage (CPFS) file systems.
Only CPFS 2.2.0 and later support dataflows. You can view the version information on the file system details page in the console.
You can modify the automatic update configuration only for dataflows in the Running or Stopped state.
Modifying the automatic update configuration typically takes 2 to 5 minutes. You can call DescribeDataFlows to query the status of the automatic update task modification.

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

update

*FileSystem

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 dataflow ID.	df-194433a5be31****
AutoRefreshPolicy	string	No	The automatic update policy. This policy specifies how data updates from the source are imported to CPFS after the source data is updated. Valid values: None: Data updates from the source are not automatically imported to CPFS. You can import source data updates by using a dataflow task. ImportChanged: Data updates from the source are automatically imported to CPFS. Valid values: ImportChanged : Data updates from the source are automatically imported to CPFS. None : Data updates from the source are not automatically imported to CPFS. You can import source data updates by using a dataflow task.	None
AutoRefreshInterval	integer	No	The automatic update interval. CPFS checks the directory for data updates at each interval. If data updates exist, an automatic update task is started. Unit: minutes. Valid values: 5 to 526600. Default value: 10.	10
DryRun	boolean	No	Specifies whether to perform a dry run for this request. A dry run checks parameter validity and resource availability without actually creating an instance or incurring fees. Valid values: true: Sends a dry run request without creating an instance. The check items 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, HTTP status code 200 is returned, but FileSystemId is empty. false (default): Sends a normal request. After the check succeeds, the instance is directly created.	false
ClientToken	string	No	Ensures the idempotency of the request. Generate a parameter value from your client to ensure that the value is unique across different requests. ClientToken supports only ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotency. Note If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId may differ for each API 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.	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 this operation are not met.
403	OperationDenied.ConflictOperation	The operation is denied due to a conflict with an ongoing operation.	The dataflow cannot be created because it conflicts with the current file system operation.
403	OperationDenied.DataFlowNotSupported	The operation is not supported.	The file system does not support dataflow.
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 dataflow does not exist.
404	InvalidRefreshPolicy.InvalidParameter	Refresh policy is invalid.	The auto-update policy is invalid.
404	InvalidRefreshInterval.OutOfBounds	Refresh interval is out of bounds.	The specified RefreshInterval is not within the valid range.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.