400
SFS.TURBO.0100
diff --git a/docs/sfs/api-ref/ExpandShare.html b/docs/sfs/api-ref/ExpandShare.html new file mode 100644 index 00000000..89f6e3af --- /dev/null +++ b/docs/sfs/api-ref/ExpandShare.html @@ -0,0 +1,193 @@ + + +Expanding the Capacity of a File System
+Querying Permission Rules of a File System
+Function
This API is used to query the permission rules of a file system.
+URI
GET /v1/{project_id}/sfs-turbo/shares/{share_id}/fs/perm-rules
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID + |
+
share_id + |
+Yes + |
+String + |
+File system ID + |
+
Request Parameters
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
X-Auth-Token + |
+Yes + |
+String + |
+Account token + |
+
Content-Type + |
+Yes + |
+String + |
+MIME type + |
+
Response Parameters
Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
rules + |
+Array of OnePermRuleResponseInfo objects + |
+Permission rule information + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
id + |
+String + |
+Permission rule ID + |
+
ip_cidr + |
+String + |
+IP address or IP address range of the authorized object + |
+
rw_type + |
+String + |
+Read/write permission of the authorized object. +
|
+
user_type + |
+String + |
+File system access permission granted to the user of the authorized object. Supported values are: +
|
+
Status code: 500
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
errCode + |
+String + |
+Error code +Minimum: 8 +Maximum: 36 + |
+
errMsg + |
+String + |
+Error description +Minimum: 2 +Maximum: 512 + |
+
Example Requests
Querying the permission rules of the file system whose ID is 77ba6f4b-6365-4895-8dda-bc7142af4dde
+GET HTTPS://{endpoint}/v1/{project_id}/sfs-turbo/shares/77ba6f4b-6365-4895-8dda-bc7142af4dde/fs/perm-rules
+Example Responses
Status code: 200
+Successful query
+{
+ "rules" : [ {
+ "id" : "1131ed520xxxxxxebedb6e57xxxxxxxx",
+ "ip_cidr" : "192.168.0.0/16",
+ "rw_type" : "rw",
+ "user_type" : "no_root_squash"
+ }, {
+ "id" : "1231ed520xxxxxxebedb6e57xxxxxxxx",
+ "ip_cidr" : "192.32.0.0/16",
+ "rw_type" : "rw",
+ "user_type" : "no_root_squash"
+ } ]
+}
+Status code: 500
+Error response
+{
+ "errCode" : "SFS.TURBO.0005",
+ "errMsg" : "Internal server error"
+}
+Status Codes
+Status Code + |
+Description + |
+
|---|---|
200 + |
+Successful query + |
+
500 + |
+Error response + |
+
Error Codes
See Error Codes.
+Querying Tags of All File Systems of a Tenant
+Function
This API is used to query the tags of all file systems of a tenant.
+Request Parameters
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
X-Auth-Token + |
+Yes + |
+String + |
+Account token + |
+
Content-Type + |
+Yes + |
+String + |
+MIME type + |
+
Response Parameters
Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
tags + |
+Array of Tag objects + |
+Tag list + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
key + |
+String + |
+Tag key. +A key can contain a maximum of 128 characters and cannot be left blank. +Minimum: 1 +Maximum: 128 + |
+
values + |
+Array of strings + |
+Tag values. Each value can contain a maximum of 255 characters. An empty list of values can match with any value. All values of a tag key are in the OR relationship. +Minimum: 0 +Maximum: 255 + |
+
Example Requests
Query tags of all file systems in the project whose ID is e1e45b08f3ea4480ab4655ef9c7160ba
+GET HTTPS://{endpoint}/v1/e1e45b08f3ea4480ab4655ef9c7160ba/sfs-turbo/tags
+Example Responses
Status code: 200
+Response body for querying a file system
+{
+ "tags" : [ {
+ "key" : "key1",
+ "values" : [ "value1", "" ]
+ }, {
+ "key" : "key2",
+ "values" : [ "value1", "value2" ]
+ } ]
+}
+Status Codes
+Status Code + |
+Description + |
+
|---|---|
200 + |
+Response body for querying a file system + |
+
Error Codes
See Error Codes.
+Obtaining the File System List
+Querying Details About a Task
+Function
This API is used to query the execution status of an SFS Turbo asynchronous task. For example, you can query the task execution status using the jobId returned after you call the API for creating and binding the LDAP configuration.
+URI
GET /v1/{project_id}/sfs-turbo/jobs/{job_id}
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID + |
+
job_id + |
+Yes + |
+String + |
+job ID + |
+
Request Parameters
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
X-Auth-Token + |
+Yes + |
+String + |
+Account token + |
+
Content-Type + |
+Yes + |
+String + |
+MIME type + |
+
Response Parameters
Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
X-request-id + |
+String + |
+Request ID + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
status + |
+String + |
+Task status, which can be success, running, failed, or waiting +Enumeration values: +
|
+
job_id + |
+String + |
+Task ID + |
+
job_type + |
+String + |
+Task type + |
+
begin_time + |
+String + |
+Task start time in UTC format, for example, '2016-01-02 15:04:05 + |
+
end_time + |
+String + |
+Task end time in UTC format, for example, '2016-01-02 15:04:05 + |
+
error_code + |
+String + |
+Error code returned if the task execution fails + |
+
fail_reason + |
+String + |
+Cause of the task execution failure + |
+
sub_jobs + |
+Array of GetSubJobDetail objects + |
+List of subtasks + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
status + |
+String + |
+Subtask status, which can be success, running, failed, or waiting + |
+
job_id + |
+String + |
+Task ID + |
+
job_type + |
+String + |
+Subtask type + |
+
begin_time + |
+String + |
+Task start time in UTC format, for example, '2016-01-02 15:04:05 + |
+
end_time + |
+String + |
+Task end time in UTC format, for example, '2016-01-02 15:04:05 + |
+
error_code + |
+String + |
+Error code returned if the task execution fails + |
+
fail_reason + |
+String + |
+Cause of the task execution failure + |
+
Status code: 400
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
errCode + |
+String + |
+Error code +Minimum: 8 +Maximum: 36 + |
+
errMsg + |
+String + |
+Error description +Minimum: 2 +Maximum: 512 + |
+
Status code: 404
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
errCode + |
+String + |
+Error code +Minimum: 8 +Maximum: 36 + |
+
errMsg + |
+String + |
+Error description +Minimum: 2 +Maximum: 512 + |
+
Status code: 500
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
errCode + |
+String + |
+Error code +Minimum: 8 +Maximum: 36 + |
+
errMsg + |
+String + |
+Error description +Minimum: 2 +Maximum: 512 + |
+
Example Requests
None
+Example Responses
Status code: 200
+Response body parameters
+{
+ "job_id" : "26f6b565-xxxx-XXXX-xxxx-03f0bd975433",
+ "status" : "success",
+ "job_type" : "bind_ldap",
+ "begin_time" : "2023-07-26 09:33:58",
+ "end_time" : "2023-07-26 09:33:58"
+}
+Status code: 400
+Client error
+{
+ "errCode" : "SFS.TURBO.0001",
+ "errMsg" : "parameter error"
+}
+Status code: 404
+Resource not found
+{
+ "errCode" : "SFS.TURBO.0001",
+ "errMsg" : "parameter error"
+}
+Status code: 500
+Internal error
+{
+ "errCode" : "SFS.TURBO.0005",
+ "errMsg" : "Internal server error"
+}
+Status Codes
+Status Code + |
+Description + |
+
|---|---|
200 + |
+Response body parameters + |
+
400 + |
+Client error + |
+
404 + |
+Resource not found + |
+
500 + |
+Internal error + |
+
Error Codes
See Error Codes.
+Querying a Permission Rule by ID
+Function
This API is used to query a specific permission rule of a file system.
+URI
GET /v1/{project_id}/sfs-turbo/shares/{share_id}/fs/perm-rules/{rule_id}
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID + |
+
share_id + |
+Yes + |
+String + |
+File system ID + |
+
rule_id + |
+Yes + |
+String + |
+Permission rule ID + |
+
Request Parameters
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
X-Auth-Token + |
+Yes + |
+String + |
+Account token + |
+
Content-Type + |
+Yes + |
+String + |
+MIME type + |
+
Response Parameters
Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
id + |
+String + |
+Permission rule ID + |
+
ip_cidr + |
+String + |
+IP address or IP address range of the authorized object + |
+
rw_type + |
+String + |
+Read/write permission of the authorized object. +
|
+
user_type + |
+String + |
+File system access permission granted to the user of the authorized object. Supported values are: +
|
+
Status code: 400
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
errCode + |
+String + |
+Error code +Minimum: 8 +Maximum: 36 + |
+
errMsg + |
+String + |
+Error description +Minimum: 2 +Maximum: 512 + |
+
Status code: 500
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
errCode + |
+String + |
+Error code +Minimum: 8 +Maximum: 36 + |
+
errMsg + |
+String + |
+Error description +Minimum: 2 +Maximum: 512 + |
+
Example Requests
Querying details about the permission rule whose ID is 11abef677ac40f46644d1d5cfc2424a4 for the file system whose ID is 77ba6f4b-6365-4895-8dda-bc7142af4dde
+GET HTTPS://{endpoint}/v1/{project_id}/sfs-turbo/shares/77ba6f4b-6365-4895-8dda-bc7142af4dde/fs/perm-rules/11abef677ac40f46644d1d5cfc2424a4
+Example Responses
Status code: 200
+Successful query
+{
+ "id" : "1131ed520xxxxxxebedb6e57xxxxxxxx",
+ "ip_cidr" : "192.168.0.0/16",
+ "rw_type" : "rw",
+ "user_type" : "no_root_squash"
+}
+Status code: 400
+Error response
+{
+ "errCode" : "SFS.TURBO.0001",
+ "errMsg" : "Invalid rule id"
+}
+Status code: 500
+Error response
+{
+ "errCode" : "SFS.TURBO.0005",
+ "errMsg" : "Internal server error"
+}
+Status Codes
+Status Code + |
+Description + |
+
|---|---|
200 + |
+Successful query + |
+
400 + |
+Error response + |
+
500 + |
+Error response + |
+
Error Codes
See Error Codes.
+Querying Details About a File System
+Querying Tags of a File System
+Function
This API is used to query all tags of a specified file system.
+Request Parameters
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
X-Auth-Token + |
+Yes + |
+String + |
+Account token + |
+
Content-Type + |
+Yes + |
+String + |
+MIME type + |
+
Response Parameters
Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
tags + |
+Array of ResourceTag objects + |
+Tag list + |
+
sys_tags + |
+Array of ResourceTag objects + |
+Only users with the op_service permission can obtain this field. +
This field is not returned for users without the op_service permission. + |
+
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
key + |
+String + |
+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 (_). +Minimum: 1 +Maximum: 128 + |
+
value + |
+String + |
+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 (_). +Minimum: 0 +Maximum: 255 + |
+
Example Requests
Querying tags of the file system whose ID is 77ba6f4b-6365-4895-8dda-bc7142af4dde
+GET HTTPS://{endpoint}/v1/v1/{project_id}/sfs-turbo/77ba6f4b-6365-4895-8dda-bc7142af4dde/tags
+Example Responses
Status code: 200
+Response body for query all tags of a specified file system
+{
+ "tags" : [ {
+ "key" : "key1",
+ "value" : "value1"
+ }, {
+ "key" : "key2",
+ "value" : "value1"
+ } ]
+}
+Status Codes
+Status Code + |
+Description + |
+
|---|---|
200 + |
+Response body for query all tags of a specified file system + |
+
Error Codes
See Error Codes.
+Modifying a Permission Rule
+Function
This API is used to modify a permission rule.
+URI
PUT /v1/{project_id}/sfs-turbo/shares/{share_id}/fs/perm-rules/{rule_id}
+ +Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
project_id + |
+Yes + |
+String + |
+Project ID + |
+
share_id + |
+Yes + |
+String + |
+File system ID + |
+
rule_id + |
+Yes + |
+String + |
+Permission rule ID + |
+
Request Parameters
+Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
X-Auth-Token + |
+Yes + |
+String + |
+Account token + |
+
Content-Type + |
+Yes + |
+String + |
+MIME type + |
+
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
ip_cidr + |
+No + |
+String + |
+IP address or IP address range of the object to be authorized. Once configured, this parameter cannot be modified. + |
+
rw_type + |
+No + |
+String + |
+Read/write permission of the object to be authorized. +
|
+
user_type + |
+No + |
+String + |
+File system access permission granted to the user of the object to be authorized. Supported values are: +
|
+
Response Parameters
Status code: 200
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
id + |
+String + |
+Permission rule ID + |
+
ip_cidr + |
+String + |
+IP address or IP address range of the authorized object + |
+
rw_type + |
+String + |
+Read/write permission of the authorized object. +
|
+
user_type + |
+String + |
+File system access permission granted to the user of the authorized object. Supported values are: +
|
+
Status code: 400
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
errCode + |
+String + |
+Error code +Minimum: 8 +Maximum: 36 + |
+
errMsg + |
+String + |
+Error description +Minimum: 2 +Maximum: 512 + |
+
Status code: 500
+ +Parameter + |
+Type + |
+Description + |
+
|---|---|---|
errCode + |
+String + |
+Error code +Minimum: 8 +Maximum: 36 + |
+
errMsg + |
+String + |
+Error description +Minimum: 2 +Maximum: 512 + |
+
Example Requests
{
+ "rw_type" : "rw",
+ "user_type" : "no_root_squash"
+}
+Example Responses
Status code: 200
+Successful creation
+{
+ "id" : "1131ed520xxxxxxebedb6e57xxxxxxxx",
+ "ip_cidr" : "192.32.0.0/16",
+ "rw_type" : "rw",
+ "user_type" : "no_root_squash"
+}
+Status code: 400
+Error response
+{
+ "errCode" : "SFS.TURBO.0001",
+ "errMsg" : "Invalid rule id"
+}
+Status code: 500
+Error response
+{
+ "errCode" : "SFS.TURBO.0005",
+ "errMsg" : "Internal server error"
+}
+Status Codes
+Status Code + |
+Description + |
+
|---|---|
200 + |
+Successful creation + |
+
400 + |
+Error response + |
+
500 + |
+Error response + |
+
Error Codes
See Error Codes.
+Name Management
- -Changing the Name of a File System
-Function
This API is used to change the name of a file system.
-URI
POST /v1/{project_id}/sfs-turbo/shares/{share_id}/action
-Parameter - |
-Mandatory - |
-Type - |
-Description - |
-
|---|---|---|---|
project_id - |
-Yes - |
-String - |
-Specifies the project ID. - |
-
share_id - |
-Yes - |
-String - |
-Specifies the file system ID. - |
-
Request Parameters
-Parameter - |
-Mandatory - |
-Type - |
-Description - |
-
|---|---|---|---|
X-Auth-Token - |
-Yes - |
-String - |
-Specifies the account token. - |
-
Content-Type - |
-Yes - |
-String - |
-Specifies the MIME type. - |
-
Parameter - |
-Mandatory - |
-Type - |
-Description - |
-
|---|---|---|---|
change_name - |
-Yes - |
-ShareName object - |
-Specifies the SFS Turbo file system you want to change the name. - |
-
Response Parameters
None
-Example Request
{
- "change_name" : {
- "name" : "sfs-turbo-test1"
- }
-}
-Example Response
None
-Status Codes
-Status Code - |
-Description - |
-
|---|---|
204 - |
-Request successful. - |
-
400 - |
-Invalid parameters. - |
-
500 - |
-Internal error. - |
-
409 - |
-File system name already exists. - |
-
Querying Permission Rules of a File System
-Function
This API is used to query the permission rules of a file system.
-URI
GET /v1/{project_id}/sfs-turbo/shares/{share_id}/fs/perm-rules
- -Parameter - |
-Mandatory - |
-Type - |
-Description - |
-
|---|---|---|---|
project_id - |
-Yes - |
-String - |
-Project ID - |
-
share_id - |
-Yes - |
-String - |
-File system ID - |
-
Request Parameters
-Parameter - |
-Mandatory - |
-Type - |
-Description - |
-
|---|---|---|---|
X-Auth-Token - |
-Yes - |
-String - |
-Account token - |
-
Content-Type - |
-Yes - |
-String - |
-MIME type - |
-
Response Parameters
Status code: 200
- -Parameter - |
-Type - |
-Description - |
-
|---|---|---|
rules - |
-Array of Table 4 objects - |
-Permission rule information - |
-
count - |
-int - |
-Total rules - |
-
Parameter - |
-Type - |
-Description - |
-
|---|---|---|
id - |
-String - |
-Permission rule ID - |
-
ip_cidr - |
-String - |
-IP address or IP address range of the authorized object - |
-
rw_type - |
-String - |
-Read/write permission of the authorized object. The value can be rw (read and write permission), ro (read only permission), or none (no access permission). The default value is rw. - |
-
user_type - |
-String - |
-File system access permission granted to the user of the authorized object. The value can be no_root_squash, root_squash, or all_squash. Value no_root_squash allows the root user on the client to access the file system as root. Value root_squash allows the root user on the client to access the file system as nfsnobody. Value all_squash allows any user on the client to access the file system as nfsnobody. - |
-
Status code: 500
- -Parameter - |
-Type - |
-Description - |
-
|---|---|---|
errCode - |
-String - |
-Error code -Minimum length: 8 characters -Maximum length: 36 characters - |
-
errMsg - |
-String - |
-Error message -Minimum length: 2 characters -Maximum length: 512 characters - |
-
Example Request
None
-Example Response
Status code: 200
-{
- "rules": [
- {
- "id": "2be0cc3d-cf1e-49d5-bce3-83e91e32ff42",
- "ip_cidr": "*",
- "rw_type": "rw",
- "user_type": "no_root_squash"
- },
- {
- "id": "d56a5130-6744-4a64-866b-9dc259f5a64c",
- "ip_cidr": "188.88.88.88",
- "rw_type": "ro",
- "user_type": "no_root_squash"
- }
- ],
- "count": 2
-}
-Status code: 500
-Error response
-{
- "errCode" : "SFS.TURBO.0005",
- "errMsg" : "Internal server error"
-}
-Status Codes
-Status Code - |
-Description - |
-
|---|---|
200 - |
-Successful query - |
-
500 - |
-Error response - |
-
Deleting a Permissions Rule
-Function
This API is used to delete a permission rule.
-URI
DELETE /v1/{project_id}/sfs-turbo/shares/{share_id}/fs/perm-rules/{rule_id}
- -Parameter - |
-Mandatory - |
-Type - |
-Description - |
-
|---|---|---|---|
project_id - |
-Yes - |
-String - |
-Project ID - |
-
share_id - |
-Yes - |
-String - |
-File system ID - |
-
rule_id - |
-Yes - |
-String - |
-Permission rule ID - |
-
Request Parameters
-Parameter - |
-Mandatory - |
-Type - |
-Description - |
-
|---|---|---|---|
X-Auth-Token - |
-Yes - |
-String - |
-Account token - |
-
Content-Type - |
-Yes - |
-String - |
-MIME type - |
-
Response Parameters
Status code: 400
- -Parameter - |
-Type - |
-Description - |
-
|---|---|---|
errCode - |
-String - |
-Error code -Minimum length: 8 characters -Maximum length: 36 characters - |
-
errMsg - |
-String - |
-Error message -Minimum length: 2 characters -Maximum length: 512 characters - |
-
Status code: 500
- -Parameter - |
-Type - |
-Description - |
-
|---|---|---|
errCode - |
-String - |
-Error code -Minimum length: 8 characters -Maximum length: 36 characters - |
-
errMsg - |
-String - |
-Error message -Minimum length: 2 characters -Maximum length: 512 characters - |
-
Example Request
None
-Example Response
Status code: 500
-Error response
-{
- "errCode" : "SFS.TURBO.0005",
- "errMsg" : "Internal server error"
-}
-Status Codes
-Status Code - |
-Description - |
-
|---|---|
204 - |
-Successful deletion - |
-
400 - |
-Error response - |
-
500 - |
-Error response - |
-
Querying a Permission Rule by ID
-Function
This API is used to query a specific permission rule of a file system.
-URI
GET /v1/{project_id}/sfs-turbo/shares/{share_id}/fs/perm-rules/{rule_id}
- -Parameter - |
-Mandatory - |
-Type - |
-Description - |
-
|---|---|---|---|
project_id - |
-Yes - |
-String - |
-Project ID - |
-
share_id - |
-Yes - |
-String - |
-File system ID - |
-
rule_id - |
-Yes - |
-String - |
-Permission rule ID - |
-
Request Parameters
-Parameter - |
-Mandatory - |
-Type - |
-Description - |
-
|---|---|---|---|
X-Auth-Token - |
-Yes - |
-String - |
-Account token - |
-
Content-Type - |
-Yes - |
-String - |
-MIME type - |
-
Response Parameters
Status code: 200
- -Parameter - |
-Type - |
-Description - |
-
|---|---|---|
id - |
-String - |
-Permission rule ID - |
-
ip_cidr - |
-String - |
-IP address or IP address range of the authorized object - |
-
rw_type - |
-String - |
-Read/write permission of the authorized object. The value can be rw (read and write permission), ro (read only permission), or none (no access permission). The default value is rw. - |
-
user_type - |
-String - |
-File system access permission granted to the user of the authorized object. The value can be no_root_squash, root_squash, or all_squash. Value no_root_squash allows the root user on the client to access the file system as root. Value root_squash allows the root user on the client to access the file system as nfsnobody. Value all_squash allows any user on the client to access the file system as nfsnobody. - |
-
Status code: 400
- -Parameter - |
-Type - |
-Description - |
-
|---|---|---|
errCode - |
-String - |
-Error code -Minimum length: 8 characters -Maximum length: 36 characters - |
-
errMsg - |
-String - |
-Error message -Minimum length: 2 characters -Maximum length: 512 characters - |
-
Status code: 500
- -Parameter - |
-Type - |
-Description - |
-
|---|---|---|
errCode - |
-String - |
-Error code -Minimum length: 8 characters -Maximum length: 36 characters - |
-
errMsg - |
-String - |
-Error message -Minimum length: 2 characters -Maximum length: 512 characters - |
-
Example Request
None
-Example Response
{
- "ip_cidr":"188.88.88.88",
- "rw_type":"ro",
- "user_type":"no_root_squash"
-}
-Status code: 200
-Successful query
-Status code: 400
-Error response
-{
- "errCode" : "SFS.TURBO.0001",
- "errMsg" : "Invalid rule id"
-}
-Status code: 500
-Error response
-{
- "errCode" : "SFS.TURBO.0005",
- "errMsg" : "Internal server error"
-}
-Status Codes
-Status Code - |
-Description - |
-
|---|---|
200 - |
-Successful query - |
-
400 - |
-Error response - |
-
500 - |
-Error response - |
-
Modifying a Permission Rule
-Function
This API is used to modify a permission rule.
-URI
PUT /v1/{project_id}/sfs-turbo/shares/{share_id}/fs/perm-rules/{rule_id}
- -Parameter - |
-Mandatory - |
-Type - |
-Description - |
-
|---|---|---|---|
project_id - |
-Yes - |
-String - |
-Project ID - |
-
share_id - |
-Yes - |
-String - |
-File system ID - |
-
rule_id - |
-Yes - |
-String - |
-Permission rule ID - |
-
Request Parameters
-Parameter - |
-Mandatory - |
-Type - |
-Description - |
-
|---|---|---|---|
X-Auth-Token - |
-Yes - |
-String - |
-Account token - |
-
Content-Type - |
-Yes - |
-String - |
-MIME type - |
-
Parameter - |
-Mandatory - |
-Type - |
-Description - |
-
|---|---|---|---|
rw_type - |
-No - |
-String - |
-Read/write permission of the object to be authorized. The value can be rw (read and write permission), ro (read only permission), or none (no access permission). The default value is rw. - |
-
user_type - |
-No - |
-String - |
-File system access permission granted to the user of the object to be authorized. The value can be no_root_squash, root_squash, or all_squash. Value no_root_squash allows the root user on the client to access the file system as root. Value root_squash allows the root user on the client to access the file system as nfsnobody. Value all_squash allows any user on the client to access the file system as nfsnobody. - |
-
Response Parameters
Status code: 200
- -Parameter - |
-Type - |
-Description - |
-
|---|---|---|
ip_cidr - |
-String - |
-IP address or IP address range of the authorized object - |
-
rw_type - |
-String - |
-Read/write permission of the authorized object. The value can be rw (read and write permission), ro (read only permission), or none (no access permission). The default value is rw. - |
-
user_type - |
-String - |
-File system access permission granted to the user of the authorized object. The value can be no_root_squash, root_squash, or all_squash. Value no_root_squash allows the root user on the client to access the file system as root. Value root_squash allows the root user on the client to access the file system as nfsnobody. Value all_squash allows any user on the client to access the file system as nfsnobody. - |
-
Status code: 400
- -Parameter - |
-Type - |
-Description - |
-
|---|---|---|
errCode - |
-String - |
-Error code -Minimum length: 8 characters -Maximum length: 36 characters - |
-
errMsg - |
-String - |
-Error message -Minimum length: 2 characters -Maximum length: 512 characters - |
-
Status code: 500
- -Parameter - |
-Type - |
-Description - |
-
|---|---|---|
errCode - |
-String - |
-Error code -Minimum length: 8 characters -Maximum length: 36 characters - |
-
errMsg - |
-String - |
-Error message -Minimum length: 2 characters -Maximum length: 512 characters - |
-
Example Request
{
- "rw_type" : "rw",
- "user_type" : "no_root_squash"
-}
-Example Response
{
- "ip_cidr":"188.88.88.88",
- "rw_type":"ro",
- "user_type":"no_root_squash"
-}
-
-Status code: 200
-Successful modification
-Status code: 400
-Error response
-{
- "errCode" : "SFS.TURBO.0001",
- "errMsg" : "Invalid rule id"
-}
-Status code: 500
-Error response
-{
- "errCode" : "SFS.TURBO.0005",
- "errMsg" : "Internal server error"
-}
-Status Codes
-Status Code - |
-Description - |
-
|---|---|
200 - |
-Successful modification - |
-
400 - |
-Error response - |
-
500 - |
-Error response - |
-
Permissions Management
- --
-
- Creating a Permission Rule
-
- - Querying Permission Rules of a File System
-
- - Querying a Permission Rule by ID
-
- - Modifying a Permission Rule
-
- - Deleting a Permissions Rule
-
-
Creating a Permission Rule
-Function
This API is used to create a permission rule.
-URI
POST /v1/{project_id}/sfs-turbo/shares/{share_id}/fs/perm-rules
- -Parameter - |
-Mandatory - |
-Type - |
-Description - |
-
|---|---|---|---|
project_id - |
-Yes - |
-String - |
-Project ID - |
-
share_id - |
-Yes - |
-String - |
-File system ID - |
-
Request Parameters
-Parameter - |
-Mandatory - |
-Type - |
-Description - |
-
|---|---|---|---|
X-Auth-Token - |
-Yes - |
-String - |
-Account token - |
-
Content-Type - |
-Yes - |
-String - |
-MIME type - |
-
Parameter - |
-Mandatory - |
-Type - |
-Description - |
-
|---|---|---|---|
rules - |
-Yes - |
-Array of Table 4 objects - |
-Permission rule details. A maximum of five rules can be created at a time. - |
-
Parameter - |
-Mandatory - |
-Type - |
-Description - |
-
|---|---|---|---|
rw_type - |
-Yes - |
-String - |
-Read/write permission of the object to be authorized. The value can be rw (read and write permission), ro (read only permission), or none (no access permission). The default value is rw. - |
-
user_type - |
-Yes - |
-String - |
-File system access permission granted to the user of the object to be authorized. The value can be no_root_squash, root_squash, or all_squash. Value no_root_squash allows the root user on the client to access the file system as root. Value root_squash allows the root user on the client to access the file system as nfsnobody. Value all_squash allows any user on the client to access the file system as nfsnobody. - |
-
ip_cidr - |
-Yes - |
-String - |
-IP address or IP address range of the object to be authorized - |
-
Response Parameters
Status code: 200
- -Parameter - |
-Type - |
-Description - |
-
|---|---|---|
rules - |
-Array of Table 6 objects - |
-Permission rule details - |
-
Parameter - |
-Type - |
-Description - |
-
|---|---|---|
id - |
-String - |
-Permission rule ID - |
-
ip_cidr - |
-String - |
-IP address or IP address range of the authorized object - |
-
rw_type - |
-String - |
-Read/write permission of the authorized object. The value can be rw (read and write permission), ro (read only permission), or none (no access permission). The default value is rw. - |
-
user_type - |
-String - |
-File system access permission granted to the user of the authorized object. The value can be no_root_squash, root_squash, or all_squash. Value no_root_squash allows the root user on the client to access the file system as root. Value root_squash allows the root user on the client to access the file system as nfsnobody. Value all_squash allows any user on the client to access the file system as nfsnobody. - |
-
Status code: 400
- -Parameter - |
-Type - |
-Description - |
-
|---|---|---|
errCode - |
-String - |
-Error code -Minimum length: 8 characters -Maximum length: 36 characters - |
-
errMsg - |
-String - |
-Error message -Minimum length: 2 characters -Maximum length: 512 characters - |
-
Status code: 500
- -Parameter - |
-Type - |
-Description - |
-
|---|---|---|
errCode - |
-String - |
-Error code -Minimum length: 8 characters -Maximum length: 36 characters - |
-
errMsg - |
-String - |
-Error message -Minimum length: 2 characters -Maximum length: 512 characters - |
-
Example Request
{
- "rules" : [ {
- "ip_cidr" : "192.168.0.0/16",
- "rw_type" : "rw",
- "user_type" : "no_root_squash"
- }, {
- "ip_cidr" : "192.32.0.0/16",
- "rw_type" : "rw",
- "user_type" : "no_root_squash"
- } ]
-}
-Example Response
{
- "rules": [
- {
- "id": "2be0cc3d-cf1e-49d5-bce3-83e91e32ff42",
- "ip_cidr": "*",
- "rw_type": "rw",
- "user_type": "no_root_squash"
- },
- {
- "id": "d56a5130-6744-4a64-866b-9dc259f5a64c",
- "ip_cidr": "192.32.0.0/16",
- "rw_type": "ro",
- "user_type": "no_root_squash"
- }
- ],
- "count": 2
-}
-Status code: 200
-Successful creation
-Status code: 400
-Error response
-{
- "errCode" : "SFS.TURBO.0001",
- "errMsg" : "Rules not allowed empty"
-}
-Status code: 500
-Error response
-{
- "errCode" : "SFS.TURBO.0005",
- "errMsg" : "Internal server error"
-}
-Status Codes
-Status Code - |
-Description - |
-
|---|---|
200 - |
-Successful creation - |
-
400 - |
-Error response - |
-
500 - |
-Error response - |
-
Public cloud APIs comply with the RESTful API design principles. REST-based web services are organized into resources. Each resource is identified by one or more Uniform Resource Identifiers (URIs). An application accesses a resource based on the resource's Unified Resource Locator (URL). A URL is usually in the following format: https://Endpoint/uri. In the URL, uri indicates the resource path, that is, the API access path.
Public cloud APIs use HTTPS as the transmission protocol. Requests/Responses are transmitted by using JSON messages, with media type represented by Application/json.
For details about how to use APIs, see API Usage Guidelines.
+An endpoint is the request address for calling an API. Endpoints vary depending on services and regions.
+ +Service Name + |
+Region + |
+URL + |
+Protocol + |
+
|---|---|---|---|
Scalable File Service Turbo + |
+eu-de + |
+sfs-turbo.eu-de.otc.t-systems.com + |
+HTTPS + |
+
eu-nl + |
+sfs-turbo.eu-nl.otc.t-systems.com + |
+HTTPS + |
+|
Scalable File Service + |
+eu-de + |
+sfs.eu-de.otc.t-systems.com + |
+HTTPS + |
+
SFS 3.0 Capacity-Oriented + |
+eu-de + |
+sfs3.eu-de.otc.t-systems.com + |
+HTTPS + |
+
Calling APIs
+ +-
+
- Making an API Request
+
+ - Authentication
+
+ - Response
+
+
Making an API Request
+This section describes the structure of a REST API request, and uses the IAM API for obtaining a user token as an example to demonstrate how to call an API. The obtained token can then be used to authenticate the calling of other APIs.
+Request URI
A request URI is in the following format:
+{URI-scheme}://{Endpoint}/{resource-path}?{query-string}
+Although a request URI is included in the request header, most programming languages or frameworks require the request URI to be transmitted separately.
+ +Parameter + |
+Description + |
+
|---|---|
URI-scheme + |
+Protocol used to transmit requests. All APIs use HTTPS. + |
+
Endpoint + |
+Domain name or IP address of the server bearing the REST service. The endpoint varies between services in different regions. It can be obtained from Regions and Endpoints. + |
+
resource-path + |
+Access path of an API for performing a specified operation. Obtain the path from the URI of an API. For example, the resource-path of the API used to obtain a user token is /v3/auth/tokens. + |
+
query-string + |
+Query parameter, which is optional. Ensure that a question mark (?) is included before each query parameter that is in the format of Parameter name=Parameter value. For example, ? limit=10 indicates that a maximum of 10 data records will be displayed. + |
+
To simplify the URI display in this document, each API is provided only with a resource-path and a request method. The URI-scheme of all APIs is HTTPS, and the endpoints of all APIs in the same region are identical.
+Request Methods
Method + |
+Description + |
+
|---|---|
GET + |
+Requests the server to return specified resources. + |
+
PUT + |
+Requests the server to update specified resources. + |
+
POST + |
+Requests the server to add resources or perform special operations. + |
+
DELETE + |
+Requests the server to delete specified resources, for example, an object. + |
+
HEAD + |
+Same as GET except that the server must return only the response header. + |
+
PATCH + |
+Requests the server to update partial content of a specified resource. +If the resource does not exist, a new resource will be created. + |
+
For example, in the case of the API used to obtain a user token, the request method is POST. The request is as follows:
+1 | POST https://{{endpoint}}/v3/auth/tokens + |
Request Header
You can also add additional header fields to a request, such as the fields required by a specified URI or HTTP method. For example, to request for the authentication information, add Content-Type, which specifies the request body type.
+Parameter + |
+Description + |
+Mandatory + |
+Example Value + |
+
|---|---|---|---|
Host + |
+Specifies the server domain name and port number of the resources being requested. The value can be obtained from the URL of the service API. The value is in the format of Hostname:Port number. If the port number is not specified, the default port is used. The default port number for https is 443. + |
+No +This field is mandatory for AK/SK authentication. + |
+code.test.com +or +code.test.com:443 + |
+
Content-Type + |
+Specifies the type (or format) of the message body. The default value application/json is recommended. Other values of this field will be provided for specific APIs if any. + |
+Yes + |
+application/json + |
+
Content-Length + |
+Specifies the length of the request body. The unit is byte. + |
+No + |
+3495 + |
+
X-Project-Id + |
+Specifies the project ID. Obtain the project ID by following the instructions in Obtaining a Project ID. + |
+No + |
+e9993fc787d94b6c886cbaa340f9c0f4 + |
+
X-Auth-Token + |
+Specifies the user token. +It is a response to the API for obtaining a user token (This is the only API that does not require authentication). +After the request is processed, the value of X-Subject-Token in the response header is the token value. + |
+No +This field is mandatory for token authentication. + |
+The following is part of an example token: +MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ + |
+
In addition to supporting authentication using tokens, APIs support authentication using AK/SK, which uses SDKs to sign a request. During the signature, the Authorization (signature authentication) and X-Sdk-Date (time when a request is sent) headers are automatically added in the request.
+For more details, see "Authentication Using AK/SK" in Authentication.
+The API used to obtain a user token does not require authentication. Therefore, only the Content-Type field needs to be added to requests for calling the API. An example of such requests is as follows:
+1 +2 | POST https://{{endpoint}}/v3/auth/tokens +Content-Type: application/json + |
(Optional) Request Body
This part is optional. The body of a request is often sent in a structured format (for example, JSON or XML) as specified in the Content-Type header field. The request body transfers content except the request header.
+The request body varies between APIs. Some APIs do not require the request body, such as the APIs requested using the GET and DELETE methods.
+In the case of the API used to obtain a user token, the request parameters and parameter description can be obtained from the API request. The following provides an example request with a body included. Replace username, domainname, $ADMIN_PASS (login password), and xxxxxxxxxxxxxxxxxx (project name) with the actual values. Obtain a project name from Regions and Endpoints.
+ The scope parameter specifies where a token takes effect. You can set scope to an account or a project under an account. In the following example, the token takes effect only for the resources in a specified project. For more information about this API, see Obtaining a User Token.
+1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 | POST https://{{endpoint}}/v3/auth/tokens +Content-Type: application/json + +{ + "auth": { + "identity": { + "methods": [ + "password" + ], + "password": { + "user": { + "name": "username", + "password": "$ADMIN_PASS", //You are advised to store it in ciphertext in the configuration file or an environment variable and decrypt it when needed to ensure security. + "domain": { + "name": "domainname" + } + } + } + }, + "scope": { + "project": { + "name": "xxxxxxxxxxxxxxxxxx" + } + } + } +} + |
If all data required for the API request is available, you can send the request to call the API through curl, Postman, or coding. In the response to the API used to obtain a user token, X-Subject-Token is the desired user token. This token can then be used to authenticate the calling of other APIs.
+Authentication
+- AK/SK authentication: Requests are encrypted using AK/SK pairs. AK/SK authentication is recommended because it is more secure than token authentication.
- Token authentication: Requests are authenticated using tokens.
AK/SK Authentication
AK/SK authentication supports API requests with a body not larger than 12 MB. For API requests with a larger body, token authentication is recommended.
+In AK/SK authentication, AK/SK is used to sign requests and the signature is then added to the requests for authentication.
+- AK: access key ID, which is a unique identifier used in conjunction with a secret access key to sign requests cryptographically.
- SK: secret access key, which is used in conjunction with an AK to sign requests cryptographically. It identifies a request sender and prevents the request from being modified.
In AK/SK authentication, you can use an AK/SK to sign requests based on the signature algorithm or using the signing SDK.
+ The signing SDK is only used for signing requests and is different from the SDKs provided by services.
+Token Authentication
The validity period of a token is 24 hours. When using a token for authentication, cache it to prevent frequently calling the IAM API used to obtain a user token.
+A token specifies temporary permissions in a computer system. During API authentication using a token, the token is added to requests to get permissions for calling the API. You can obtain a token by calling the Obtaining User Token API.
+IMS is a project-level service. When you call the API, set auth.scope in the request body to project.
+ +{
+ "auth": {
+ "identity": {
+ "methods": [
+ "password"
+ ],
+ "password": {
+ "user": {
+ "name": "username", // IAM user name
+ "password": $ADMIN_PASS, //IAM user password. You are advised to store it in ciphertext in the configuration file or an environment variable and decrypt it when needed to ensure security.
+ "domain": {
+ "name": "domainname" // Name of the domain to which the IAM user belongs
+ }
+ }
+ }
+ },
+ "scope": {
+ "project": {
+ "name": "xxxxxxxx" // Project name
+ }
+ }
+ }
+}
+After a token is obtained, the X-Auth-Token header field must be added to requests to specify the token when calling other APIs. For example, if the token is ABCDEFJ...., X-Auth-Token: ABCDEFJ.... can be added to a request as follows:
+1 +2 +3 | POST https://{{endpoint}}/v3/auth/projects +Content-Type: application/json +X-Auth-Token: ABCDEFJ.... + |
Response
+Status Code
After sending a request, you will receive a response, including a status code, response header, and response body.
+A status code is a group of digits, ranging from 1xx to 5xx. It indicates the status of a request. For more information, see Status Codes.
+For example, if status code 201 is returned for calling the API used to , the request is successful.
+Response Header
Similar to a request, a response also has a header, for example, Content-Type.
+Figure 1 shows the response header fields for the API used to . The X-Subject-Token header field is the desired user token. This token can then be used to authenticate the calling of other APIs.
+ For security purposes, you are advised to set the token in ciphertext in configuration files or environment variables and decrypt it when using it.
+
(Optional) Response Body
The body of a response is often returned in a structured format (for example, JSON or XML) as specified in the Content-Type header field. The response body transfers content except the response header.
+The following is part of the response body for the API used to .
+If an error occurs during API calling, an error code and a message will be displayed. The following shows an error response body.
+1 +2 +3 +4 | { + "error_msg": "The request message format is invalid.", + "error_code": "IMG.0001" +} + |
In the response body, error_code is an error code, and error_msg provides information about the error.
+SFS Capacity-Oriented APIs
- +- API Version Queries
diff --git a/docs/sfs/api-ref/sfs_02_0026.html b/docs/sfs/api-ref/sfs_02_0026.html index 349a6698..f28ed12f 100644 --- a/docs/sfs/api-ref/sfs_02_0026.html +++ b/docs/sfs/api-ref/sfs_02_0026.html @@ -102,12 +102,13 @@
- Example request
{ +- Example request
Response
- Parameter description @@ -198,7 +199,7 @@
String
(Supported by API versions from v2.31 to v2.42) Specifies the ID of a consistency group. This parameter is reserved, because consistency groups are not supported currently.
+(Supported by API versions from v2.31 to v2.42.) Specifies the ID of a consistency group. This parameter is reserved, because consistency groups are not supported currently.
