All Products
Search
Document Center

File Storage NAS:ModifyFileSystem

Last Updated:Nov 07, 2024

Modifies the description of a file system.

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.

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:
    • The required resource types are displayed in bold characters.
    • 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.
OperationAccess levelResource typeCondition keyAssociated operation
nas:ModifyFileSystemupdate
  • FileSystem
    acs:nas:{#regionId}:{#accountId}:filesystem/{#filesystemId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
FileSystemIdstringYes

The ID of the file system.

  • Sample ID of a General-purpose NAS file system: 31a8e4****.
  • The IDs of Extreme NAS file systems must start with extreme-. Example: extreme-0015****.
  • The IDs of Cloud Paralleled File System (CPFS) file systems must start with cpfs-. Example: cpfs-125487****.
Note CPFS file systems are available only on the China site (aliyun.com).
1ca404****
DescriptionstringNo

The description of the file system.

Limits:

  • The description must be 2 to 128 characters in length.
  • It must start with a letter but cannot start with http:// or https://.
  • The description can contain letters, digits, colons (:), underscores (_), and hyphens (-).
NAS-test-1
OptionsobjectNo

The options.

EnableOplockbooleanNo

Specifies whether to enable the oplock feature. Valid values:

  • true: enables the feature.
  • false: disables the feature.
Note Only Server Message Block (SMB) file systems support this feature.
true

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

5BC5CB97-9F28-42FE-84A4-0CD0DF42****

Examples

Sample success responses

JSONformat

{
  "RequestId": "5BC5CB97-9F28-42FE-84A4-0CD0DF42****"
}

Error codes

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

Change history

Change timeSummary of changesOperation
2024-09-05API Description UpdateView Change Details
2024-07-08The request parameters of the API has changedView Change Details