This API is used to batch add tags for a specified file system.
+This API is used to batch add tags to a file system.
A maximum of 20 tags can be added to a file system.
Tag keys added to the same file system must be unique.
This API is idempotent. If the file system already has the key you want to add, the tag will be updated.
@@ -24,7 +24,7 @@String
Project ID
+The project ID.
share_id
@@ -33,7 +33,7 @@String
File system ID
+The file system ID.
String
Account token
+The account token.
Content-Type
@@ -66,7 +66,7 @@String
MIME type
+The MIME type.
String
Operation identifier. The value is create. Use create if you want to batch add tags to a file system.
+The operation identifier. The value is create. Use create if you want to batch add tags to a file system.
+Enumeration values:
+create
+tags
No
+Yes
Array of ResourceTag objects
Tag list.
-This field is mandatory for users. For users with the op_service permission, choose either this field or sys_tags.
-sys_tags
-No
-Array of ResourceTag objects
-System tag list.
-This field is available only to users with the op_service permission. Choose either this field or tags. Only one resource_tag structure key, _sys_enterprise_project_id, is used in TMS calls.
+The list of tags.
String
Tag key.
+The tag key.
It can contain a maximum of 128 characters.
It cannot be left empty and cannot contain the following characters: ASCII (0-31), equal signs (=), asterisks (*), left angle brackets (<), right angle brackets (>), backslashes (), commas (,), vertical bars (|), and slashes (/). It can contain only letters, digits, hyphens (-), and underscores (_).
String
Tag value.
+The tag value.
Each tag value can contain a maximum of 255 characters and can be an empty string.
It cannot contain the following characters: ASCII (0-31), equal signs (=), asterisks (*), left angle brackets (<), right angle brackets (>), backslashes (), commas (,), vertical bars (|), and slashes (/). It can contain only letters, digits, hyphens (-), and underscores (_).
None
+Status code: 204
+Batch adding tags succeeded
+None
Batch adding tags for a file system, with tag key of the first tag set to key1, tag value of the first tag value1, tag key of the second tag key2, and tag value of the second tag value1
+Batch adding tags to a file system, with tag key of the first tag set to key1, tag value of the first tag value1, tag key of the second tag key2, and tag value of the second tag value1
{
"action" : "create",
"tags" : [ {
@@ -177,7 +171,7 @@
204
File system tags added.
+Batch adding tags succeeded
Changing the Security Group Associated with a File System
-Function
This API is used to change the security group associated with an SFS Turbo file system. Security group change is an asynchronous task. You can check whether the security group is changed based on the value of sub_status returned after calling the API to query details of a file system. If value 232 is returned, the security group has been changed.
+Function
This API is used to change the security group associated with an SFS Turbo file system. Changing the security group is an asynchronous task. You can call the API for querying details of a file system and view the value of sub_status returned to check whether the security group change is successful. If value 232 is returned, the security group has been changed.
URI
POST /v1/{project_id}/sfs-turbo/shares/{share_id}/action
@@ -21,7 +21,7 @@
String
Project ID
+The project ID.
share_id
@@ -30,7 +30,7 @@
String
File system ID
+The file system ID.
String
Account token
+The account token.
Content-Type
@@ -63,7 +63,7 @@
String
MIME type
+The MIME type.
ChangeSecurityGroup object
Object of change_security_group
+The change_security_group object.
String
ID of the security group to be changed
+The ID of the new security group.
String
ID of the SFS Turbo file system
+The SFS Turbo file system ID.
Example Requests
Changing the security group of a file system (target security group ID 26f6b565-240e-43c3-8867-03f0bd975433)
+Example Requests
Changing the security group of a file system (new security group ID 26f6b565-240e-43c3-8867-03f0bd975433)
{
"change_security_group" : {
"security_group_id" : "26f6b565-240e-43c3-8867-03f0bd975433"
@@ -145,7 +145,7 @@
}
Example Responses
Status code: 202
-ID of the SFS Turbo file system
+The SFS Turbo file system ID.
{
"id" : "67d4bd5e-7b2f-4c24-9a0b-c0038940c6f8"
}
@@ -159,7 +159,7 @@
202
ID of the SFS Turbo file system
+The SFS Turbo file system ID.
Changing the Name of a File System
-Function
This API is used to change the name of an SFS Turbo file system.
+Function
This API is used to change the name of a file system.
-Response Parameters
None
+Response Parameters
Status code: 204
+Successful request
+None
Example Requests
Changing the name of an SFS Turbo file system to sfs-turbo-test1
{
@@ -136,17 +138,17 @@
204
Request successful
+Successful request
400
Invalid parameter
+Incorrect parameter
409
The file system name already exists.
+File system name already exists
500
diff --git a/docs/sfs/api-ref/CreatePermRule.html b/docs/sfs/api-ref/CreatePermRule.html
index 090b6899d..be6cb4d74 100644
--- a/docs/sfs/api-ref/CreatePermRule.html
+++ b/docs/sfs/api-ref/CreatePermRule.html
@@ -3,7 +3,8 @@
Creating a Permission Rule
Function
This API is used to create a permission rule.
-Constraints
A maximum of 64 permissions rules can be configured for a file system.
+Constraints
A maximum of 64 permission rules can be added for a file system.
+This API is only supported for NFS file systems.
URI
POST /v1/{project_id}/sfs-turbo/shares/{share_id}/fs/perm-rules
@@ -23,7 +24,7 @@
String
Project ID
+The project ID.
share_id
@@ -32,7 +33,7 @@
String
File system ID
+The file system ID.
String
Account token
+The account token.
Content-Type
@@ -65,7 +66,7 @@
String
MIME type
+The MIME type.
Array of OnePermRuleRequestInfo objects
Permission rule details. A maximum of five rules can be created at a time.
+The permission rule details. You can add a maximum of five rules at a time.
ip_cidr
No
+Yes
String
IP address or IP address range of the object to be authorized. Once configured, this parameter cannot be modified.
+The IP address or IP address range of the object to be authorized. Once configured, this parameter cannot be modified.
rw_type
No
+Yes
String
Read/write permission of the object to be authorized.
+The read/write permission of the object to be authorized.
rw: read and write permission, which is the default option
ro: read-only permission
none: no permission
@@ -129,14 +130,14 @@
user_type
No
+Yes
String
System user's permission to access the file system. The value can be any of the following:
-no_root_squash: default option. The client uses any user, including the root user. The NFS server retains the user used by the client and does not map the user.
-root_squash: When the client uses the root user, the user mapped to the NFS server is the NFS anonymous user (nfsnobody). If the client uses a non-root user, the NFS server retains the user used by the client and does not map the user.
-all_squash: All users of clients that access the NFS server are mapped as anonymous users.
+The file system access permission granted to the user of the object to be authorized. The value can be:
+no_root_squash: allows any user including root on the client to access the file system as who they are, instead of mapping them to another user.
+root_squash: allows root on the client to access the file system as nfsnobody. Client access using a non-root user will be retained as who they are, instead of being mapped to another user.
+all_squash: allows any user on the client to access the file system as nfsnobody.
Array of OnePermRuleResponseInfo objects
Permission rule details
+The permission rule information.
String
Permission rule ID
+The permission rule ID.
ip_cidr
String
IP address or IP address range of the authorized object
+The IP address or IP address range of the authorized object. It cannot be modified after configuration.
rw_type
String
Read/write permission of the authorized object.
+The read/write permission of the authorized object.
rw: read and write permission, which is the default option
ro: read-only permission
none: no permission
@@ -202,10 +203,10 @@
String
File system access permission granted to the user of the authorized object. Supported values are:
-no_root_squash: allows the root user on the client to access the file system as root.
-root_squash: allows the root user on the client to access the file system as nfsnobody.
-all_squash: allows any user on the client to access the file system as nfsnobody. It is the default value.
+The file system access permission granted to the user of the authorized object. The value can be:
+no_root_squash (default value): allows any user including root on the client to access the file system as who they are, instead of mapping them to another user.
+root_squash: allows root on the client to access the file system as nfsnobody and allows a non-root user on the client to access as who they are, instead of being mapped to another user.
+all_squash: allows any user on the client to access the file system as nfsnobody.
String
Error code
+The error code.
errMsg
String
Error description
+The error message.
String
Error code
+The error code.
errMsg
String
Error description
+The error message.
-Example Requests
{
+Example Requests
Request example for creating permission rules
+{
"rules" : [ {
"ip_cidr" : "192.168.xx.xx/16",
"rw_type" : "rw",
@@ -278,9 +280,11 @@
"user_type" : "no_root_squash"
} ]
}
+
Example Responses
Status code: 200
Successful creation
+Response example for creating permission rules
{
"rules" : [ {
"id" : "1131ed520xxxxxxebedb6e57xxxxxxxx",
@@ -294,6 +298,7 @@
"user_type" : "no_root_squash"
} ]
}
+
Status code: 400
Error response
{
diff --git a/docs/sfs/api-ref/CreateShare.html b/docs/sfs/api-ref/CreateShare.html
index 0cea9e665..765910f5a 100644
--- a/docs/sfs/api-ref/CreateShare.html
+++ b/docs/sfs/api-ref/CreateShare.html
@@ -1,332 +1,348 @@
Creating a File System
-