Modify dataflow attributes by using ModifyDataFlow - Cloud Parallel File Storage - Alibaba Cloud - Cloud Parallel File Storage

Modifies the attributes of a data flow.

Operation description

CPFS 2.2.0 and later and CPFS for Lingjun 2.4.0 and later support data streams.
Only data streams in the Running (Normal) state can have their properties modified.
Modifying a data stream typically takes 2 to 5 minutes. You can call DescribeDataFlows to query the status of the data stream modification.
CPFS data stream specifications:
- Data stream bandwidth (Throughput) supports three specifications: 600 MB/s, 1,200 MB/s, and 1,500 MB/s. The data stream bandwidth refers to the maximum transmission bandwidth that can be achieved when the data stream imports or exports data.
- Inventory query: When you set DryRun to true, you can verify whether the resources required to modify the data stream with the specified specifications are sufficient.
CPFS billing

Modifying the data stream bandwidth (Throughput) involves data stream bandwidth billing. Familiarize yourself with the billable methods of CPFS in advance. For more details, see CPFS billing.

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

update

*DataFlow

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

None

Request parameters

Parameter	Type	Required	Description	Example
FileSystemId	string	Yes	The file system ID. CPFS: The ID must start with `cpfs-`, such as cpfs-125487**. CPFS for Lingjun: The ID must start with `bmcpfs-`, such as bmcpfs-0015**.	cpfs-099394bd928c****
DataFlowId	string	Yes	The data flow ID.	df-194433a5be31****
Description	string	No	The description of the data flow. Limits: The description must be 2 to 128 characters in length. The description must start with a letter and cannot start with http:// or https://. The description can contain digits, colons (:), underscores (_), or hyphens (-).	Bucket01DataFlow.
Throughput	integer	No	The maximum transmission bandwidth of the data flow. Unit: MB/s. Valid values: 600 1200 1500 Note The transmission bandwidth of the data flow must be less than the I/O bandwidth of the file system. This parameter is required when the file system type is CPFS. Valid values: 600 : 600 MB/s 1200 : 1200 MB/s 1500 : 1500 MB/s 2000 : 2000 MB/s	600
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 the instance or incurring fees. Valid values: true: Sends a check request without creating the 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 passes, HTTP status code 200 is returned, but FileSystemId is empty. false (default): Sends a normal request. After the check passes, the instance is directly created.	false
ClientToken	string	No	Ensures the idempotence 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 idempotence. 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.NoStock	The operation is denied due to no stock.
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.InvalidState	The operation is not permitted when the status is processing.	The operation is not permitted when the status is processing.
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	InvalidThroughput.OutOfBounds	Throughput is out of bounds.	The specified Throughput is not within the valid range.
404	InvalidDescription.InvalidFormat	Description format is invalid.	The format of the specified description is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.