Update & Validate Fileset Attributes via ModifyFileset API - Cloud Parallel File Storage - Alibaba Cloud - Cloud Parallel File Storage

Operation description

Only CPFS 2.2.0 and CPFS for Lingjun 2.7.0 or later support modifying fileset information.

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

update

*Fileset

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

None

Request parameters

Parameter	Type	Required	Description	Example
FileSystemId	string	Yes	The ID of the file system. CPFS: The ID must start with `cpfs-`. Example: cpfs-099394bd928c**. CPFS for Lingjun: The ID must start with `bmcpfs-`. Example: bmcpfs-290w65p03ok64ya**.	bmcpfs-290w65p03ok64ya****
FsetId	string	Yes	The Fileset ID.	fset-1902718ea0ae****
Description	string	No	The description of the fileset.	test
DryRun	boolean	No	Specifies whether to perform a dry run on the modification request. A dry run checks parameter validity and inventory without actually modifying the instance or incurring fees. Valid values: true: performs a dry run. The instance is not modified. The system checks whether required parameters are specified, the request format is valid, business limits are met, and NAS inventory is sufficient. If the dry run fails, the corresponding error is returned. If the dry run succeeds, HTTP status code 200 is returned. false: sends a normal request. If the check succeeds, the instance is directly modified. This is the default value.	false
DeletionProtection	boolean	No	The deletion protection property of the instance. Specifies whether the instance can be released through the console or the DeleteFileset API operation. Valid values: true: enables deletion protection for the instance. false: disables deletion protection for the instance. Note This property only restricts manual release operations and does not take effect on system release operations.	false
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can generate the value from 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 may be different for each API request.	123e4567-e89b-12d3-a456-42665544****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	2D69A58F-345C-4FDE-88E4-BF518948****

Examples

Success response

JSON format

{
  "RequestId": "2D69A58F-345C-4FDE-88E4-BF518948****"
}

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	MissingFsetId	FsetId is mandatory for this action.	The Fileset ID parameter is not specified.
400	InvalidFilesetId.NotFound	Invalid FilesetId.	Fileset does not exist
403	OperationDenied.DependencyViolation	The operation is denied due to dependancy violation.	The conditions for performing this operation are not met.
403	OperationDenied.FilesetNotSupported	The operation is not supported.	The file system does not support Fileset.
404	InvalidFileSystem.NotFound	The specified file system does not exist.	The specified file system does not exist.
404	InvalidFsetId.NotFound	The specified Fileset ID does not exist.	The specified Fileset does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.