Status Code |
@@ -14,7 +14,7 @@
||||||
|---|---|---|---|---|---|---|
400 + | ||||||
400/404 |
SFS.TURBO.0001 |
@@ -25,13 +25,13 @@
Use valid parameters and try again. |
||||
404 + | ||||||
400/404 |
SFS.TURBO.0002 |
Cluster not found |
-The requested object does not exist or you do not have permissions to access it. + | The requested object is not found or you do not have permissions to access it. |
Use valid parameters and try again. |
@@ -58,7 +58,7 @@
Use valid parameters and try again. |
500 + | ||||||
400/500 |
SFS.TURBO.0005 |
@@ -102,7 +102,7 @@
Use valid parameters and try again. |
||||
400 + | ||||||
409 |
SFS.TURBO.0009 |
@@ -124,7 +124,7 @@
Submit a service order to increase quota. |
||||
400 + | ||||||
400/403 |
SFS.TURBO.0011 |
@@ -135,6 +135,17 @@
Wait until that operation is complete and try again. |
||||
400 + |
+SFS.TURBO.0015 + |
+do not have the operation permission + |
+Insufficient permissions. + |
+Apply for the required permissions. + |
+||
400 |
SFS.TURBO.0016 @@ -168,6 +179,61 @@ | Use valid parameters and try again. |
||||
404 + |
+SFS.TURBO.0019 + |
+Invalid Job Id + |
+Invalid job ID. + |
+Use a valid job ID. + |
+||
400 + |
+SFS.TURBO.0020 + |
+Invalid flavor + |
+Invalid flavor. + |
+Use a valid flavor. + |
+||
400 + |
+SFS.TURBO.0021 + |
+file system not match + |
+Unmatched type. The background disk type is not supported by this file system type. + |
+Ensure that the background disk type is supported by the file system type. + |
+||
400 + |
+SFS.TURBO.0022 + |
+backup name already exists + |
+The backup name already exists. + |
+Change the backup name. + |
+||
400 + |
+SFS.TURBO.0023 + |
+Invalid flavor ref + |
+Invalid specification code. + |
+Use a valid specification code. + |
+||
400 |
SFS.TURBO.0024 @@ -245,6 +311,248 @@ | Change the AZ and try again. |
||||
400 + |
+SFS.TURBO.0031 + |
+cache type not exist + |
+The cache type is not found. + |
+Use a valid cache type. + |
+||
400 + |
+SFS.TURBO.0032 + |
+EVS Resource Not Enough + |
+Insufficient EVS resources. + |
+Enlarge EVS resources. + |
+||
500 + |
+SFS.TURBO.0033 + |
+Get Client Ips Error + |
+Failed to obtain client IP addresses. + |
+Try again. If the fault persists, contact technical support. + |
+||
400 + |
+SFS.TURBO.0034 + |
+dedicated storage resource not enough + |
+Insufficient resources in the dedicated storage pool. + |
+Expand the storage pool. + |
+||
400 + |
+SFS.TURBO.0035 + |
+The current type does not support backup. + |
+Unsupported type for backup. + |
+Unsupported type for backup. + |
+||
500 + |
+SFS.TURBO.0036 + |
+Failed to obtain the used capacity of the directory + |
+Failed to obtain the used capacity of the directory. + |
+Try again. If the fault persists, contact technical support. + |
+||
400 + |
+SFS.TURBO.0037 + |
+Operation conflict, client retry + |
+Operation conflict. + |
+Try again with valid operations. + |
+||
400 + |
+SFS.TURBO.0038 + |
+unknown error + |
+Unknown error. + |
+Contact technical support. + |
+||
400 + |
+SFS.TURBO.0039 + |
+The VIP quota is insufficient + |
+Insufficient virtual IP address quota. + |
+Apply for a higher quota. + |
+||
400 + |
+SFS.TURBO.0040 + |
+Insufficient Security Group Quota + |
+Insufficient security group quota. + |
+Apply for a higher quota. + |
+||
400 + |
+SFS.TURBO.0100 + |
+Invalid file system path + |
+Invalid file system path. + |
+Use a valid file system path. + |
+||
404 + |
+SFS.TURBO.0101 + |
+The file system path does not exist + |
+The file system path is not found. + |
+Select a valid file system path. + |
+||
400 + |
+SFS.TURBO.0102 + |
+The file system path is not a directory + |
+The file system path is not a directory. + |
+Select a valid file system path. + |
+||
400 + |
+SFS.TURBO.0103 + |
+The file system is being processed + |
+The file system is being processed. + |
+Wait until the processing is complete. + |
+||
500 + |
+SFS.TURBO.0104 + |
+Failed to import or export OBS data + |
+Failed to import or export OBS data. + |
+Try again. If the fault persists, contact technical support. + |
+||
500 + |
+SFS.TURBO.0105 + |
+Failed to obtain OBS import and export task data + |
+Failed to obtain the OBS import and export data. + |
+Try again. If the fault persists, contact technical support. + |
+||
400 + |
+SFS.TURBO.0106 + |
+The OBS task does not exist + |
+The OBS task is not found. + |
+Select an existing OBS task or create an OBS task. + |
+||
400 + |
+SFS.TURBO.0107 + |
+OBS protocol error + |
+Backend parameter type is incorrectly configured. + |
+Contact technical support. + |
+||
400 + |
+SFS.TURBO.0108 + |
+The OBS endpoint name is incorrect + |
+Incorrect OBS domain name. + |
+Contact technical support. + |
+||
400 + |
+SFS.TURBO.0109 + |
+The OBS bucket name is incorrect + |
+Incorrect OBS bucket name. + |
+Use the correct OBS bucket name. + |
+||
400 + |
+SFS.TURBO.0110 + |
+OBS agent error + |
+The import or export task failed. + |
+Contact technical support. + |
+||
400 + |
+SFS.TURBO.0111 + |
+The OBS configuration list is empty + |
+The OBS configuration list is empty. + |
+Use valid OBS configuration information. + |
+
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. + |
+
API Usage Guidelines
-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 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.
SFS APIs
+SFS Capacity-Oriented APIs
API Version Querying
+API Version Queries
- Querying All API Versions
- - Querying Details About API Versions
+ - Querying Details About an API Version
Array of objects
Specifies the share links. For details, see the description of the links field.
+Specifies the links of shared file systems. For details, see the description of the links field.
media-types
@@ -283,7 +283,7 @@Querying Details About API Versions
-Function
This API is used for querying details about API versions.
+Querying Details About an API Version
+Function
This API is used for querying details about an API version.
URI
- GET /{api_version}/
- Parameter description
Parameter
@@ -33,19 +33,19 @@Response
- Parameter description
-
Parameter
+Parameter
Type
+Type
Description
+Description
versions
+versions
Object
+Object
List objects of all available API versions
+List objects of all available API versions
Array of objects
Specifies the share links. For details, see the description of the links field.
+Specifies the links of shared file systems. For details, see the description of the links field.
media-types
@@ -300,7 +300,7 @@diff --git a/docs/sfs/api-ref/sfs_02_0020.html b/docs/sfs/api-ref/sfs_02_0020.html index a3cd35e30..3d2fe9fe7 100644 --- a/docs/sfs/api-ref/sfs_02_0020.html +++ b/docs/sfs/api-ref/sfs_02_0020.html @@ -1,6 +1,6 @@ --Parent topic: API Version Querying+Parent topic: API Version QueriesFile Sharing
+File Systems
diff --git a/docs/sfs/api-ref/sfs_02_0021.html b/docs/sfs/api-ref/sfs_02_0021.html index 9389fb836..f84cc6dff 100644 --- a/docs/sfs/api-ref/sfs_02_0021.html +++ b/docs/sfs/api-ref/sfs_02_0021.html @@ -4,15 +4,15 @@-
@@ -21,7 +21,7 @@
-Parent topic: SFS APIs+Parent topic: SFS Capacity-Oriented APIsFunction
This API is used to create a shared file system. After the file system is created, you need to mount the file system to ECSs to achieve shared file storage.
-
This API is an asynchronous API. If the returned status code is 200, the API request is successfully delivered and received. Later, you can query the status and path of the shared file system by referring to Querying Details About a Shared File System to identify whether the creation is complete and successful. If the status of the shared file system becomes available or the shared path is generated, the creation is successful.
After a shared file system is created successfully, it can be used only after you add share access rules by referring to Adding Share Access Rules.
+ After a shared file system is created successfully, it can be used only after you add share access rules by referring to Adding a File System Access Rule.
URI
- POST /v2/{project_id}/shares
- Parameter description
Parameter
Mandatory
+Mandatory
Type
+Type
Description
project_id
Yes
+Yes
String
+String
Specifies the project ID of the operator.
Request
- Parameter description
-
Parameter
Mandatory
+Mandatory
Type
+Type
Description
share
Yes
+Yes
Object
+Object
For details, see the description of the share field.
String
Specifies the file system sharing protocol. The valid value can be NFS (for Linux OS) or CIFS (for Windows OS).
+Specifies the file sharing protocol. The value can be NFS (for Linux OS).
size
@@ -135,45 +135,46 @@ - Description of metadata fields (creating a shared file system with the encryption function)When creating a shared file system with the encryption function, obtain the key ID, domain ID, and key alias of the encryption key using the HTTPS request by referring to section Querying the List of CMKs in the Key Management Service API Reference. Then, in the metadata field, set the key-value pairs according to the following table. Ensure that the key-value pairs in the metadata field are correct. -
Key
+- Description of metadata fields (creating a shared file system with the encryption function)
When creating a shared file system with the encryption function, obtain the key ID, domain ID, and key alias of the encryption key using the HTTPS request by referring to section Querying the List of CMKs in the Key Management Service API Reference. Then, in the metadata field, set the key-value pairs according to the following table. Ensure that the key-value pairs in the metadata field are correct.
+To create a shared file system with the encryption function, all parameters in the following table are mandatory. If the encryption function is not needed, these parameters are optional. +-Key
Value Type
+Value Type
Mandatory
+Mandatory
Description
+Description
#sfs_crypt_key_id
+#sfs_crypt_key_id
String
+String
Yes
+Yes
Specifies the encryption key ID.
+Specifies the encryption key ID.
If this field, #sfs_crypt_domain_id, and #sfs_crypt_alias exist at the same time, the data encryption function is enabled.
#sfs_crypt_domain_id
+#sfs_crypt_domain_id
String
+String
Yes
+Yes
Specifies the tenant domain ID.
-If this field, #sfs_crypt_key_id, and #sfs_crypt_alias exist at the same time, the data encryption function is enabled.
+Specifies the tenant domain ID.
+If this field, #sfs_crypt_key_id, and #sfs_crypt_alias exist at the same time, the data encryption function is enabled.
#sfs_crypt_alias
+#sfs_crypt_alias
String
+String
Yes
+Yes
Specifies the encryption key alias.
-If this field, #sfs_crypt_key_id, and #sfs_crypt_domain_id exist at the same time, the data encryption function is enabled.
+Specifies the encryption key alias.
+If this field, #sfs_crypt_key_id, and #sfs_crypt_domain_id exist at the same time, the data encryption function is enabled.
- Example request: POST https://{endpoint}/v2/16e1ab15c35a457e9c2b2aa189f544e1/shares
{ "share": { - "share_type": null, "name": "test", - "snapshot_id": null, "description": "test description", "share_proto": "NFS", "share_network_id": null, @@ -199,9 +198,7 @@- Example request (creating a shared file system with data encryption function): POST https://{endpoint}/v2/16e1ab15c35a457e9c2b2aa189f544e1/shares
{ "share": { - "share_type": null, "name": "test", - "snapshot_id": null, "description": "test description", "metadata": { "#sfs_crypt_key_id": "9130c90d-73b8-4203-b790-d49f98d503df", @@ -234,7 +231,7 @@
- Example request (creating a shared file system with data encryption function): POST https://{endpoint}/v2/16e1ab15c35a457e9c2b2aa189f544e1/shares
- Description of the share field +
- Description of the share field
Parameter
Type
@@ -289,7 +286,7 @@Object
Sets one or more metadata key and value pairs as a dictionary of strings. share_used is the key, and the corresponding value is the used capacity of the shared file system in the unit of Bytes.
+Sets one or more metadata key and value pairs as a dictionary of strings. The value of the share_used key indicates the file system used capacity, in bytes.
status
@@ -352,7 +349,7 @@String
Specifies the ID of the share type.
+Specifies the ID of the file system type.
volume_type
@@ -380,7 +377,7 @@Boolean
Specifies the visibility level of the shared file system. If it is set to true, the file system can be seen publicly. If it is set to false, the file system can be seen privately. The default value is false.
+Specifies the visibility level of the shared file system. If true is returned, the file system can be seen publicly. If false is returned, the file system can be seen privately. The default value is false.
user_id
@@ -486,6 +483,11 @@The request could not be processed due to a conflict.
413 Quota Exceeded
+Insufficient user quota.
+500 Internal Server Error
Failed to complete the request because of an internal service error.
@@ -519,7 +521,7 @@diff --git a/docs/sfs/api-ref/sfs_02_0022.html b/docs/sfs/api-ref/sfs_02_0022.html index 796946a8c..5a45cf5d9 100644 --- a/docs/sfs/api-ref/sfs_02_0022.html +++ b/docs/sfs/api-ref/sfs_02_0022.html @@ -66,7 +66,7 @@-Parent topic: File Sharing+Parent topic: File SystemsInteger
Specifies the offset to define the start point from 0 of shared file system listing. The value must be greater than or equal to 0.
+Specifies the offset to define the start point of shared file system listing. The value must be greater than or equal to 0.
sort_key
@@ -111,7 +111,7 @@String
Specifies the field used for filtering based on the ID of the mount path. This field is supported by API v2.35 and later versions.
+Specifies the field used for filtering based on the ID of the mount location. This field is supported by API v2.35 and later versions.
export_location_path
@@ -120,7 +120,7 @@String
Specifies the field used for filtering based on the mount path. This field is supported by API v2.35 and later versions.
+Specifies the field used for filtering based on the mount location. This field is supported by API v2.35 and later versions.
name~
@@ -327,7 +327,7 @@diff --git a/docs/sfs/api-ref/sfs_02_0023.html b/docs/sfs/api-ref/sfs_02_0023.html index 36b349a7c..7a16b8d74 100644 --- a/docs/sfs/api-ref/sfs_02_0023.html +++ b/docs/sfs/api-ref/sfs_02_0023.html @@ -110,7 +110,7 @@-Parent topic: File Sharing+Parent topic: File SystemsString
Specifies the field used for filtering based on the ID of the mount path. This field is supported by API v2.35 and later versions.
+Specifies the field used for filtering based on the ID of the mount location. This field is supported by API v2.35 and later versions.
export_location_path
@@ -119,7 +119,7 @@String
Specifies the field used for filtering based on the mount path. This field is supported by API v2.35 and later versions.
+Specifies the field used for filtering based on the mount location. This field is supported by API v2.35 and later versions.
name
@@ -150,19 +150,19 @@Response
- Parameter description
-
Parameter
+Parameter
Type
+Type
Description
+Description
shares
+shares
Array of objects
+Array of objects
Specifies the list of share objects.
+Specifies the list of the share objects.
Object
Sets one or more metadata key and value pairs as a dictionary of strings. share_used is the key, and the corresponding value is the used capacity of the shared file system in the unit of Bytes.
+Sets one or more metadata key and value pairs as a dictionary of strings. The value of the share_used key indicates the file system used capacity, in bytes.
status
@@ -335,7 +335,7 @@String
Specifies the ID of the share type.
+Specifies the ID of the file system type.
volume_type
@@ -363,7 +363,7 @@Boolean
Specifies the visibility level of the shared file system. If it is set to true, the file system can be seen publicly. If it is set to false, the file system can be seen privately. The default value is false.
+Specifies the visibility level of the shared file system. If true is returned, the file system can be seen publicly. If false is returned, the file system can be seen privately. The default value is false.
source_share_group_snapshot_member_id
@@ -429,8 +429,8 @@ "project_id": "da0f615c35eb4d72812d1547a77b5394", "metadata": { - "share_used": "1048576000000" - }, + "share_used": "1048576000000", + }, "status": "available", "description": "test description", "export_locations": ["sfs.dong.com:/share-e1c2d35e"], @@ -531,7 +531,7 @@diff --git a/docs/sfs/api-ref/sfs_02_0024.html b/docs/sfs/api-ref/sfs_02_0024.html index b324a115c..d12191661 100644 --- a/docs/sfs/api-ref/sfs_02_0024.html +++ b/docs/sfs/api-ref/sfs_02_0024.html @@ -54,7 +54,7 @@-Parent topic: File Sharing+Parent topic: File SystemsObject
Specifies the share object.
+Specifies the share objects.
Object
Sets one or more metadata key and value pairs as a dictionary of strings. share_used is the key, and the corresponding value is the used capacity of the shared file system in the unit of Bytes.
+Sets one or more metadata key and value pairs as a dictionary of strings. The value of the share_used key indicates the file system used capacity, in bytes.
status
@@ -227,7 +227,7 @@String
Specifies the ID of the share type.
+Specifies the ID of the file system type.
volume_type
@@ -255,7 +255,7 @@Boolean
Specifies the visibility level of the shared file system. If it is set to true, the file system can be seen publicly. If it is set to false, the file system can be seen privately. The default value is false.
+Specifies the visibility level of the shared file system. If true is returned, the file system can be seen publicly. If false is returned, the file system can be seen privately. The default value is false.
source_share_group_snapshot_member_id
@@ -431,7 +431,7 @@diff --git a/docs/sfs/api-ref/sfs_02_0025.html b/docs/sfs/api-ref/sfs_02_0025.html index 65ff11980..dd4548c2e 100644 --- a/docs/sfs/api-ref/sfs_02_0025.html +++ b/docs/sfs/api-ref/sfs_02_0025.html @@ -44,19 +44,19 @@-Parent topic: File Sharing+Parent topic: File SystemsResponse
- Parameter description
-
Parameter
+-Parameter
Type
+Type
Description
+Description
export_locations
+export_locations
Array of strings
+Array of strings
Specifies the list of export locations.
+Specifies the export_location objects.
String
Specifies the path to which the shared file system will be mounted.
+Specifies the path that will be used when the shared file system is mounted.
is_admin_only
@@ -110,26 +110,16 @@- Example response
-CIFS share:
{ - "export_locations": [ - { - "path": "\\\\sfs-nas1.dong.com\\share-4e76e627", - "id": "85eb5849-1a89-43ae-99ac-2e781514a228", - "preferred": false - } - ] -}-
diff --git a/docs/sfs/api-ref/sfs_02_0026.html b/docs/sfs/api-ref/sfs_02_0026.html index d8231d7a6..349a6698f 100644 --- a/docs/sfs/api-ref/sfs_02_0026.html +++ b/docs/sfs/api-ref/sfs_02_0026.html @@ -54,48 +54,48 @@-Parent topic: File Sharing+Parent topic: File SystemsObject
Specifies the share object.
+Specifies the share objects.
- Example response
-
- Description of the share field
-
Parameter
+Parameter
Mandatory
+Mandatory
Type
+Type
Description
+Description
display_name
+display_name
No
+No
String
+String
Specifies the new name of the shared file system. The value consists of 0 to 255 characters.
+Specifies the new name of the shared file system. The value consists of 0 to 255 characters.
display_description
+display_description
No
+No
String
+String
Describes the shared file system. The value contains 0 to 255 characters.
+Describes the shared file system. The value contains 0 to 255 characters.
is_public
+is_public
No
+No
Boolean
+Boolean
(Supported by API v2.8 and later versions.) Specifies whether a file system can be publicly seen. If it is set to true, the file system can be seen publicly. If it is set to false, the file system can be seen privately. The default value is false.
+(Supported by API v2.8 and later versions.) Specifies whether a file system can be publicly seen. If it is set to true, the file system can be seen publicly. If it is set to false, the file system can be seen privately. The default value is false.
-Response
- Parameter description
-
Parameter
+-Parameter
Type
+Type
Description
+Description
share
+share
Object
+Object
Specifies the share object.
+Specifies the share objects.
String
Specifies the ID of the share network. This parameter is reserved, because share network management is not supported currently.
+Specifies the ID of the share network. This parameter is reserved, because share network management is not supported currently.
snapshot_id
@@ -212,7 +212,7 @@Object
Sets one or more metadata key and value pairs as a dictionary of strings. share_used is the key, and the corresponding value is the used capacity of the shared file system in the unit of Bytes.
+Sets one or more metadata key and value pairs as a dictionary of strings. The value of the share_used key indicates the file system used capacity, in bytes.
status
@@ -303,7 +303,7 @@String
Specifies the ID of the share type.
+Specifies the ID of the file system type.
export_locations
@@ -500,7 +500,7 @@diff --git a/docs/sfs/api-ref/sfs_02_0027.html b/docs/sfs/api-ref/sfs_02_0027.html index a055785eb..049fcaadb 100644 --- a/docs/sfs/api-ref/sfs_02_0027.html +++ b/docs/sfs/api-ref/sfs_02_0027.html @@ -132,7 +132,7 @@-Parent topic: File Sharing+Parent topic: File Systemsdiff --git a/docs/sfs/api-ref/sfs_02_0028.html b/docs/sfs/api-ref/sfs_02_0028.html index 09ccce653..dcb86de4c 100644 --- a/docs/sfs/api-ref/sfs_02_0028.html +++ b/docs/sfs/api-ref/sfs_02_0028.html @@ -1,19 +1,19 @@ --Parent topic: File Sharing+Parent topic: File SystemsShare Access Rules
+File System Access Rules
diff --git a/docs/sfs/api-ref/sfs_02_0029.html b/docs/sfs/api-ref/sfs_02_0029.html index a6f81fec6..85b0e5dce 100644 --- a/docs/sfs/api-ref/sfs_02_0029.html +++ b/docs/sfs/api-ref/sfs_02_0029.html @@ -1,8 +1,8 @@ --
-
- Adding Share Access Rules
+ - Adding a File System Access Rule
- - Deleting Share Access Rules
+ - Deleting a File System Access Rule
- - Querying Share Access Rules
+ - Querying File System Access Rules
-Parent topic: SFS APIs+Parent topic: SFS Capacity-Oriented APIsAdding Share Access Rules
-Function
This API is used to add share access rules.
- - This API is an asynchronous API. If the returned status code is 200, the API request is successfully delivered and received. Later, you can refer to Querying Share Access Rules to check whether the share access rule is added successfully.
- APIs whose microversions are from 2.28 to 2.42 can ignore error statuses of existing share access rules during rule adding. The microversions of APIs are specified by using the X-Openstack-Manila-Api-Version parameter in the request headers.
Adding a File System Access Rule
+Function
This API is used to add a file system access rule.
+ - This API is an asynchronous API. If the returned status code is 200, the API request is successfully delivered and received. Later, you can refer to Querying File System Access Rules to check whether the access rule is added successfully.
- APIs whose microversions are from 2.28 to 2.42 can ignore error statuses of existing access rules during rule adding. API microversions are specified by using the X-Openstack-Manila-Api-Version parameter in the request headers.
URI
- POST /v2/{project_id}/shares/{share_id}/action?vpc_ip_base_acl={vpc_ip_base_acl}
- Parameter description @@ -40,8 +40,8 @@
String
Specifies the identifier of the IP address-based authorization scenario. Currently, only enable is available. The value enable indicates creating a share access rule for the IP address-based authorization scenario.
-NOTICE:To ensure compatibility, even though this parameter is left blank or set to another value other than enable, you can use the API to create a share access rule for the IP address-based authorization scenario. However, this method of creation has been discarded and will not be maintained in the future.
+Specifies the identifier used with IP address-based authorization. Currently, only enable is available, which indicates that an access rule used with IP address-based authorization will be created.
+NOTICE:To ensure compatibility, if this parameter is left blank or set to a value other than enable, you can still use this API to create an access rule used with IP address-based authorization. However, this method of creation has been discarded and will not be maintained in the future.
Object
Specifies the os-allow_access object.
+Specifies the os-allow_access objects.
String
Specifies the access level of the shared file system. Possible values are ro (read-only) and rw (read-write). The default value is rw (read/write).
+Specifies the access level of the file system. Possible values are ro (read-only) and rw (read-write). The default value is rw (read-write).
access_type
@@ -101,7 +101,10 @@String
Specifies the storage access mode. For an SFS Capacity-Oriented file system, the value is cert indicating that the certificate is used to access storage.
+Specifies the storage access method.
+- If the NFS protocol is used, specify cert.
- If multiple protocols are used, specify cert.
Note
+- Value user indicates storage access using username.
- Value cert indicates storage access using VPC ID and IP address.
access_to
@@ -110,10 +113,12 @@String
Specifies the value that defines the access rule. The value contains 1 to 255 characters. The value varies according to the scenario:
-- Enter the VPC ID in VPC authorization scenarios.
- Set this parameter in IP address authorization scenario.
- Enter the value in the format of VPC ID#IP address#priority#user permission for an NFS shared file system, for example, 0157b53f-4974-4e80-91c9-098532bcaf00#2.2.2.2/16#100#all_squash,root_squash.
Specifies the value that defines the access rule. The value varies with the scenario:
+If access_type is set to user, specify AK for this parameter.
+If access_type is set to cert:+- In VPC-based authorization scenarios, specify the VPC ID for this parameter.
- In IP address-based authorization scenarios:
- For an NFS file system, specify the value in the format of VPC ID#IP address#priority#user permission, for example, 0157b53f-4974-4e80-91c9-098532bcaf00#2.2.2.2/16#100#all_squash,root_squash.
For a multi-protocol file system, specify the value in the format of #protocol type#access method#VPC ID#IP address#priority#user permission, for example, #NFS#IP#07207b50-61b4-4e40-b272-e5433105c2d0#1.1.1.1#1#no_all_squash,no_root_squash.
NOTE:@@ -125,44 +130,19 @@Description of and restrictions on the VPC ID, IP address, priority, and user permission:
- VPC ID: ID of the VPC.
- IP address: Tenant IPv4 address or address segment of the ECS's active network port. Each rule only supports one IPv4 address or address segment. The mask format is used to represent an address segment. For example, 192.168.1.0/24 represents the IP address segment of 192.168.1.0 to 192.168.1.255. Other address segment formats, such as 192.168.1.0-255, are not supported. The entered IPv4 address or address segment must be valid and cannot be an IP address or address segment starting with 0 except 0.0.0.0/0. The value 0.0.0.0/0 indicates any IP address in the VPC. In addition, the IP address or address segment cannot start with 127 or 224 to 255, for example, 127.0.0.1, 224.0.0.1, or 255.255.255.255. This is because IP addresses or address segments starting with 224 to 239 are class D addresses and they are used for multicast. IP addresses or address segments starting with 240 to 255 are class E addresses and they are used for research. If an invalid IP address or address segment is used, the access rule may fail to be added or the added access rule cannot take effect.
- Priority: Priority of a share access rule. It must be an integer ranging from 0 to 100. 0 indicates the highest priority, and 100 indicates the lowest priority. In the same VPC, the permission of the IP address or address segment with the highest priority is preferentially used. For example, if your IP address for mounting is 10.1.1.32, and the authorized 10.1.1.32 (read/write) and 10.1.1.0/24 (read-only) both meet the requirements, the permission of the IP address or segment with the higher priority is used first. If some IP addresses or address segments are of the same priority, one permission of them is randomly chosen.
- User permission: Set the user permission in the format of allSquash,rootSquash. That is, allSquash is separated from rootSquash using a comma (,). The value of allSquash can be all_squash or no_all_squash. The value of rootSquash can be root_squash or no_root_squash.
- Example request (VPC-based authorization)When the specified API version ranges from 1.0 to 2.6, the request example is as follows:-
{ - "os-allow_access": { - "access_to": "59cd070d-9c4c-462e-9dcc-b6bb716225bc", - "access_type": "cert", - "access_level": "rw" - } -}-When the specified API version is later than 2.6, the request example is as follows:
-{ - "allow_access": { - "access_to": "59cd070d-9c4c-462e-9dcc-b6bb716225bc", - "access_type": "cert", - "access_level": "rw" - } -}-
- Example request (IP address-based authorization)
POST /v2/{project_id}/shares/{share_id}/action?vpc_ip_base_acl=enable
-NFS share:
-{ - "allow_access": { - "access_to": "0560a527-0e77-40a6-aa3b-110beecad368#0.0.0.0/0#1#all_squash,root_squash", - "access_type": "cert", - "access_level": "rw" - } -}-CIFS share:
+NFS file system:
{ "allow_access": { - "access_to": "0560a527-0e77-40a6-aa3b-110beecad368#0.0.0.0/0#0", + "access_to": "0560a527-0e77-40a6-aa3b-110beecad368#127.0.0.1#1#all_squash,root_squash", "access_type": "cert", "access_level": "rw" } } When creating the share access rule for an IP address-based authorization scenario.
1. The X-Openstack-Manila-Api-Version parameter must be specified for the request header, and the value of X-Openstack-Manila-Api-Version must be from 2.28 to 2.42.
-2. The vpc_ip_base_acl parameter must be added in the request URL and the value of vpc_ip_base_acl must be set to enable. To ensure compatibility, even though this parameter is left blank or set to another value other than enable, you can use the API to create a share access rule for the IP address-based authorization scenario. However, this method of creation has been discarded and will not be maintained in the future.
+2. The vpc_ip_base_acl parameter must be added in the request URL and the value of vpc_ip_base_acl must be set to enable. To ensure compatibility, if this parameter is left blank or set to a value other than enable, you can still use this API to create an access rule used with IP address-based authorization. However, this method of creation has been discarded and will not be maintained in the future.
Object
Specifies the access object. If the share access rule is not updated, this value is null.
+Specifies the access objects. If the access rule is not updated, this value is null.
String
Specifies the type of the share access rule.
+Specifies the type of the access rule.
access_to
String
Specifies the access that the back end grants or denies.
+Specifies the object that the backend grants or denies access.
access_level
String
Specifies the access level of the shared file system.
+Specifies the level of the access rule.
id
String
Specifies the ID of the share access rule.
+Specifies the ID of the access rule.
state
String
Specifies the status of the share access rule. If the API version is earlier than 2.28, the status of the share access rule is new, active, or error. In versions from 2.28 to 2.42, the status of the share access rule is queued_to_apply, applying, active, error, queued_to_deny, or denying.
+Specifies the status of the access rule. If the API version is earlier than 2.28, the status of the access rule is new, active, or error. In versions from 2.28 to 2.42, the status of the access rule is queued_to_apply, applying, active, error, queued_to_deny, or denying.
access_key
@@ -247,36 +227,22 @@String
Specifies the time when a shared access rule is created. This parameter exists only when the value of X-Openstack-Manila-Api-Version in the request header is greater than or equal to 2.33.
+Specifies the time when the access rule was created. This parameter exists only when the value of X-Openstack-Manila-Api-Version in the request header is greater than or equal to 2.33.
updated_at
String
Specifies the time when a shared access rule is updated. This parameter exists only when the value of X-Openstack-Manila-Api-Version in the request header is greater than or equal to 2.33.
+Specifies the time when the access rule was updated. This parameter exists only when the value of X-Openstack-Manila-Api-Version in the request header is greater than or equal to 2.33.
- Adding Share Access Rules
- Example response
{ - "access": { - "share_id": "15940c49-789f-476a-b099-a3be7d311854", - "access_type": "cert", - "access_to": "59cd070d-9c4c-462e-9dcc-b6bb716225bc", - "access_level": "rw", - "state": "new", - "id": "418e3cf4-08c3-4ed2-a29a-ceffa346b3b8", - "access_key":null, - "created_at": "2017-07-07T03:15:06.858662", - "updated_at": "2018-07-07T03:15:06.858662" - } -}-
- Example response (IP address-based authorization)
+
- Example response
{ "access":{ "access_key":null, @@ -290,20 +256,6 @@ "updated_at": "2018-07-07T03:15:06.858662" } }-CIFS share:{ - "access":{ - "access_key":null, - "share_id":"7ec1115f-518b-40ff-a998-5599ce2da332", - "access_type":"cert", - "access_to":"0560a527-0e77-40a6-aa3b-110beecad368#0.0.0.0/0#0", - "access_level":"rw", - "state":"queued_to_apply", - "id":"24615391-d58d-4a74-ac5a-520233c9c396", - "created_at": "2017-07-07T03:15:06.858662", - "updated_at": "2018-07-07T03:15:06.858662" - } -}-
diff --git a/docs/sfs/api-ref/sfs_02_0030.html b/docs/sfs/api-ref/sfs_02_0030.html index 0af4338d8..51eb73ac9 100644 --- a/docs/sfs/api-ref/sfs_02_0030.html +++ b/docs/sfs/api-ref/sfs_02_0030.html @@ -1,8 +1,8 @@ --Parent topic: Share Access Rules+Parent topic: File System Access RulesDeleting Share Access Rules
-Function
This API is used to delete a share access rule.
- This API is an asynchronous API. If the returned status code is 202, the API request is successfully delivered and received. Later, you can refer to Querying Share Access Rules to identify whether the deletion of the share access rule is complete and successful.
+Deleting a File System Access Rule
+Function
This API is used to delete a file system access rule.
+ This API is an asynchronous API. If the returned status code is 202, the API request is successfully delivered and received. Later, you can refer to Querying File System Access Rules to identify whether the access rule is deleted successfully.
URI
- POST /v2/{project_id}/shares/{share_id}/action
- Parameter description
@@ -81,7 +81,7 @@
String
Specifies the ID of the share access rule of the shared file system. The value contains 1 to 36 characters.
+Specifies the ID of the access rule of the shared file system. The value contains 1 to 36 characters.
diff --git a/docs/sfs/api-ref/sfs_02_0031.html b/docs/sfs/api-ref/sfs_02_0031.html index ba4451595..54c50c9be 100644 --- a/docs/sfs/api-ref/sfs_02_0031.html +++ b/docs/sfs/api-ref/sfs_02_0031.html @@ -1,7 +1,7 @@ --Parent topic: Share Access Rules+Parent topic: File System Access RulesQuerying Share Access Rules
-Function
This API is used to query a share access rule.
+Querying File System Access Rules
+Function
This API is used to query the access rules of a shared file system.
URI
- POST /v2/{project_id}/shares/{share_id}/action
- Parameter description
Parameter
@@ -67,20 +67,20 @@ } -Response
- Description
-
Parameter
+Response
- Description
+
Parameter
Type
+Type
Description
+Description
access_list
+access_list
Array of objects
+Array of objects
Lists the access rules.
+Lists the access rules.
String
Specifies the type of the share access rule.
+Specifies the type of the access rule.
access_to
String
Specifies the access that the back end grants or denies.
+Specifies the object that the backend grants or denies access.
access_level
@@ -120,28 +120,28 @@String
Specifies the status of the share access rule. If the API version is earlier than 2.28, the status of the share access rule is new, active, or error. In versions from 2.28 to 2.42, the status of the share access rule is queued_to_apply, applying, active, error, queued_to_deny, or denying.
+Specifies the status of the access rule. If the API version is earlier than 2.28, the status of the access rule is new, active, or error. In versions from 2.28 to 2.42, the status of the access rule is queued_to_apply, applying, active, error, queued_to_deny, or denying.
id
String
Specifies the ID of the share access rule.
+Specifies the ID of the access rule.
created_at
String
Specifies the time when a shared access rule is created. This parameter exists only when the value of X-Openstack-Manila-Api-Version in the request header is greater than or equal to 2.33.
+Specifies the time when the access rule was created. This parameter exists only when the value of X-Openstack-Manila-Api-Version in the request header is greater than or equal to 2.33.
updated_at
String
Specifies the time when a shared access rule is updated. This parameter exists only when the value of X-Openstack-Manila-Api-Version in the request header is greater than or equal to 2.33.
+Specifies the time when the access rule was updated. This parameter exists only when the value of X-Openstack-Manila-Api-Version in the request header is greater than or equal to 2.33.
diff --git a/docs/sfs/api-ref/sfs_02_0032.html b/docs/sfs/api-ref/sfs_02_0032.html index 2663fdc24..21b59126a 100644 --- a/docs/sfs/api-ref/sfs_02_0032.html +++ b/docs/sfs/api-ref/sfs_02_0032.html @@ -4,38 +4,38 @@-Parent topic: Share Access Rules+Parent topic: File System Access RulesFunction
This API is used to query quota information.
URI
- GET /v2/{project_id}/os-quota-sets/{project_id}
- Parameter description
-
Parameter
+-Parameter
Mandatory
+Mandatory
Type
+Type
Description
+Description
project_id
+project_id
Yes
+Yes
String
+String
Specifies the project ID of the operator.
+Specifies the project ID of the operator.
project_id
+project_id
Yes
+Yes
String
+String
Specifies the ID of the tenant whose quotas are to be queried, updated, or deleted. This ID differs from the first project ID (the administrative tenant ID) contained in the URI.
+Specifies the ID of the tenant whose quotas are to be queried, updated, or deleted. This ID differs from the first project ID (the administrative tenant ID) contained in the URI.
- Query parameters +
- Query parameter
Parameter
Mandatory
@@ -78,7 +78,7 @@Object
Specifies the quota_set object.
+Specifies the quota_set objects.
diff --git a/docs/sfs/api-ref/sfs_02_0033.html b/docs/sfs/api-ref/sfs_02_0033.html index 0b5413ce6..70653033e 100644 --- a/docs/sfs/api-ref/sfs_02_0033.html +++ b/docs/sfs/api-ref/sfs_02_0033.html @@ -11,7 +11,7 @@-Parent topic: SFS APIs+Parent topic: SFS Capacity-Oriented APIs-diff --git a/docs/sfs/api-ref/sfs_02_0034.html b/docs/sfs/api-ref/sfs_02_0034.html index eeb7a86fe..7fcfdfddb 100644 --- a/docs/sfs/api-ref/sfs_02_0034.html +++ b/docs/sfs/api-ref/sfs_02_0034.html @@ -79,7 +79,7 @@Parent topic: SFS APIs+Parent topic: SFS Capacity-Oriented APIsInteger
Specifies the post-expansion capacity (GB) of the shared file system.
+Specifies the new capacity (GB) of the shared file system.
Integer
Specifies the post-shrinking capacity (GB) of the shared file system.
+Specifies the new capacity (GB) of the shared file system.
Share Tag
+Tag Management
diff --git a/docs/sfs/api-ref/sfs_02_0037.html b/docs/sfs/api-ref/sfs_02_0037.html index edd34e778..f418e7505 100644 --- a/docs/sfs/api-ref/sfs_02_0037.html +++ b/docs/sfs/api-ref/sfs_02_0037.html @@ -7,32 +7,32 @@-
@@ -8,22 +8,22 @@
- Deleting a Tag from a Shared File System
- - Querying Tag Information About a Shared File System
+ - Querying Tags of a Shared File System
- - Querying Tags of a Tenant's All Shared File Systems
+ - Querying Tags of All File Systems of a Tenant
- Batch Adding Tags to a Shared File System
- Batch Deleting Tags from a Shared File System
- - Querying Details About a Shared File System Based on Tags
+ - Querying Shared File Systems by Tag
- - Querying the Number of Shared File Systems Based on Tags
+ - Querying the Number of Shared File Systems by Tag
-Parent topic: SFS APIs+Parent topic: SFS Capacity-Oriented APIsThis API is idempotent. If the key to be added has already been added to the shared file system, the tag is updated.
URI
- POST /v2/{project_id}/sfs/{share_id}/tags
- Parameter description
-
Parameter
+Parameter
Mandatory
+Mandatory
Type
+Type
Description
+Description
project_id
+project_id
Yes
+Yes
String
+String
Specifies the project ID of the operator.
+Specifies the project ID of the operator.
share_id
+share_id
Yes
+Yes
String
+String
Specifies the share ID.
+Specifies the ID of the shared file system.
Request
- Parameter description
-
Parameter
+Parameter
Mandatory
+Mandatory
Type
+Type
Description
+Description
tag
+tag
Yes
+Yes
Resource_tag
+Resource_tag
Specifies the tag.
+Specifies the tag.
- Description of field resource_tag -
Parameter
+Parameter
Mandatory
+Mandatory
Type
+Type
Description
+Description
key
+key
Yes
+Yes
String
+String
Specifies the key of the tag. The value can contain a maximum of 36 characters. The key cannot be left blank and can only contain letters, digits, hyphens (-), and underscores (_).
+Specifies the tag key. The value can contain a maximum of 36 characters. The key cannot be left blank and can only contain letters, digits, hyphens (-), and underscores (_).
value
+value
Yes
+Yes
String
+String
Specifies the value of the tag. The value contains a maximum of 43 characters and can be an empty string. It can only contain letters, digits, hyphens (-), and underscores (_).
+Specifies the tag value. The value contains a maximum of 43 characters and can be an empty string. It can only contain letters, digits, hyphens (-), and underscores (_).
- Abnormal
Status Code
Description
+Description
diff --git a/docs/sfs/api-ref/sfs_02_0038.html b/docs/sfs/api-ref/sfs_02_0038.html index dc5c88952..0dadb0ee3 100644 --- a/docs/sfs/api-ref/sfs_02_0038.html +++ b/docs/sfs/api-ref/sfs_02_0038.html @@ -31,7 +31,7 @@-Parent topic: Share Tag+Parent topic: Tag ManagementString
Specifies the share ID.
+Specifies the ID of the shared file system.
key
@@ -40,7 +40,7 @@String
Specifies the key of the tag. The value can contain a maximum of 36 characters. The key cannot be left blank and can only contain letters, digits, hyphens (-), and underscores (_).
+Specifies the tag key. The value can contain a maximum of 36 characters. The key cannot be left blank and can only contain letters, digits, hyphens (-), and underscores (_).
NOTICE:When calling this API to delete a tag, if the tag key contains special characters that are not directly resolved by the URL, the key needs to be escaped.
- Abnormal
Status Code
Description
+Description
diff --git a/docs/sfs/api-ref/sfs_02_0039.html b/docs/sfs/api-ref/sfs_02_0039.html index 776e23c8a..6e7f26aa2 100644 --- a/docs/sfs/api-ref/sfs_02_0039.html +++ b/docs/sfs/api-ref/sfs_02_0039.html @@ -1,7 +1,7 @@ --Parent topic: Share Tag+Parent topic: Tag ManagementQuerying Tag Information About a Shared File System
-Function
This API is used to query all tag information about the specified shared file system.
+Querying Tags of a Shared File System
+Function
This API is used to query all tags of a specified shared file system.
URI
- GET /v2/{project_id}/sfs/{share_id}/tags
- Parameter description
Parameter
@@ -29,7 +29,7 @@String
Specifies the share ID.
+Specifies the ID of the shared file system.
- Description of field resource_tag
-
Parameter
+Parameter
Type
+Type
Description
+Description
key
+key
String
+String
Specifies the key of the tag.
+Specifies the tag key.
value
+value
String
+String
Specifies the value of the tag.
+Specifies the tag value.
- Abnormal
Status Code
Description
+Description
diff --git a/docs/sfs/api-ref/sfs_02_0040.html b/docs/sfs/api-ref/sfs_02_0040.html index 2b3d4267d..e83854b44 100644 --- a/docs/sfs/api-ref/sfs_02_0040.html +++ b/docs/sfs/api-ref/sfs_02_0040.html @@ -1,7 +1,7 @@ --Parent topic: Share Tag+Parent topic: Tag ManagementQuerying Tags of a Tenant's All Shared File Systems
-Function
This API is used to query the tag set of a tenant's all shared file systems.
+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.
URI
- GET /v2/{project_id}/sfs/tags
- Parameter description
Parameter
@@ -52,26 +52,26 @@ - Description of the tag field
-
Parameter
+Parameter
Type
+Type
Description
+Description
key
+key
String
+String
Specifies the key of the tag.
+Specifies the key of the tag.
values
+values
Array of strings
+Array of strings
Lists the values of the tag. The value is a list of a tenant's all tag values of shared file systems. Only one of the same tag values is displayed.
+Lists the values of the tag. The value is a list of tag values of all shared file systems of a tenant. Only one of the same tag values is displayed.
diff --git a/docs/sfs/api-ref/sfs_02_0041.html b/docs/sfs/api-ref/sfs_02_0041.html index b69945c37..d080eef9b 100644 --- a/docs/sfs/api-ref/sfs_02_0041.html +++ b/docs/sfs/api-ref/sfs_02_0041.html @@ -1,38 +1,38 @@-Parent topic: Share Tag+Parent topic: Tag ManagementBatch Adding Tags to a Shared File System
-Function
This API is used to batch add tags to a specified shared file system.
+Function
This API is used to batch add tags to a shared file system.
A shared file system can have a maximum of 10 tags.
The keys of multiple tags added to a shared file system must be unique.
This API is idempotent. If the key to be added has already been added to the shared file system, the tag is updated.
URI
- POST /v2/{project_id}/sfs/{share_id}/tags/action
- Parameter description
-
Parameter
+Parameter
Mandatory
+Mandatory
Type
+Type
Description
+Description
project_id
+project_id
Yes
+Yes
String
+String
Specifies the project ID of the operator.
+Specifies the project ID of the operator.
share_id
+share_id
Yes
+Yes
String
+String
Specifies the share ID.
+Specifies the ID of the shared file system.
Request
- Parameter description
-
Parameter
+Parameter
Mandatory
+Mandatory
Type
+Type
Description
+Description
action
+action
Yes
+Yes
String
+String
Specifies the operation identifier. Possible values are create and delete. Use create to batch add tags to a specified shared file system.
+Specifies the operation identifier. Possible values are create and delete. Use create to batch add tags to a specified shared file system.
tags
+tags
No
+No
Array of resource_tags
+Array of resource_tags
Specifies the tag list.
+Specifies the tag list.
This parameter is mandatory when the tenant permission is used. For the op_service permission, choose either this field or sys_tags.
sys_tags
+sys_tags
No
+No
Array of resource_tags
+Array of resource_tags
Specifies the system tag list.
+Specifies the system tag list.
This field is available only to the op_service permission. Choose either this field or tags.
-Currently, TMS invokes only one resource_tag structure. The key is fixed as _sys_enterprise_project_id.
+Only one resource_tag structure key, _sys_enterprise_project_id, is used in TMS calls.
The value is ID or 0.
- Description of field resource_tag -
Parameter
+Parameter
Mandatory
+Mandatory
Type
+Type
Description
+Description
key
+key
Yes
+Yes
String
+String
Specifies the key of the tag. The value can contain a maximum of 36 characters. The key cannot be left blank and can only contain letters, digits, hyphens (-), and underscores (_).
+Specifies the tag key. The value can contain a maximum of 36 characters. The key cannot be left blank and can only contain letters, digits, hyphens (-), and underscores (_).
value
+value
Yes
+Yes
String
+String
Specifies the value of the tag. The value contains a maximum of 43 characters and can be an empty string. It can only contain letters, digits, hyphens (-), and underscores (_).
+Specifies the tag value. The value contains a maximum of 43 characters and can be an empty string. It can only contain letters, digits, hyphens (-), and underscores (_).
- Abnormal
Status Code
Description
+Description
diff --git a/docs/sfs/api-ref/sfs_02_0042.html b/docs/sfs/api-ref/sfs_02_0042.html index 04f0b616c..f528a3267 100644 --- a/docs/sfs/api-ref/sfs_02_0042.html +++ b/docs/sfs/api-ref/sfs_02_0042.html @@ -30,7 +30,7 @@-Parent topic: Share Tag+Parent topic: Tag ManagementString
Specifies the share ID.
+Specifies the ID of the shared file system.
Request
- Parameter description
-
Parameter
+Parameter
Mandatory
+Mandatory
Type
+Type
Description
+Description
action
+action
Yes
+Yes
String
+String
Specifies the operation identifier. Possible values are create and delete. Use delete to batch delete tags from a specified shared file system.
+Specifies the operation identifier. Possible values are create and delete. Use delete to batch delete tags from a specified shared file system.
tags
+tags
Yes
+Yes
Array of resource_tags
+Array of resource_tags
Specifies the tag list.
+Specifies the tag list.
- Description of field resource_tag -
Parameter
+Parameter
Mandatory
+Mandatory
Type
+Type
Description
+Description
key
+key
Yes
+Yes
String
+String
Specifies the key of the tag.
+Specifies the tag key.
The value can contain a maximum of 36 characters. This parameter cannot be left blank.
value
+value
No
+No
String
+String
Specifies the value of the tag.
+Specifies the tag value.
The value contains a maximum of 43 characters and can be an empty string. If the value is not an empty string, the tag is located and deleted based on the key and value. If the value is an empty string, the tag is located and deleted based on the key.
diff --git a/docs/sfs/api-ref/sfs_02_0043.html b/docs/sfs/api-ref/sfs_02_0043.html index b90aca49a..1c2e0f6e6 100644 --- a/docs/sfs/api-ref/sfs_02_0043.html +++ b/docs/sfs/api-ref/sfs_02_0043.html @@ -1,26 +1,26 @@ --Parent topic: Share Tag+Parent topic: Tag ManagementQuerying Details About a Shared File System Based on Tags
-Function
This API is used to query details about a shared file system based on tags.
+Querying Shared File Systems by Tag
+Function
This API is used to query shared file systems by tag.
URI
- POST /v2/{project_id}/sfs/resource_instances/action
- Parameter description
-
Parameter
+Parameter
Mandatory
+Mandatory
Type
+Type
Description
+Description
project_id
+project_id
Yes
+Yes
String
+String
Specifies the project ID of the operator.
+Specifies the project ID of the operator.
Request
- Parameter description
Parameter
Mandatory
+Mandatory
Type
+Type
Description
offset
No
+No
String
+String
Specifies the index location. The value is a character string consisting of 0 and positive integers. The default value is 0. The first record in the query result is the offset+1 record that meets the query criteria.
limit
No
+No
String
+String
Specifies the maximum number of query records. The value is a character string consisting of integers. The default value is 1000. The value ranges from 1 to 1000.
-The number of returned records does not exceed the value of limit.
+The number of returned records cannot exceed the value of limit.
action
Yes
+Yes
String
+String
Specifies the operation identifier. Possible values are filter and count.
Use filter to query details of a shared file system using tags.
@@ -70,54 +70,54 @@matches
No
+No
Array of matches
+Array of matches
Specifies the share resource query field. If this parameter is left null, all shared file systems of the tenant are searched by default.
+Specifies the file system query field. If this parameter is left null, all shared file systems of the tenant are searched by default.
tags
No
+No
Array of tags
+Array of tags
Specifies the tag search field, which is a list of tags. Only shared file systems containing all the listed tags can be returned. Tags in this search criteria are in the AND relationship. Specifically, a shared file system can be searched only when it meets all the tag search criteria. In the key-values structure of each tag search condition, tag values are in the OR relationship. If the value of tags is not specified, all shared file systems meet the requirement of this tag search field. This field contains a maximum of 10 tag keys and each tag key has a maximum of 10 tag values. The tag value corresponding to each tag key can be an empty array but the structure cannot be missing. Tag keys must be unique. Tag values in a key-values structure must be unique.
tags_any
No
+No
Array of tags
+Array of tags
Specifies the tag search field, which is a list of tags. Shared file systems that contain any listed tag will be returned. Tags in this search criteria are in the OR relationship. Specifically, a shared file system can be searched as long as it meets one tag search condition. In the key-values structure of each tag search condition, tag values are in the OR relationship. If the value of tags_any is not specified, all shared file systems meet the requirement of this tag search field. This field contains a maximum of 10 tag keys and each tag key has a maximum of 10 tag values. The tag value corresponding to each tag key can be an empty array but the structure cannot be missing. Tag keys must be unique. Tag values in a key-values structure must be unique.
not_tags
No
+No
Array of tags
+Array of tags
Specifies the tag search field, which is a list of tags. Only shared file systems that contain none of the listed tags will be returned. Tags in this search criteria are in the NOR relationship. Specifically, a shared file system can be searched only when it does not meet any tag search criteria. In the key-values structure of each tag search condition, tag values are in the OR relationship. If the value of not_tags is not specified, all shared file systems meet the requirement of this tag search field. This field contains a maximum of 10 tag keys and each tag key has a maximum of 10 tag values. The tag value corresponding to each tag key can be an empty array but the structure cannot be missing. Tag keys must be unique. Tag values in a key-values structure must be unique.
not_tags_any
No
+No
Array of tags
+Array of tags
Specifies the tag search field, which is a list of tags. Shared file systems that do not contain any of the listed tags will be returned. Tags in this search criteria are in the NAND relationship. Specifically, a shared file system can be searched as long as it does not meet one tag search condition. In the key-values structure of each tag search condition, tag values are in the OR relationship. If the value of not_tags_any is not specified, all shared file systems meet the requirement of this tag search field. This field contains a maximum of 10 tag keys and each tag key has a maximum of 10 tag values. The tag value corresponding to each tag key can be an empty array but the structure cannot be missing. Tag keys must be unique. Tag values in a key-values structure must be unique.
sys_tags
No
+No
Array of tags
+Array of tags
Only the op_service permission can use this field to filter resources.
- Currently, TMS can invoke only one tag structure key,
- Parameter description
- Description of field resource_tag -
- Description of field resource_tag -
- Parameter description
-
- Abnormal
- Description of field resource_tag -
- Parameter description
-
- Description
+
- Description
-
- Example response
- Parameter description
-
- Parameter description
-
- Description of metadata fields (creating a shared file system with the encryption function)
- Parameter description
- Parameter description
-