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 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
+ +-
+
- API Version Querying
+
+ - File Sharing
+
+ - Share Access Rules
+
+ - Quota Management
+
+ - Expansion and Shrinking
+
+ - Share Tag
+
+
API Version Querying
+ +Querying All API Versions
+Function
This API is used to query all available versions of APIs provided by SFS.
+To support function extension, SFS APIs can be distinguished by version. SFS has two types API version IDs:
+Major version: Independent URL. For example: v1 and v2.
+Microversion: with the HTTP request header X-Openstack-Manila-Api-Version: Microversion ID. For example: X-Openstack-Manila-Api-Version: 2.4.
+
This API does not require authentication.
+URI
- GET /
- Parameter description
None
+Response
- Parameter description
++
+Parameter
+Type
+Description
+versions
+Array of objects
+Lists objects of all available API versions, including v1 and v2.
+
- Description of the version field
++
+Parameter
+Type
+Description
+id
+String
+Specifies the common name of the version.
+updated
+String
+Specifies the UTC time when the API is last modified. The format is YYYY-MM-DDTHH:MM:SSZ.
+status
+String
+Specifies the API version status, including:
+- CURRENT: indicates that the current API is the preferred version.
- SUPPORTED: indicates that the current version is an earlier version which is still supported.
- DEPRECATED: indicates that the current version is a deprecated version that may be deleted later.
links
+Array of objects
+Specifies the share links. For details, see the description of the links field.
+media-types
+Array of objects
+Specifies the media types supported by the API. For details, see the description of the media-types field.
+version
+String
+If the API in the current version supports microversions, this parameter is the latest microversion. If microversions are not supported, this parameter is an empty string.
+min_version
+String
+If the API in the current version supports microversions, this parameter is the earliest microversion. If microversions are not supported, this parameter is an empty string.
+ - Description of the links field
++
+Parameter
+Type
+Description
+href
+String
+Specifies the API access path, which is used as a reference.
+type
+String
+Specifies the type of the text returned by the reference API.
+rel
+String
+Specifies the additional description on links.
+ - Description of the media-types field
++
+Parameter
+Type
+Description
+base
+String
+Specifies the basic text type.
+type
+String
+Specifies the text type.
+
- Example response
{ + "versions": [ + { + "status": "CURRENT", + "updated": "2015-08-27T11:33:21Z", + "links": [ + { + "href": "http://docs.openstack.org/", + "type": "text/html", + "rel": "describedby" + }, + { + "href": "https://sfs.region.www.t-systems.com/v2/", + "rel": "self" + } + ], + "min_version": "2.0", + "version": "2.28", + "media-types": [ + { + "base": "application/json", + "type": "application/vnd.openstack.share+json;version=1" + } + ], + "id": "v2.0" + } + ] +}+
Status Codes
- Normal +
- Abnormal
++
+Status Code
+Description
+400 Bad Request
+The server failed to process the request.
+400 Bad Request
+Invalid input: The post-deduction capacity must be larger than 0 and smaller than the current capacity. (Current capacity: XX; post-deduction capacity: XX)
+400 Bad Request
+Invalid input: The post-expansion capacity must be larger than the current capacity. (Current capacity: XX; post-expansion capacity: XX)
+401 Unauthorized
+You must enter a username and the password to access the requested page.
+403 Forbidden
+Access to the requested page is forbidden.
+404 Not Found
+The requested page was not found.
+405 Method Not Allowed
+You are not allowed to use the method specified in the request.
+406 Not Acceptable
+The response generated by the server could not be accepted by the client.
+407 Proxy Authentication Required
+You must use the proxy server for authentication. Then the request can be processed.
+408 Request Timeout
+The request timed out.
+409 Conflict
+The request could not be processed due to a conflict.
+500 Internal Server Error
+The request is not completed because of a service error.
+501 Not Implemented
+The request is not completed because the server does not support the requested function.
+502 Bad Gateway
+The request is not completed because the request is invalid.
+503 Service Unavailable
+The request is not completed because the service is unavailable.
+504 Gateway Timeout
+A gateway timeout error occurred.
+
Querying Details About API Versions
+Function
This API is used for querying details about API versions.
+URI
- GET /{api_version}/
- Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+api_version
+Yes
+String
+Specifies the API version, which can be v1 or v2.
+
Response
- Parameter description
++
+Parameter
+Type
+Description
+versions
+Object
+List objects of all available API versions
+- Description of the version field
++
+Parameter
+Type
+Description
+id
+String
+Specifies the common name of the version.
+updated
+String
+Specifies the UTC time when the API is last modified. The format is YYYY-MM-DDTHH:MM:SSZ.
+status
+String
+Specifies the API version status, including:
+- CURRENT: indicates that the current API is the preferred version.
- SUPPORTED: indicates that the current version is an earlier version which is still supported.
- DEPRECATED: indicates that the current version is a deprecated version that may be deleted later.
links
+Array of objects
+Specifies the share links. For details, see the description of the links field.
+media-types
+Array of objects
+Specifies the media types supported by the API. For details, see the description of the media-types field.
+version
+String
+If the API in the current version supports microversions, this parameter is the latest microversion. If microversions are not supported, this parameter is an empty string.
+min_version
+String
+If the API in the current version supports microversions, this parameter is the earliest microversion. If microversions are not supported, this parameter is an empty string.
+ - Description of the links field
++
+Parameter
+Type
+Description
+href
+String
+Specifies the API access path, which is used as a reference.
+type
+String
+Specifies the type of the text returned by the reference API.
+rel
+String
+Specifies the additional description on links.
+ - Description of the media-types field
++
+Parameter
+Type
+Description
+base
+String
+Specifies the basic text type.
+type
+String
+Specifies the text type.
+
- Description of the version field
+
- Example response
{ + "versions": [ + { + "status": "CURRENT", + "updated": "2015-08-27T11:33:21Z", + "links": [ + { + "href": "http://docs.openstack.org/", + "type": "text/html", + "rel": "describedby" + }, + { + "href": "https://sfs.region.www.t-systems.com/v2/", + "rel": "self" + } + ], + "min_version": "2.0", + "version": "2.28", + "media-types": [ + { + "base": "application/json", + "type": "application/vnd.openstack.share+json;version=1" + } + ], + "id": "v2.0" + } + ] +}+
Status Codes
- Normal +
- Abnormal
++
+Status Code
+Description
+400 Bad Request
+The server failed to process the request.
+400 Bad Request
+Invalid input: The post-deduction capacity must be larger than 0 and smaller than the current capacity. (Current capacity: XX; post-deduction capacity: XX)
+400 Bad Request
+Invalid input: The post-expansion capacity must be larger than the current capacity. (Current capacity: XX; post-expansion capacity: XX)
+401 Unauthorized
+You must enter a username and the password to access the requested page.
+403 Forbidden
+Access to the requested page is forbidden.
+404 Not Found
+The requested page was not found.
+405 Method Not Allowed
+You are not allowed to use the method specified in the request.
+406 Not Acceptable
+The response generated by the server could not be accepted by the client.
+407 Proxy Authentication Required
+You must use the proxy server for authentication. Then the request can be processed.
+408 Request Timeout
+The request timed out.
+409 Conflict
+The request could not be processed due to a conflict.
+500 Internal Server Error
+The request is not completed because of a service error.
+501 Not Implemented
+The request is not completed because the server does not support the requested function.
+502 Bad Gateway
+The request is not completed because the request is invalid.
+503 Service Unavailable
+The request is not completed because the service is unavailable.
+504 Gateway Timeout
+A gateway timeout error occurred.
+
File Sharing
+ +-
+
- Creating a Shared File System
+
+ - Querying All Shared File Systems
+
+ - Querying Details About All Shared File Systems
+
+ - Querying Details About a Shared File System
+
+ - Querying Mount Locations of a Shared File System
+
+ - Modifying a Shared File System
+
+ - Deleting a Shared File System
+
+
Creating a Shared File System
+Function
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.
+URI
- POST /v2/{project_id}/shares
- Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+project_id
+Yes
+String
+Specifies the project ID of the operator.
+
Request
- Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+share
+Yes
+Object
+For details, see the description of the share field.
+ - Description of the share field
++
+Parameter
+Mandatory
+Type
+Description
+share_proto
+Yes
+String
+Specifies the file system sharing protocol. The valid value can be NFS (for Linux OS) or CIFS (for Windows OS).
+size
+Yes
+Integer
+Specifies the size (GB) of the shared file system. The applied capacity of the shared file system cannot be larger than the allowed quota. To view the allowed quota, see Quota Management.
+name
+No
+String
+Specifies the name of the shared file system, which contains 0 to 255 characters and can contain only letters, digits, hyphens (-), and underscores (_).
+description
+No
+String
+Specifies the description of the shared file system, which contains 0 to 255 characters and can contain only letters, digits, hyphens (-), and underscores (_).
+is_public
+No
+Boolean
+(Supported by API versions from v2.8 to v2.42). 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.
+availability_zone
+No
+String
+Specifies the availability zone name. If this parameter is left blank, the default availability zone will be used. If the default availability zone contains no storage resources, the creation of the shared file system fails. The value contains 0 to 255 characters.
+metadata
+No
+Object
+Specifies the metadata information used to create the shared file system. The value consists of one or more key and value pairs organized as a dictionary of strings. For details, see the description of the metadata field.
+CAUTION:+- For security concerns, the API for modifying the metadata field is not opened yet. Therefore, ensure that the parameters and values are correct when creating a shared file system with data encryption using the metadata field.
- Unless otherwise specified (for example, #sfs_crypt_key_id), the keys that comply with the following rules in the metadata field are for internal use of the system. Do not customize the settings to avoid internal system errors caused by conflicts with system predefined keys.
- Key share_used
- Keys that start with #sfs
- 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
+Value Type
+Mandatory
+Description
+#sfs_crypt_key_id
+String
+Yes
+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
+String
+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.
+#sfs_crypt_alias
+String
+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.
++ - You are advised to use the default primary key sfs/default to create an encrypted shared file system. For details, see section "File System Encryption" and "Encryption" in the Scalable File Service User Guide.
- 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, + "size": 1, + "is_public": false + } +}+
- 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", + "#sfs_crypt_domain_id": "3b2d9670690444c582942801ed7d457b", + "#sfs_crypt_alias": "sfs/default" + }, + "share_proto": "NFS", + "share_network_id": null, + "size": 1, + "is_public": false + } +}+
Response
- Parameter description
++
+Parameter
+Type
+Description
+share
+Object
+For details, see the description of the share field.
+ - Description of the share field
++
+Parameter
+Type
+Description
+links
+Array
+Specifies the links of shared file systems.
+availability_zone
+String
+Specifies the availability zone.
+share_server_id
+String
+Specifies the ID for managing share services.
+id
+String
+Specifies the ID of the shared file system.
+size
+Integer
+Specifies the size (GB) of the shared file system.
+project_id
+String
+Specifies the ID of the project to which the shared file system belongs.
+metadata
+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.
+status
+String
+Specifies the status of the shared file system.
+description
+String
+Describes the shared file system.
+host
+String
+Specifies the name of the host. This field is visible only to the administrator.
+name
+String
+Specifies the name of the shared file system.
+created_at
+String
+Specifies the date and time stamp when the shared file system was created.
+access_rules_status
+String
+Specifies the configuration status of the access rule. Possible values are active (effective), error (configuration failed), and syncing (configuration in progress). This field is supported by API v2.10 and later versions.
+share_proto
+String
+Specifies the protocol for sharing file systems.
+share_type_name
+String
+Specifies the storage service type assigned for the shared file system, such as high-performance storage (composed of SSDs) and large-capacity storage (composed of SATA disks). This field is supported by API v2.6 and later versions.
+share_type
+String
+Specifies the ID of the share type.
+volume_type
+String
+Specifies the volume type. The definition of this parameter is the same as that of share_type.
+export_locations
+Array
+Lists the mount locations. Currently, only a single mount location is supported. This parameter exists only when X-Openstack-Manila-Api-Version specified in the request header is smaller than 2.9.
+export_location
+String
+Specifies the mount location. This parameter exists only when X-Openstack-Manila-Api-Version specified in the request header is smaller than 2.9.
+is_public
+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.
+user_id
+String
+Specifies the user ID. This field is supported by API v2.16 and later versions.
+
- Example response
{ + "share": { + "status": "creating", + "project_id": "16e1ab15c35a457e9c2b2aa189f544e1", + "name": "share_London", + "share_type": "25747776-08e5-494f-ab40-a64b9d20d8f7", + "availability_zone": "az1.dc1", + "created_at": "2015-09-18T10:25:24.533287", + "export_location": null, + "links": [ + { + "href": "http://192.168.198.54:8786/v2/16e1ab15c35a457e9c2b2aa189f544e1/shares/011d21e2-fbc3-4e4a-9993-9ea223f73264", + "rel": "self" + }, + { + "href": "http://192.168.198.54:8786/16e1ab15c35a457e9c2b2aa189f544e1/shares/011d21e2-fbc3-4e4a-9993-9ea223f73264", + "rel": "bookmark" + } + ], + "share_network_id": null, + "export_locations": [], + "share_proto": "NFS", + "host": null, + "volume_type": "default", + "snapshot_id": null, + "is_public": true, + "metadata": { + "project": "my_app", + "aim": "doc" + }, + "id": "011d21e2-fbc3-4e4a-9993-9ea223f73264", + "size": 1, + "description": "My custom share London" + } +}++ When the client receives the system response, the shared file system is still being created. For this reason, the shared path cannot be queried immediately. You can use the API of Querying Mount Locations of a Shared File System to query the shared path after the creation is complete.
+
Status Codes
- Normal +
- Abnormal
++
+Status Code
+Description
+400 Bad Request
+The server failed to process the request.
+401 Unauthorized
+You must enter a username and the password to access the requested page.
+403 Forbidden
+Access to the requested page is forbidden.
+404 Not Found
+The requested page was not found.
+405 Method Not Allowed
+You are not allowed to use the method specified in the request.
+406 Not Acceptable
+The response generated by the server could not be accepted by the client.
+407 Proxy Authentication Required
+You must use the proxy server for authentication. Then the request can be processed.
+408 Request Timeout
+The request timed out.
+409 Conflict
+The request could not be processed due to a conflict.
+500 Internal Server Error
+Failed to complete the request because of an internal service error.
+501 Not Implemented
+Failed to complete the request because the server does not support the requested function.
+502 Bad Gateway
+Failed to complete the request because the request is invalid.
+503 Service Unavailable
+Failed to complete the request because the service is unavailable.
+504 Gateway Timeout
+A gateway timeout error occurred.
+
Querying All Shared File Systems
+Function
This API is used to list the basic information of all shared file systems.
+URI
- GET /v2/{project_id}/shares?all_tenants={all_tenants}&status={status}&limit={limit}&offset={offset}&sort_key={sort_key}&sort_dir={sort_dir}&project_id={project_id}&is_public={is_public}&metadata={metadata}& export_location_id={export_location_id}& export_location_path={export_location_path}& name~={name}& description~={description}& with_count={with_count}
- Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+project_id
+Yes
+String
+Specifies the project ID of the operator.
+all_tenants
+No (query parameter)
+Boolean
+This parameter is available only to users with administrator permissions. Specifies whether to list shared file systems of all tenants. To list shared file systems of all tenants, set it to 1. To list shared file systems only of the current tenant, set it to 0.
+project_id
+No (query parameter)
+String
+This parameter is available only to users with administrator permissions. Specifies the ID of the project to which the shared file system belongs. This parameter needs to be used together with all_tenants.
+status
+No (query parameter)
+String
+Filters shared file systems by status. Possible values are:
+- creating: The shared file system is being created.
- error: The shared file system fails to be created.
- available: The shared file system is available.
- deleting: The shared file system is being deleted.
- error_deleting: The shared file system fails to be deleted.
- extending: The shared file system is being expanded.
- extending_error: The shared file system fails to be expanded.
- shrinking: The shared file system is being shrunk.
- shrinking_error: The shared file system fails to be shrunk.
- shrinking_possible_data_loss_error: The shared file system fails to be shrunk due to data loss.
- manage_starting: Shared file system management starts.
- manage_error: The shared file system fails to be managed.
- unmanage_starting: Canceling shared file system management starts.
- unmanage_error: Failed to cancel shared file system management.
- unmanaged: The shared file system is not managed.
limit
+No (query parameter)
+Integer
+Specifies the maximum number of shared file systems that can be returned. If this parameter is not specified, all the shared file systems are returned by default.
+offset
+No (query parameter)
+Integer
+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.
+sort_key
+No (query parameter)
+String
+Specifies the keyword for sorting the queried shared file systems. Possible values are id, status, size, host, share_proto, availability_zone_id, user_id, project_id, created_at, updated_at, display_name, name, share_type_id, share_network_id, and snapshot_id. By default, the value is sorted by created_at.
+sort_dir
+No (query parameter)
+String
+Specifies the direction to sort shared file systems. Possible values are asc (ascending) and desc (descending).
+is_public
+No (query parameter)
+String
+When this parameter is set to true, the current tenant can query all its own shared file systems and other tenants' shared file systems whose is_public is set to true. When this parameter is set to false, the current tenant can query only the shared file systems owned by the tenant.
+metadata
+No (query parameter)
+String
+Specifies the metadata information used to query the shared file systems. The value consists of one or more key and value pairs organized as a dictionary of strings.
+export_location_id
+No (query parameter)
+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.
+export_location_path
+No (query parameter)
+String
+Specifies the field used for filtering based on the mount path. This field is supported by API v2.35 and later versions.
+name~
+No (query parameter)
+String
+Specifies the field used for fuzzy filtering based on the name of a shared file system. This field is supported by API v2.36 and later versions.
+description~
+No (query parameter)
+String
+Specifies the field used for fuzzy filtering based on the description of a shared file system. This field is supported by API v2.36 and later versions.
+with_count
+No (query parameter)
+String
+Specifies whether the number of queried shared file systems is returned. This field is supported by API v2.42 and later versions. This parameter is specified by ?with_count=true in the URI. The default value is false.
+
Response
- Parameter description
++
+Parameter
+Type
+Description
+shares
+Array of objects
+For details, see the description of the share field.
+count
+String
+Specifies the number of returned shared file systems.
+ - Description of the share field
++
+Parameter
+Type
+Description
+id
+String
+Specifies the ID of the shared file system.
+links
+Array of objects
+Specifies the request link information of the shared file system.
+name
+String
+Specifies the name of the shared file system.
+
- Example response
{ + "count": 1, + "shares": [ + { + "id": "1390cb29-539b-4926-8953-d8d6b106071a", + "links": [ + { + "href": "https://192.168.196.47:8796/v2/f24555bfcf3146ca936d21bcb548687e/shares/1390cb29-539b-4926-8953-d8d6b106071a", + "rel": "self" + }, + { + "href": "https://192.168.196.47:8796/f24555bfcf3146ca936d21bcb548687e/shares/1390cb29-539b-4926-8953-d8d6b106071a", + "rel": "bookmark" + } + ], + "name": null + } +] +}+
Status Codes
- Normal +
- Abnormal
++
+Status Code
+Description
+400 Bad Request
+The server failed to process the request.
+401 Unauthorized
+You must enter a username and the password to access the requested page.
+403 Forbidden
+Access to the requested page is forbidden.
+404 Not Found
+The requested page was not found.
+405 Method Not Allowed
+You are not allowed to use the method specified in the request.
+406 Not Acceptable
+The response generated by the server could not be accepted by the client.
+407 Proxy Authentication Required
+You must use the proxy server for authentication. Then the request can be processed.
+408 Request Timeout
+The request timed out.
+409 Conflict
+The request could not be processed due to a conflict.
+500 Internal Server Error
+Failed to complete the request because of an internal service error.
+501 Not Implemented
+Failed to complete the request because the server does not support the requested function.
+502 Bad Gateway
+Failed to complete the request because the request is invalid.
+503 Service Unavailable
+Failed to complete the request because the service is unavailable.
+504 Gateway Timeout
+A gateway timeout error occurred.
+
Querying Details About All Shared File Systems
+Function
This API is used to query the details about all shared file systems.
+URI
- GET /v2/{project_id}/shares/detail?all_tenants={all_tenants}&project_id={project_id}&status={status}&limit={limit}&offset={offset}&sort_key={sort_key}&sort_dir={sort_dir}&is_public={is_public}&metadata={metadata}& export_location_id={export_location_id}& export_location_path={export_location_path}& description~={description}&name={name}
- Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+project_id
+Yes
+String
+Specifies the project ID of the operator.
+all_tenants
+No (query parameter)
+Integer
+(Administrators only) Specifies whether to list shared file systems of all tenants. To list shared file systems of all tenants, set it to 1. To list shared file systems only of the current tenant, set it to 0.
+project_id
+No (query parameter)
+String
+Specifies the ID of the tenant who creates the shared file system. This parameter is used together with all_tenants.
+status
+No (query parameter)
+String
+Filters shared file systems by status. Possible values are creating, error, available, deleting, error_deleting, manage_starting, manage_error, unmanage_starting, unmanage_error, unmanaged, extending, extending_error, shrinking, shrinking_error, and shrinking_possible_data_loss_error.
+limit
+No (query parameter)
+Integer
+Specifies the maximum number of shared file systems that can be returned.
+offset
+No (query parameter)
+Integer
+Specifies the offset to define the start point of shared file system listing.
+sort_key
+No (query parameter)
+String
+Specifies the keyword for sorting the queried shared file systems. Possible values are id, status, size, host, share_proto, availability_zone_id, user_id, project_id, created_at, updated_at, display_name, name, share_type_id, share_network_id, and snapshot_id.
+sort_dir
+No (query parameter)
+String
+Specifies the direction to sort shared file systems. Possible values are asc (ascending) and desc (descending).
+is_public
+No (query parameter)
+String
+When this parameter is set to true, the current tenant can query all its own shared file systems and other tenants' shared file systems whose is_public is set to true. When this parameter is set to false, the current tenant can query only the shared file systems owned by the tenant.
+metadata
+No (query parameter)
+String
+Specifies the metadata information used to query the shared file systems. The value consists of one or more key and value pairs organized as a dictionary of strings.
+export_location_id
+No (query parameter)
+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.
+export_location_path
+No (query parameter)
+String
+Specifies the field used for filtering based on the mount path. This field is supported by API v2.35 and later versions.
+name
+No (query parameter)
+String
+Specifies the field used for fuzzy filtering based on the name of a shared file system. This field is supported by API v2.36 and later versions.
+description~
+No (query parameter)
+String
+Specifies the field used for fuzzy filtering based on the description of a shared file system. This field is supported by API v2.36 and later versions.
+
Response
- Parameter description
++
+Parameter
+Type
+Description
+shares
+Array of objects
+Specifies the list of share objects.
+ - Description of the share field
++
+Parameter
+Type
+Description
+links
+Array
+Specifies the links of shared file systems.
+availability_zone
+String
+Specifies the availability zone.
+share_server_id
+String
+Specifies the ID for managing share services.
+share_network_id
+String
+Specifies the ID of the share network. This parameter is reserved, because share network management is not supported currently.
+snapshot_id
+String
+Specifies the ID of the source snapshot that is used to create the shared file system. This parameter is reserved, because snapshots are not supported currently.
+snapshot_support
+Boolean
+Specifies whether snapshots are supported. This parameter is reserved, because snapshots are not supported currently. This field is supported by API v2.2 and later versions.
+id
+String
+Specifies the ID of the shared file system.
+size
+Integer
+Specifies the size (GB) of the shared file system.
+share_group_id
+String
+Specifies the ID of the consistency group. This parameter is reserved, because consistency groups are not supported currently. This field is supported by API versions from v2.31 to v2.42.
+project_id
+String
+Specifies the ID of the project to which the shared file system belongs.
+metadata
+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.
+status
+String
+Specifies the status of the shared file system.
+task_state
+String
+Specifies the data migration status. This parameter is reserved, because data migration is not supported currently. This field is supported by API v2.5 and later versions.
+has_replicas
+Boolean
+Specifies whether replicas exist. This parameter is reserved, because replication is not supported currently. This field is supported by API versions from v2.11 to v2.42.
+replication_type
+String
+Specifies the replication type. This parameter is reserved, because replication is not supported currently. This field is supported by API versions from v2.11 to v2.42.
+description
+String
+Describes the shared file system.
+host
+String
+Specifies the name of the host. This field is visible only to the administrator.
+name
+String
+Specifies the name of the shared file system.
+created_at
+String
+Specifies the date and time stamp when the shared file system was created.
+access_rules_status
+String
+Specifies the configuration status of the access rule. Possible values are active (effective), error (configuration failed), and syncing (configuration in progress). This field is supported by API v2.10 and later versions.
+share_proto
+String
+Specifies the protocol for sharing file systems.
+share_type_name
+String
+Specifies the storage service type assigned for the shared file system, such as high-performance storage (composed of SSDs) and large-capacity storage (composed of SATA disks). This field is supported by API v2.6 and later versions.
+share_type
+String
+Specifies the ID of the share type.
+volume_type
+String
+Specifies the volume type. The definition of this parameter is the same as that of share_type.
+export_locations
+Array
+Lists the mount locations. Currently, only a single mount location is supported. This parameter exists only when X-Openstack-Manila-Api-Version specified in the request header is smaller than 2.9.
+export_location
+String
+Specifies the mount location. This parameter exists only when X-Openstack-Manila-Api-Version specified in the request header is smaller than 2.9.
+is_public
+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.
+source_share_group_snapshot_member_id
+String
+Specifies the ID of the snapshot's source. This parameter is reserved, because consistency snapshots are not supported currently. This field is supported by API v2.31 and later versions.
+revert_to_snapshot_support
+Boolean
+Specifies whether rollback from snapshot is supported. This parameter is reserved, because snapshots are not supported currently. This field is supported by API v2.27 and later versions.
+create_share_from_snapshot_support
+Boolean
+Specifies whether creation of shared file systems from snapshot is supported. This parameter is reserved, because snapshots are not supported currently. This field is supported by API v2.24 and later versions.
+mount_snapshot_support
+Boolean
+Specifies whether snapshot mount is supported. This parameter is reserved, because snapshots are not supported currently. This field is supported by API v2.32 and later versions.
+user_id
+String
+Specifies the user ID. This field is supported by API v2.16 and later versions.
+
- Example response
{ + "shares": [ + { + "links": [ + { + "href": "https://192.168.170.97:8796/v2/61b01a94b84448cfac2424e46553d7e7/shares/54d0bac6-45c8-471c-bf0d-16ffd81ef88a", + "rel": "self" + }, + { + "href": "https://192.168.170.97:8796/61b01a94b84448cfac2424e46553d7e7/shares/54d0bac6-45c8-471c-bf0d-16ffd81ef88a", + "rel": "bookmark" + } + ], + "export_location": "sfs.dong.com:/share-e1c2d35e", + "availability_zone": "az1.dc1", + "share_network_id": null, + "snapshot_id": null, + "id": "54d0bac6-45c8-471c-bf0d-16ffd81ef88a", + "size": 1, + "share_type": "default", + "share_group_id": null, + "project_id": "da0f615c35eb4d72812d1547a77b5394", + "metadata": { + + "share_used": "1048576000000" + }, + "status": "available", + "description": "test description", + "export_locations": ["sfs.dong.com:/share-e1c2d35e"], + "host": "DJ01@9656beb1-7ce2-4c46-9911-ecd51ab632bf#9656beb1-7ce2-4c46-9911-ecd51ab632bf", + "is_public": false, + "name": "cl01", + "created_at": "2017-07-07T03:15:06.858662", + "share_proto": "NFS", + "volume_type": "default" + } +] +}+
Status Codes
- Normal +
- Abnormal
++
+Status Code
+Description
+400 Bad Request
+The server failed to process the request.
+401 Unauthorized
+You must enter a username and the password to access the requested page.
+403 Forbidden
+Access to the requested page is forbidden.
+404 Not Found
+The requested page was not found.
+405 Method Not Allowed
+You are not allowed to use the method specified in the request.
+406 Not Acceptable
+The response generated by the server could not be accepted by the client.
+407 Proxy Authentication Required
+You must use the proxy server for authentication. Then the request can be processed.
+408 Request Timeout
+The request timed out.
+409 Conflict
+The request could not be processed due to a conflict.
+500 Internal Server Error
+Failed to complete the request because of an internal service error.
+501 Not Implemented
+Failed to complete the request because the server does not support the requested function.
+502 Bad Gateway
+Failed to complete the request because the request is invalid.
+503 Service Unavailable
+Failed to complete the request because the service is unavailable.
+504 Gateway Timeout
+A gateway timeout error occurred.
+
Querying Details About a Shared File System
+Function
This API is used to query the details about a shared file system.
+URI
- GET /v2/{project_id}/shares/{share_id}
- Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+share_id
+Yes
+String
+Specifies the ID of the shared file system.
+project_id
+Yes
+String
+Specifies the project ID of the operator.
+
Response
- Parameter description
++
+Parameter
+Type
+Description
+share
+Object
+Specifies the share object.
+ - Description of the share field
++
+Parameter
+Type
+Description
+links
+Array
+Specifies the links of shared file systems.
+availability_zone
+String
+Specifies the availability zone.
+share_server_id
+String
+Specifies the ID for managing share services.
+share_network_id
+String
+Specifies the ID of the share network. This parameter is reserved, because share network management is not supported currently.
+snapshot_id
+String
+Specifies the ID of the source snapshot that is used to create the shared file system. This parameter is reserved, because snapshots are not supported currently.
+snapshot_support
+Boolean
+Specifies whether snapshots are supported. This parameter is reserved, because snapshots are not supported currently. This field is supported by API v2.2 and later versions.
+id
+String
+Specifies the ID of the shared file system.
+size
+Integer
+Specifies the size (GB) of the shared file system.
+share_group_id
+String
+Specifies the ID of the consistency group. This parameter is reserved, because consistency groups are not supported currently. This field is supported by API versions from v2.31 to v2.42.
+project_id
+String
+Specifies the ID of the project to which the shared file system belongs.
+metadata
+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.
+status
+String
+Specifies the status of the shared file system.
+task_state
+String
+Specifies the data migration status. This parameter is reserved, because data migration is not supported currently. This field is supported by API v2.5 and later versions.
+has_replicas
+Boolean
+Specifies whether replicas exist. This parameter is reserved, because replication is not supported currently. This field is supported by API versions from v2.11 to v2.42.
+replication_type
+String
+Specifies the replication type. This parameter is reserved, because replication is not supported currently. This field is supported by API versions from v2.11 to v2.42.
+description
+String
+Describes the shared file system.
+host
+String
+Specifies the name of the host. This field is visible only to the administrator.
+name
+String
+Specifies the name of the shared file system.
+created_at
+String
+Specifies the date and time stamp when the shared file system was created.
+access_rules_status
+String
+Specifies the configuration status of the access rule. Possible values are active (effective), error (configuration failed), and syncing (configuration in progress). This field is supported by API v2.10 and later versions.
+share_proto
+String
+Specifies the protocol for sharing file systems.
+share_type_name
+String
+Specifies the storage service type assigned for the shared file system, such as high-performance storage (composed of SSDs) and large-capacity storage (composed of SATA disks). This field is supported by API v2.6 and later versions.
+share_type
+String
+Specifies the ID of the share type.
+volume_type
+String
+Specifies the volume type. The definition of this parameter is the same as that of share_type.
+export_locations
+Array
+Lists the mount locations. Currently, only a single mount location is supported. This parameter exists only when X-Openstack-Manila-Api-Version specified in the request header is smaller than 2.9.
+export_location
+String
+Specifies the mount location. This parameter exists only when X-Openstack-Manila-Api-Version specified in the request header is smaller than 2.9.
+is_public
+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.
+source_share_group_snapshot_member_id
+String
+Specifies the ID of the snapshot's source. This parameter is reserved, because consistency snapshots are not supported currently. This field is supported by API v2.31 and later versions.
+revert_to_snapshot_support
+Boolean
+Specifies whether rollback from snapshot is supported. This parameter is reserved, because snapshots are not supported currently. This field is supported by API v2.27 and later versions.
+create_share_from_snapshot_support
+Boolean
+Specifies whether creation of shared file systems from snapshot is supported. This parameter is reserved, because snapshots are not supported currently. This field is supported by API v2.24 and later versions.
+mount_snapshot_support
+Boolean
+Specifies whether snapshot mount is supported. This parameter is reserved, because snapshots are not supported currently. This field is supported by API v2.32 and later versions.
+user_id
+String
+Specifies the user ID. This field is supported by API v2.16 and later versions.
+
- Example response
{ + "share": { + "status": "available", + "share_type_name": "sla", + "description": "My custom share London", + "links": [ + { + "href": "https://192.168.196.47:8796/v2/07412155bf474db9a2f697fd978593d7/shares/f26d867f-9876-433d-8db2-25d210f29309", + "rel": "self" + }, + { + "href": "https://192.168.196.47:8796/07412155bf474db9a2f697fd978593d7/shares/f26d867f-9876-433d-8db2-25d210f29309", + "rel": "bookmark" + } + ], + "availability_zone": "az1.dc1", + "share_network_id": null, + "share_server_id": null, + "share_group_id": null, + "host": "DJ38@a4588256-3880-4136-b3c9-4c3aade8a84b#a4588256-3880-4136-b3c9-4c3aade8a84b", + "revert_to_snapshot_support": null, + "access_rules_status": "active", + "snapshot_id": null, + "create_share_from_snapshot_support": null, + "is_public": false, + "task_state": null, + "snapshot_support": true, + "id": "f26d867f-9876-433d-8db2-25d210f29309", + "size": 1, + "source_share_group_snapshot_member_id": null, + "user_id": "daa3f8f8d7254465841da769298a76f6", + "name": "luzhongguo_1", + "share_type": "8ae4e74e-83f4-4980-8ab8-e637f9294e0b", + "has_replicas": false, + "replication_type": null, + "created_at": "2018-12-25T08:45:22.525899", + "share_proto": "NFS", + "volume_type": "sla", + "mount_snapshot_support": null, + "project_id": "07412155bf474db9a2f697fd978593d7", + "metadata": { + "share_key": "test", + "share_used": "1", + } + } +}+
Status Codes
- Normal +
- Abnormal
++
+Status Code
+Description
+400 Bad Request
+The server failed to process the request.
+401 Unauthorized
+You must enter a username and the password to access the requested page.
+403 Forbidden
+Access to the requested page is forbidden.
+404 Not Found
+The requested page was not found.
+405 Method Not Allowed
+You are not allowed to use the method specified in the request.
+406 Not Acceptable
+The response generated by the server could not be accepted by the client.
+407 Proxy Authentication Required
+You must use the proxy server for authentication. Then the request can be processed.
+408 Request Timeout
+The request timed out.
+409 Conflict
+The request could not be processed due to a conflict.
+500 Internal Server Error
+Failed to complete the request because of an internal service error.
+501 Not Implemented
+Failed to complete the request because the server does not support the requested function.
+502 Bad Gateway
+Failed to complete the request because the request is invalid.
+503 Service Unavailable
+Failed to complete the request because the service is unavailable.
+504 Gateway Timeout
+A gateway timeout error occurred.
+
Querying Mount Locations of a Shared File System
+Function
This API is used to query mount locations of a shared file system.
+ This API exists only when X-Openstack-Manila-Api-Version in the request header is greater than or equal to 2.9. The following is an example request sent by the curl command: curl -k -i -X GET https://192.168.196.47:8786/v2/13c7ff9a479c4e3599f4331d9e4a1835/shares/2a8c5470-d5d9-4fe1-b9fc-66a15a162e41/export_locations -H "X-Openstack-Manila-Api-Version: 2.9" -H "X-Auth-Token: $token" -H "Accept: application/json"
+URI
- GET /v2/{project_id}/shares/{share_id}/export_locations
- Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+share_id
+Yes
+String
+Specifies the ID of the shared file system.
+project_id
+Yes
+String
+Specifies the project ID of the operator.
+
Response
- Parameter description
++
+Parameter
+Type
+Description
+export_locations
+Array of strings
+Specifies the list of export locations.
+ - Description of field export_location
++
+Parameter
+Type
+Description
+id
+String
+Specifies the ID of the mount location of the shared file system.
+share_instance_id
+String
+Specifies the ID of the shared file system.
+path
+String
+Specifies the path to which the shared file system will be mounted.
+is_admin_only
+Boolean
+Specifies whether the shared file system is only visible to administrators and its owner. Possible values are true (only visible to administrators and its owner) and false (visible to all users).
+preferred
+Boolean
+Identifies which mount locations are most efficient and are used preferentially when multiple mount locations exist.
+
- Example responseNFS share:+
{ + "export_locations": [ + { + "path": "sfs-nas1.dong.com:/share-236b936a", + "id": "b03d2aac-aeed-409a-af07-5d1b9024241c", + "preferred": false + } + ] +}+CIFS share:+{ + "export_locations": [ + { + "path": "\\\\sfs-nas1.dong.com\\share-4e76e627", + "id": "85eb5849-1a89-43ae-99ac-2e781514a228", + "preferred": false + } + ] +}+
Status Codes
- Normal +
- Abnormal
++
+Status Code
+Description
+400 Bad Request
+The server failed to process the request.
+401 Unauthorized
+You must enter a username and the password to access the requested page.
+403 Forbidden
+Access to the requested page is forbidden.
+404 Not Found
+The requested page was not found.
+
Modifying a Shared File System
+Function
This API is used to modify the name and description of a shared file system.
+URI
- PUT /v2/{project_id}/shares/{share_id}
- Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+share_id
+Yes
+String
+Specifies the ID of the shared file system.
+project_id
+Yes
+String
+Specifies the project ID of the operator.
+
Request
- Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+share
+Yes
+Object
+Specifies the share object.
+ - Description of the share field
++
+Parameter
+Mandatory
+Type
+Description
+display_name
+No
+String
+Specifies the new name of the shared file system. The value consists of 0 to 255 characters.
+display_description
+No
+String
+Describes the shared file system. The value contains 0 to 255 characters.
+is_public
+No
+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.
+
- Example request
{ + "share": { + "display_name": "testshare", + "display_description": "test" + } +}+
Response
- Parameter description
++
+Parameter
+Type
+Description
+share
+Object
+Specifies the share object.
+ - Description of the share field
++
+Parameter
+Type
+Description
+links
+Array
+Specifies the links of shared file systems.
+availability_zone
+String
+Specifies the availability zone.
+share_server_id
+String
+Specifies the ID for managing share services.
+share_network_id
+String
+Specifies the ID of the share network. This parameter is reserved, because share network management is not supported currently.
+snapshot_id
+String
+Specifies the ID of the source snapshot that is used to create the shared file system. This parameter is reserved, because snapshots are not supported currently.
+snapshot_support
+Boolean
+Specifies whether snapshots are supported. This parameter is reserved, because snapshots are not supported currently.
+id
+String
+Specifies the ID of the shared file system.
+size
+Integer
+Specifies the size (GB) of the shared file system.
+share_group_id
+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.
+project_id
+String
+Specifies the ID of the project to which the shared file system belongs.
+metadata
+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.
+status
+String
+Specifies the status of the shared file system.
+task_state
+String
+Specifies the data migration status. This parameter is reserved, because data migration is not supported currently.
+has_replicas
+Boolean
+(Supported by API versions from v2.11 to v2.42) Specifies whether any replication exists. This parameter is reserved, because replication is not supported currently.
+replication_type
+String
+(Supported by API versions from v2.11 to v2.42) Specifies the replication type. This parameter is reserved, because replication is not supported currently.
+description
+String
+Describes the shared file system.
+host
+String
+Specifies the name of the host. This field is visible only to the administrator.
+name
+String
+Specifies the name of the shared file system.
+created_at
+String
+Specifies the date and time stamp when the shared file system was created.
+access_rules_status
+String
+(Supported by API versions from v2.10 to v2.27.) Specifies the configuration status of the access rule. Possible values are active (effective), error (configuration failed), and syncing (configuration in progress).
+share_proto
+String
+Specifies the protocol for sharing file systems.
+volume_type
+String
+Specifies the volume type. The definition of this parameter is the same as that of share_type.
+share_type_name
+String
+Specifies the storage service type assigned for the shared file system, such as high-performance storage (composed of SSDs) and large-capacity storage (composed of SATA disks).
+share_type
+String
+Specifies the ID of the share type.
+export_locations
+Array
+Lists the mount locations. Currently, only a single mount location is supported. This parameter exists only when X-Openstack-Manila-Api-Version specified in the request header is smaller than 2.8.
+export_location
+String
+Specifies the mount location. This parameter exists only when X-Openstack-Manila-Api-Version specified in the request header is smaller than 2.8.
+is_public
+Boolean
+(Supported by API versions from v2.8 to v2.42). 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.
+source_share_group_snapshot_member_id
+String
+(Supported by API v2.31 and later versions.) Specifies the ID of a consistency snapshot source. Currently, the consistency group is not supported. This field is reserved.
+revert_to_snapshot_support
+Boolean
+(Supported by API v2.27 and later versions.) Specifies whether reversion to snapshot is supported. Currently, snapshot is not supported. This field is reserved.
+create_share_from_snapshot_support
+Boolean
+(Supported by API v2.24 and later versions.) Specifies whether creating file systems from snapshot is supported. Currently, snapshot is not supported. This field is reserved.
+mount_snapshot_support
+Boolean
+(Supported by API v2.32 and later versions.) Specifies whether snapshot mounting is supported. Currently, snapshot is not supported. This field is reserved.
+user_id
+String
+(Supported by API v2.16 and later versions.) Specifies the user ID.
+
- Example response
{ + "share": { + "status": "available", + "share_type_name": "sla", + "description": "test", + "links": [ + { + "href": "https://192.168.196.47:8796/v2/07412155bf474db9a2f697fd978593d7/shares/f26d867f-9876-433d-8db2-25d210f29309", + "rel": "self" + }, + { + "href": "https://192.168.196.47:8796/07412155bf474db9a2f697fd978593d7/shares/f26d867f-9876-433d-8db2-25d210f29309", + "rel": "bookmark" + } + ], + "availability_zone": "az1.dc1", + "share_network_id": null, + "share_server_id": null, + "share_group_id": null, + "host": "DJ38@a4588256-3880-4136-b3c9-4c3aade8a84b#a4588256-3880-4136-b3c9-4c3aade8a84b", + "revert_to_snapshot_support": null, + "access_rules_status": "active", + "snapshot_id": null, + "create_share_from_snapshot_support": null, + "is_public": true, + "task_state": null, + "snapshot_support": true, + "id": "f26d867f-9876-433d-8db2-25d210f29309", + "size": 1, + "source_share_group_snapshot_member_id": null, + "user_id": "daa3f8f8d7254465841da769298a76f6", + "name": "manila share", + "share_type": "8ae4e74e-83f4-4980-8ab8-e637f9294e0b", + "has_replicas": false, + "replication_type": null, + "created_at": "2018-12-25T08:45:22.525899", + "share_proto": "NFS", + "volume_type": "sla", + "mount_snapshot_support": null, + "project_id": "07412155bf474db9a2f697fd978593d7", + "metadata": { + "share_key": "test", + "share_used": "1", + } + } +}+
Status Codes
- Normal +
- Abnormal
++
+Status Code
+Description
+400 Bad Request
+The server failed to process the request.
+401 Unauthorized
+You must enter a username and the password to access the requested page.
+403 Forbidden
+Access to the requested page is forbidden.
+404 Not Found
+The requested page was not found.
+405 Method Not Allowed
+You are not allowed to use the method specified in the request.
+406 Not Acceptable
+The response generated by the server could not be accepted by the client.
+407 Proxy Authentication Required
+You must use the proxy server for authentication. Then the request can be processed.
+408 Request Timeout
+The request timed out.
+409 Conflict
+The request could not be processed due to a conflict.
+500 Internal Server Error
+Failed to complete the request because of an internal service error.
+501 Not Implemented
+Failed to complete the request because the server does not support the requested function.
+502 Bad Gateway
+Failed to complete the request because the request is invalid.
+503 Service Unavailable
+Failed to complete the request because the service is unavailable.
+504 Gateway Timeout
+A gateway timeout error occurred.
+
Deleting a Shared File System
+Function
This API is used to delete a shared file system.
+ This API is an asynchronous API. If the returned status code is 202, the API request is successfully delivered and received. Later, you can query the shared file system by referring to Querying Details About a Shared File System to identify whether the deletion is complete and successful.
+URI
- DELETE /v2/{project_id}/shares/{share_id}
- Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+share_id
+Yes
+String
+Specifies the ID of the shared file system.
+project_id
+Yes
+String
+Specifies the project ID of the operator.
+
Status Codes
- Normal +
- Abnormal
++
+Status Code
+Description
+400 Bad Request
+The server failed to process the request.
+401 Unauthorized
+You must enter a username and the password to access the requested page.
+403 Forbidden
+Access to the requested page is forbidden.
+404 Not Found
+The requested page was not found.
+405 Method Not Allowed
+You are not allowed to use the method specified in the request.
+406 Not Acceptable
+The response generated by the server could not be accepted by the client.
+407 Proxy Authentication Required
+You must use the proxy server for authentication. Then the request can be processed.
+408 Request Timeout
+The request timed out.
+409 Conflict
+The request could not be processed due to a conflict.
+500 Internal Server Error
+Failed to complete the request because of an internal service error.
+501 Not Implemented
+Failed to complete the request because the server does not support the requested function.
+502 Bad Gateway
+Failed to complete the request because the request is invalid.
+503 Service Unavailable
+Failed to complete the request because the service is unavailable.
+504 Gateway Timeout
+A gateway timeout error occurred.
+
Share Access Rules
+ +Adding 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.
URI
- POST /v2/{project_id}/shares/{share_id}/action?vpc_ip_base_acl={vpc_ip_base_acl}
- Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+share_id
+Yes
+String
+Specifies the ID of the shared file system.
+project_id
+Yes
+String
+Specifies the project ID of the operator.
+vpc_ip_base_acl
+No
+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.
+
Request
- Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+os-allow_access
+Yes
+Object
+Specifies the os-allow_access object.
++ If the API version ranges from 1.0 to 2.6, the top-layer parameters of the request body in the JSON format use prefix os-. If the API version is later than 2.6, prefix os- must be removed.
+ - Description of field os-allow_access
++
+Parameter
+Mandatory
+Type
+Description
+access_level
+No
+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).
+access_type
+Yes
+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.
+access_to
+Yes
+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.
NOTE:+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.
NOTICE:+- When creating a shared access rule for the IP address-based authorization scenario, the microversions of the APIs must be 2.28 or later and the vpc_ip_base_acl parameter must be added to the request URL. For details, see the following request example (which varies with the IP address-based authorization scenario).
- For an ECS in VPC A, its IP addresses can be successfully added to the authorized IP addresses of VPC B, but the file system of VPC B cannot be mounted to this ECS. The VPC used by the ECS and the file system must be the same one.
- 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:
+{ + "allow_access": { + "access_to": "0560a527-0e77-40a6-aa3b-110beecad368#0.0.0.0/0#0", + "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.
+
Response
- Parameter description
++
+Parameter
+Type
+Description
+access
+Object
+Specifies the access object. If the share access rule is not updated, this value is null.
+ - Description of the access field
++
+Parameter
+Type
+Description
+share_id
+String
+Specifies the ID of the shared file system to which the access rule is added.
+access_type
+String
+Specifies the type of the share access rule.
+access_to
+String
+Specifies the access that the back end grants or denies.
+access_level
+String
+Specifies the access level of the shared file system.
+id
+String
+Specifies the ID of the share 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.
+access_key
+String
+Specifies the access credential of the access rule. This parameter exists only when the value of X-Openstack-Manila-Api-Version in the request header is from 2.21 to 2.42.
+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.
+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.
+
- 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)
+
{ + "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#1#all_squash,root_squash", + "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" + } +}+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" + } +}+
Status Codes
- Normal +
- Abnormal
++
+Status Code
+Description
+400 Bad Request
+The server failed to process the request.
+401 Unauthorized
+You must enter a username and the password to access the requested page.
+403 Forbidden
+Access to the requested page is forbidden.
+404 Not Found
+The requested page was not found.
+405 Method Not Allowed
+You are not allowed to use the method specified in the request.
+406 Not Acceptable
+The response generated by the server could not be accepted by the client.
+407 Proxy Authentication Required
+You must use the proxy server for authentication. Then the request can be processed.
+408 Request Timeout
+The request timed out.
+409 Conflict
+The request could not be processed due to a conflict.
+500 Internal Server Error
+Failed to complete the request because of an internal service error.
+501 Not Implemented
+Failed to complete the request because the server does not support the requested function.
+502 Bad Gateway
+Failed to complete the request because the request is invalid.
+503 Service Unavailable
+Failed to complete the request because the service is unavailable.
+504 Gateway Timeout
+A gateway timeout error occurred.
+
Deleting 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.
+URI
- POST /v2/{project_id}/shares/{share_id}/action
- Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+share_id
+Yes
+String
+Specifies the ID of the shared file system.
+project_id
+Yes
+String
+Specifies the project ID of the operator.
+
Request
- Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+os-deny_access
+Yes
+Object
+Specifies the os-deny_access object.
++ If the API version ranges from 1.0 to 2.6, the top-layer parameters of the request body in the JSON format use prefix os-. If the API version is later than 2.6, prefix os- must be removed.
+ - Description of field os-deny_access
++
+Parameter
+Mandatory
+Type
+Description
+access_id
+Yes
+String
+Specifies the ID of the share access rule of the shared file system. The value contains 1 to 36 characters.
+
- Example request
{ + "os-deny_access": { + "access_id": "418e3cf4-08c3-4ed2-a29a-ceffa346b3b8" + } +}+
Status Codes
- Normal +
- Abnormal
++
+Status Code
+Description
+400 Bad Request
+The server failed to process the request.
+401 Unauthorized
+You must enter a username and the password to access the requested page.
+403 Forbidden
+Access to the requested page is forbidden.
+404 Not Found
+The requested page was not found.
+405 Method Not Allowed
+You are not allowed to use the method specified in the request.
+406 Not Acceptable
+The response generated by the server could not be accepted by the client.
+407 Proxy Authentication Required
+You must use the proxy server for authentication. Then the request can be processed.
+408 Request Timeout
+The request timed out.
+409 Conflict
+The request could not be processed due to a conflict.
+500 Internal Server Error
+Failed to complete the request because of an internal service error.
+501 Not Implemented
+Failed to complete the request because the server does not support the requested function.
+502 Bad Gateway
+Failed to complete the request because the request is invalid.
+503 Service Unavailable
+Failed to complete the request because the service is unavailable.
+504 Gateway Timeout
+A gateway timeout error occurred.
+
Querying Share Access Rules
+Function
This API is used to query a share access rule.
+URI
- POST /v2/{project_id}/shares/{share_id}/action
- Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+share_id
+Yes
+String
+Specifies the ID of the shared file system.
+project_id
+Yes
+String
+Specifies the project ID of the operator.
+
Request
- Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+os-access_list
+Yes
+Object
+Specifies the os-access_list object. To view access rules, set this value to null.
++ If the API version ranges from 1.0 to 2.6, the top-layer parameters of the request body in the JSON format use prefix os-. If the API version is later than 2.6, prefix os- must be removed.
+ - Example request
{ + "os-access_list": null +}+
Response
- Description
++
+Parameter
+Type
+Description
+access_list
+Array of objects
+Lists the access rules.
+ - Description of field access_list
++
+Parameter
+Type
+Description
+access_type
+String
+Specifies the type of the share access rule.
+access_to
+String
+Specifies the access that the back end grants or denies.
+access_level
+String
+Specifies the level 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.
+id
+String
+Specifies the ID of the share 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.
+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.
+
- Example response
{ + "access_list": [ + { + "access_level": "rw", + "state": "active", + "id": "85417bed-5e26-4c99-8c0c-92c95b5c640e", + "access_type": "cert", + "access_to": "a91556b7-c7c8-4273-915e-2729e04cdb01", + "created_at": "2017-07-07T03:15:06.858662", + "updated_at": "2018-07-07T03:15:06.858662" + }, + { + "access_level": "rw", + "state": "active", + "id": "2ecbeb0b-b2ba-41f1-ba63-0666548925b9", + "access_type": "cert", + "access_to": "0560a527-0e77-40a6-aa3b-110beecad368#0.0.0.0/0#0#all_squash,root_squash", + "created_at": "2017-07-07T03:15:06.858662", + "updated_at": "2018-07-07T03:15:06.858662" + }, + { + "access_level": "rw", + "state": "active", + "id": "24615391-d58d-4a74-ac5a-520233c9c396", + "access_type": "cert", + "access_to": "0560a527-0e77-40a6-aa3b-110beecad368#192.168.196.47#1#all_squash,root_squash", + "created_at": "2017-07-07T03:15:06.858662", + "updated_at": "2018-07-07T03:15:06.858662" + } + ] +}+
Status Codes
- Normal +
- Abnormal
++
+Status Code
+Description
+400 Bad Request
+The server failed to process the request.
+401 Unauthorized
+You must enter a username and the password to access the requested page.
+403 Forbidden
+Access to the requested page is forbidden.
+404 Not Found
+The requested page was not found.
+405 Method Not Allowed
+You are not allowed to use the method specified in the request.
+406 Not Acceptable
+The response generated by the server could not be accepted by the client.
+407 Proxy Authentication Required
+You must use the proxy server for authentication. Then the request can be processed.
+408 Request Timeout
+The request timed out.
+409 Conflict
+The request could not be processed due to a conflict.
+500 Internal Server Error
+Failed to complete the request because of an internal service error.
+501 Not Implemented
+Failed to complete the request because the server does not support the requested function.
+502 Bad Gateway
+Failed to complete the request because the request is invalid.
+503 Service Unavailable
+Failed to complete the request because the service is unavailable.
+504 Gateway Timeout
+A gateway timeout error occurred.
+
Quota Management
+Function
This API is used to query quota information.
+URI
- GET /v2/{project_id}/os-quota-sets/{project_id}
- Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+project_id
+Yes
+String
+Specifies the project ID of the operator.
+project_id
+Yes
+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.
+ - Query parameters
++
+Parameter
+Mandatory
+Type
+Description
+usage
+No
+String
+If the parameter is set to true, the current in_use and reserved counts will also be returned.
+
Request
+Response
- Parameter description
++
+Parameter
+Type
+Description
+quota_set
+Object
+Specifies the quota_set object.
+ - Description of field quota_set
++
+Parameter
+Type
+Description
+gigabytes
+Integer
+Specifies the capacity in gigabytes allowed for each tenant.
+snapshots
+Integer
+Specifies the number of snapshots allowed for each tenant.
+shares
+Integer
+Specifies the number of shared file systems allowed for each tenant.
+snapshot_gigabytes
+Integer
+Specifies the snapshot capacity in gigabytes allowed for each tenant.
+id
+String
+Specifies the ID of the tenant for which you manage quotas.
+share_networks
+Integer
+Specifies the number of share networks allowed for each tenant.
+
- Example response
{ + "quota_set": { + "gigabytes": { + "reserved": 0, + "limit": 512000, + "in_use": 645 + }, + "snapshots": { + "reserved": 0, + "limit": -1, + "in_use": 0 + }, + "snapshot_gigabytes": { + "reserved": 0, + "limit": -1, + "in_use": 0 + }, + "shares": { + "reserved": 0, + "limit": 10, + "in_use": 4 + }, + "id": "da0f615c35eb4d72812d1547a77b5394", + "share_networks": { + "reserved": 0, + "limit": 10, + "in_use": 0 + } + } +}+
Status Codes
- Normal +
- Abnormal
++
+Status Code
+Description
+400 Bad Request
+The server failed to process the request.
+401 Unauthorized
+You must enter a username and the password to access the requested page.
+403 Forbidden
+Access to the requested page is forbidden.
+404 Not Found
+The requested page was not found.
+405 Method Not Allowed
+You are not allowed to use the method specified in the request.
+406 Not Acceptable
+The response generated by the server could not be accepted by the client.
+407 Proxy Authentication Required
+You must use the proxy server for authentication. Then the request can be processed.
+408 Request Timeout
+The request timed out.
+409 Conflict
+The request could not be processed due to a conflict.
+500 Internal Server Error
+Failed to complete the request because of an internal service error.
+501 Not Implemented
+Failed to complete the request because the server does not support the requested function.
+502 Bad Gateway
+Failed to complete the request because the request is invalid.
+503 Service Unavailable
+Failed to complete the request because the service is unavailable.
+504 Gateway Timeout
+A gateway timeout error occurred.
+
Expansion and Shrinking
+ +Expanding a Shared File System
+Function
This API is used to expand the capacity of a shared file system.
+ 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 Details About a Shared File System to identify whether the shared file system is expanded successfully.
+URI
- POST /v2/{project_id}/shares/{share_id}/action
- Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+share_id
+Yes
+String
+Specifies the ID of the shared file system.
+project_id
+Yes
+String
+Specifies the project ID of the operator.
+
Request
- Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+os-extend
+Yes
+Object
+Specifies the os-extend object.
+ - Description of field os-extend
++
+Parameter
+Mandatory
+Type
+Description
+new_size
+Yes
+Integer
+Specifies the post-expansion capacity (GB) of the shared file system.
+
- Example request
{ + "os-extend": { + "new_size": 2 + } +}+
Status Codes
- Normal +
- Abnormal
++
+Status Code
+Description
+400 Bad Request
+The server failed to process the request.
+400 Bad Request
+Invalid input: The post-deduction capacity must be larger than 0 and smaller than the current capacity. (Current capacity: XX; post-deduction capacity: XX)
+400 Bad Request
+Invalid input: The post-expansion capacity must be larger than the current capacity. (Current capacity: XX; post-expansion capacity: XX)
+401 Unauthorized
+You must enter a username and the password to access the requested page.
+403 Forbidden
+Access to the requested page is forbidden.
+404 Not Found
+The requested page was not found.
+405 Method Not Allowed
+You are not allowed to use the method specified in the request.
+406 Not Acceptable
+The response generated by the server could not be accepted by the client.
+407 Proxy Authentication Required
+You must use the proxy server for authentication. Then the request can be processed.
+408 Request Timeout
+The request timed out.
+409 Conflict
+The request could not be processed due to a conflict.
+500 Internal Server Error
+Failed to complete the request because of an internal service error.
+501 Not Implemented
+Failed to complete the request because the server does not support the requested function.
+502 Bad Gateway
+Failed to complete the request because the request is invalid.
+503 Service Unavailable
+Failed to complete the request because the service is unavailable.
+504 Gateway Timeout
+A gateway timeout error occurred.
+
Shrinking a Shared File System
+Function
This API is used to shrink the capacity of a shared file system.
+ 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 Details About a Shared File System to identify whether the shared file system is shrunk successfully.
+URI
- POST /v2/{project_id}/shares/{share_id}/action
- Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+share_id
+Yes
+String
+Specifies the ID of the shared file system.
+project_id
+Yes
+String
+Specifies the project ID of the operator.
+
Request
- Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+os-shrink
+Yes
+Object
+Specifies the os-shrink object.
+ - Description of field os-shrink
++
+Parameter
+Mandatory
+Type
+Description
+new_size
+Yes
+Integer
+Specifies the post-shrinking capacity (GB) of the shared file system.
+
- Example request
{ + "os-shrink": { + "new_size": 1 + } +}+
Status Codes
- Normal +
- Abnormal
++
+Status Code
+Description
+400 Bad Request
+The server failed to process the request.
+401 Unauthorized
+You must enter a username and the password to access the requested page.
+403 Forbidden
+Access to the requested page is forbidden.
+404 Not Found
+The requested page was not found.
+405 Method Not Allowed
+You are not allowed to use the method specified in the request.
+406 Not Acceptable
+The response generated by the server could not be accepted by the client.
+407 Proxy Authentication Required
+You must use the proxy server for authentication. Then the request can be processed.
+408 Request Timeout
+The request timed out.
+409 Conflict
+The request could not be processed due to a conflict.
+500 Internal Server Error
+Failed to complete the request because of an internal service error.
+501 Not Implemented
+Failed to complete the request because the server does not support the requested function.
+502 Bad Gateway
+Failed to complete the request because the request is invalid.
+503 Service Unavailable
+Failed to complete the request because the service is unavailable.
+504 Gateway Timeout
+A gateway timeout error occurred.
+
Share Tag
+ +-
+
- Adding a Tag to a Shared File System
+
+ - Deleting a Tag from a Shared File System
+
+ - Querying Tag Information About a Shared File System
+
+ - Querying Tags of a Tenant's All Shared File Systems
+
+ - 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 the Number of Shared File Systems Based on Tags
+
+
Adding a Tag to a Shared File System
+Function
This API is used to add a tag to a specified 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
- Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+project_id
+Yes
+String
+Specifies the project ID of the operator.
+share_id
+Yes
+String
+Specifies the share ID.
+
Request
- Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+tag
+Yes
+Resource_tag
+Specifies the tag.
+ - Description of field resource_tag
++
+Parameter
+Mandatory
+Type
+Description
+key
+Yes
+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 (_).
+value
+Yes
+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 (_).
+ - Example request
{ + "tag" : { + "key" : "key1", + "value" : "value1" + } +}+
Status Codes
- Normal +
- Abnormal
++
+Status Code
+Description
+400 Bad Request
+Invalid value.
+401 Unauthorized
+Authentication failed.
+403 Forbidden
+Access to the requested page is forbidden.
+404 Not Found
+The requested resource was not found.
+500 Internal Server Error
+The request is not completed because of a service error.
+
Deleting a Tag from a Shared File System
+Function
This API is used to delete a tag from a specified shared file system.
+ If the key to be deleted does not exist in the shared file system, error 404 is returned after API calling.
+URI
- DELETE /v2/{project_id}/sfs/{share_id}/tags/{key}
- Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+project_id
+Yes
+String
+Specifies the project ID of the operator.
+share_id
+Yes
+String
+Specifies the share ID.
+key
+Yes
+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 (_).
+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.
+
Status Codes
- Normal +
- Abnormal
++
+Status Code
+Description
+400 Bad Request
+Invalid value.
+401 Unauthorized
+Authentication failed.
+403 Forbidden
+Access to the requested page is forbidden.
+404 Not Found
+The requested resource was not found.
+500 Internal Server Error
+The request is not completed because of a service error.
+
Querying Tag Information About a Shared File System
+Function
This API is used to query all tag information about the specified shared file system.
+URI
- GET /v2/{project_id}/sfs/{share_id}/tags
- Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+project_id
+Yes
+String
+Specifies the project ID of the operator.
+share_id
+Yes
+String
+Specifies the share ID.
+
Response
- Parameter description
++
+Parameter
+Type
+Description
+tags
+Array of resource_tags
+Specifies the list of tags.
+sys_tags
+Array of resource_tags
+Only the op_service permission can obtain this field.
+- Currently, only one resource_tag structure key is used, _sys_enterprise_project_id.
- Currently, key contains only one value.
This field cannot be returned in non-op_service scenarios.
+ - Description of field resource_tag
++
+Parameter
+Type
+Description
+key
+String
+Specifies the key of the tag.
+value
+String
+Specifies the value of the tag.
+
- Example response
{ + "tags": [ + { + "key": "key1", + "value": "value1" + }, + { + "key": "key2", + "value": "" + } + ] +}+ +
Status Codes
- Normal +
- Abnormal
++
+Status Code
+Description
+400 Bad Request
+Invalid value.
+401 Unauthorized
+Authentication failed.
+403 Forbidden
+Access to the requested page is forbidden.
+404 Not Found
+The requested resource was not found.
+500 Internal Server Error
+The request is not completed because of a service error.
+
Querying 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.
+URI
- GET /v2/{project_id}/sfs/tags
- Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+project_id
+Yes
+String
+Specifies the project ID of the operator.
+
Response
- Parameter description
++
+Parameter
+Type
+Description
+tags
+Array of tags
+Specifies the list of tags.
+ - Description of the tag field
++
+Parameter
+Type
+Description
+key
+String
+Specifies the key of the tag.
+values
+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.
+
- Example response
{ + "tags" : [ { + "key" : "key1", + "values" : [ "value1", "" ] + }, { + "key" : "key2", + "values" : [ "value1", "value2" ] + } ] +}+
Status Codes
- Normal +
- Abnormal
++
+Status Code
+Description
+400 Bad Request
+Invalid value.
+401 Unauthorized
+Authentication failed.
+403 Forbidden
+Access to the requested page is forbidden.
+404 Not Found
+The requested resource was not found.
+500 Internal Server Error
+The request is not completed because of a service error.
+
Batch Adding Tags to a Shared File System
+Function
This API is used to batch add tags to a specified 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
+Mandatory
+Type
+Description
+project_id
+Yes
+String
+Specifies the project ID of the operator.
+share_id
+Yes
+String
+Specifies the share ID.
+
Request
- Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+action
+Yes
+String
+Specifies the operation identifier. Possible values are create and delete. Use create to batch add tags to a specified shared file system.
+tags
+No
+Array of resource_tags
+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
+No
+Array of resource_tags
+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.
+The value is ID or 0.
+ - Description of field resource_tag
++
+Parameter
+Mandatory
+Type
+Description
+key
+Yes
+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 (_).
+value
+Yes
+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 (_).
+ - Example request
{ + "action": "create", + "tags": [ + { + "key": "key1", + "value": "value1" + }, + { + "key": "key2", + "value": "value2" + } + ] +}+
Status Codes
- Normal +
- Abnormal
++
+Status Code
+Description
+400 Bad Request
+Invalid value.
+401 Unauthorized
+Authentication failed.
+403 Forbidden
+Access to the requested page is forbidden.
+404 Not Found
+The requested resource was not found.
+500 Internal Server Error
+The request is not completed because of a service error.
+
Batch Deleting Tags from a Shared File System
+Function
This API is used to batch delete tags from a specified shared file system.
+This API is idempotent. If the tags to be deleted do not exist on the shared file system, the deletion is regarded as successful by default.
+URI
- POST /v2/{project_id}/sfs/{share_id}/tags/action
- Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+project_id
+Yes
+String
+Specifies the project ID of the operator.
+share_id
+Yes
+String
+Specifies the share ID.
+
Request
- Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+action
+Yes
+String
+Specifies the operation identifier. Possible values are create and delete. Use delete to batch delete tags from a specified shared file system.
+tags
+Yes
+Array of resource_tags
+Specifies the tag list.
+ - Description of field resource_tag
++
+Parameter
+Mandatory
+Type
+Description
+key
+Yes
+String
+Specifies the key of the tag.
+The value can contain a maximum of 36 characters. This parameter cannot be left blank.
+value
+No
+String
+Specifies the value of the tag.
+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.
+ - Example request
{ + "action": "delete", + "tags": [ + { + "key": "key1", + "value": "value1" + }, + { + "key": "key2" + }, + { + "key": "key3", + "value": "" + } + ] +}+
Status Codes
- Normal +
- Abnormal
++
+Status Code
+Description
+400 Bad Request
+Invalid value.
+401 Unauthorized
+Authentication failed.
+403 Forbidden
+Access to the requested page is forbidden.
+404 Not Found
+The requested resource was not found.
+500 Internal Server Error
+The request is not completed because of a service error.
+
Querying 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.
+URI
- POST /v2/{project_id}/sfs/resource_instances/action
- Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+project_id
+Yes
+String
+Specifies the project ID of the operator.
+
Request
- Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+offset
+No
+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
+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.
+action
+Yes
+String
+Specifies the operation identifier. Possible values are filter and count.
+Use filter to query details of a shared file system using tags.
+matches
+No
+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.
+tags
+No
+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
+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
+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
+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
+Array of tags
+Only the op_service permission can use this field to filter resources.
+- Currently, TMS can invoke only one tag structure key, _sys_enterprise_project_id.
- Currently, key contains only one value.
- sys_tags and tenant tag filtering conditions (tags, tags_any, not_tags, and not_tags_any) cannot be used at the same time.
+ In the request parameters, tag search fields tags, tags_any, not_tags, and not_tags_any are optional and can be combined with each other. Such tag search fields are in the AND relationship.
+ - Description of the match field
++
+Parameter
+Mandatory
+Type
+Description
+key
+Yes
+String
+Specifies the key. The value is fixed to resource_name.
+value
+Yes
+String
+Specifies the value. value indicates the name of a shared file system. An empty string specifies an exact match and only shared file systems whose names are empty can be queried. A non-empty string specifies a fuzzy query (case insensitive). The value can contain a maximum of 255 characters.
+ - Description of the tag field
++
+Parameter
+Mandatory
+Type
+Description
+key
+Yes
+String
+Specifies the key of the tag. A tag key can contain a maximum of 127 characters. This parameter cannot be left blank.
+values
+Yes
+Array of strings
+Lists the values. Each value can contain a maximum of 255 characters. If the value is left empty, any value is matched. The values are in the OR relationship.
+ - Example request
{ + "offset": "0", + "limit": "100", + "action": "filter", + "matches": [{ + "key": "resource_name", + "value": "share_name" + }], + "tags": [{ + "key": "key1", + "values": ["value2"] + }, { + "key": "key2", + "values": [] + }], + "tags_any": [{ + "key": "key3", + "values": ["value3"] + }, { + "key": "key4", + "values": [] + }], + "not_tags": [{ + "key": "key5", + "values": ["value5"] + }, { + "key": "key6", + "values": [] + }], + "not_tags_any": [{ + "key": "key7", + "values": ["value7", "value8"] + }, { + "key": "key9", + "values": [] + }] +}+
- Example request (without passing matches)
{ + "offset": "0", + "limit": "100", + "action": "filter", + "tags": [{ + "key": "key1", + "values": ["value2"] + }, { + "key": "key2", + "values": [] + }] +}+ - Example request (without passing limit and offset)
{ + "action": "filter", + "matches": [{ + "key": "resource_name", + "value": "share_name" + }], + "tags": [{ + "key": "key1", + "values": ["value2"] + }, { + "key": "key2", + "values": [] + }] +}+
- Example request (without passing tags, not_tags, tags_any, and not_tags_any)
{ + "offset": "0", + "limit": "100", + "action": "filter", + "matches": [{ + "key": "resource_name", + "value": "share_name" + }] +}+
- Example request (with the action field only)
{ + "action": "filter" +}+
Response
- Parameter description
++
+Parameter
+Type
+Description
+resources
+Array of resources
+Specifies the list of shared file systems that meet the query criteria.
+total_count
+Integer
+Specifies the total number of shared file systems that meet the query criteria.
+NOTE:+total_count specifies the total number of shared file systems that meet the query criteria, instead of the number returned after you set offset and limit.
+ - Data structure of the resource field
++
+Parameter
+Type
+Description
+resource_id
+String
+Specifies the share ID.
+resource_detail
+Object
+Specifies the share details. The value is a resource object, used for extension. This value is left empty by default.
+tags
+Array of resource_tags
+Specifies the list of tags. If no tags exist, the value is an empty array by default.
+sys_tags
+Array of tags
+Only the op_service permission can obtain this field.
+- Currently, only one tag structure key is used, _sys_enterprise_project_id.
- Currently, key contains only one value.
This field cannot be returned in non-op_service scenarios.
+resource_name
+String
+Specifies the resource name.
+ - Data structure of the resource_tag field
++
+Parameter
+Type
+Description
+key
+String
+Specifies the key of the tag. The value can contain a maximum of 36 characters. This parameter cannot be left blank. It can only contain letters, digits, hyphens (-), and underscores (_).
+value
+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 (_).
+
- Example response
{ + "resources":[ + { + "resource_detail":{}, + "resource_id":"b1f3f06f-344d-446b-a4bf-647a225debae", + "resource_name":"share_name", + "tags":[ + { + "key":"key1", + "value": "value1" + }, + { + "key":"key2", + "value": "value2" + } + ] + } + ], + "total_count":1 +}+
Status Codes
- Normal +
- Abnormal
++
+Status Code
+Description
+400 Bad Request
+Invalid value.
+401 Unauthorized
+Authentication failed.
+403 Forbidden
+Access to the requested page is forbidden.
+404 Not Found
+The requested resource was not found.
+500 Internal Server Error
+The request is not completed because of a service error.
+
Querying the Number of Shared File Systems Based on Tags
+Function
This API is used to query the number of shared file systems based on tags.
+URI
- POST /v2/{project_id}/sfs/resource_instances/action
- Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+project_id
+Yes
+String
+Specifies the project ID of the operator.
+
Request
- Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+action
+Yes
+String
+Specifies the operation identifier. Possible values are filter and count.
+Use count to query the number of share instances based on tags.
+matches
+No
+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.
+tags
+No
+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
+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
+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
+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
+Array of tags
+Only the op_service permission can use this field to filter resources.
+- Currently, TMS can invoke only one tag structure key, _sys_enterprise_project_id.
- Currently, key contains only one value.
- sys_tags and tenant tag filtering conditions (tags, tags_any, not_tags, and not_tags_any) cannot be used at the same time.
+ + In the request parameters, tag search fields tags, tags_any, not_tags, and not_tags_any are optional and can be combined with each other. Such tag search fields are in the AND relationship.
+ - Description of the match field
++
+Parameter
+Mandatory
+Type
+Description
+key
+Yes
+String
+Specifies the key. The value is fixed to resource_name.
+value
+Yes
+String
+Specifies the value. value indicates the name of a shared file system. An empty string specifies an exact match and only shared file systems whose names are empty can be queried. A non-empty string specifies a fuzzy query (case insensitive). The value can contain a maximum of 255 characters.
+ - Description of the tag field
++
+Parameter
+Mandatory
+Type
+Description
+key
+Yes
+String
+Specifies the key of the tag. A tag key can contain a maximum of 127 characters. This parameter cannot be left blank.
+values
+Yes
+Array of strings
+Lists the values. Each value can contain a maximum of 255 characters. If the value is left empty, any value is matched. The values are in the OR relationship.
+ - Example request
{ + "action": "count", + "matches": [{ + "key": "resource_name", + "value": "share_name" + }], + "tags": [{ + "key": "key1", + "values": ["value2"] + }, { + "key": "key2", + "values": [] + }], + "tags_any": [{ + "key": "key3", + "values": ["value3"] + }, { + "key": "key4", + "values": [] + }], + "not_tags": [{ + "key": "key5", + "values": ["value5"] + }, { + "key": "key6", + "values": [] + }], + "not_tags_any": [{ + "key": "key7", + "values": ["value7", "value8"] + }, { + "key": "key9", + "values": [] + }] +}+
- Example request (without passing matches)
{ + "action": "count", + "tags": [{ + "key": "key1", + "values": ["value2"] + }, { + "key": "key2", + "values": [] + }] +}+ - Example request (without passing tags, not_tags, tags_any, and not_tags_any)
{ + "action": "count", + "matches": [{ + "key": "resource_name", + "value": "share_name" + }] +}+
- Example request (with the action field only)
{ + "action": "count" +}+
Response
- Parameter description
++
+Parameter
+Type
+Description
+total_count
+Integer
+Specifies the total number of shared file systems that meet the query criteria.
+
- Example response
{ + "total_count":1 +}+
Status Codes
- Normal +
- Abnormal
++
+Status Code
+Description
+400 Bad Request
+Invalid value.
+401 Unauthorized
+Authentication failed.
+403 Forbidden
+Access to the requested page is forbidden.
+404 Not Found
+The requested resource was not found.
+500 Internal Server Error
+The request is not completed because of a service error.
+
SFS Turbo APIs
+ +Life Cycle Management
+ +-
+
- Creating a File System
+
+ - Deleting a File System
+
+ - Querying Details About All File Systems
+
+ - Querying Details About a Single File System
+
+
Creating a File System
+Function
This API is used to create an SFS Turbo file system.
+URI
- URI format +
- Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+project_id
+Yes
+String
+Specifies the project ID. For details about how to obtain the project ID, see API Usage Guidelines.
+
Request
- Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+share
+Yes
+Object
+Specifies information about an SFS Turbo file system. For details about the parameters, see the description of the share field.
+ - Description of the share field
++
+Parameter
+Mandatory
+Type
+Description
+name
+Yes
+String
+Specifies the name of an SFS Turbo file system. The value contains 4 to 64 characters and must start with a letter. This value can contain letters (case insensitive), digits, hyphens (-), and underscores (_), and cannot contain other special characters.
+share_proto
+Yes
+String
+Specifies the protocol for sharing file systems. The valid value is NFS. Network File System (NFS) is a distributed file system protocol that allows different computers and operating systems to share data over a network.
+share_type
+Yes
+String
+Specifies the file system type. The valid values are STANDARD and PERFORMANCE
+STANDARD: Standard file system, corresponding to the media of SAS disks.
+PERFORMANCE: Performance file system, corresponding to the media of SSD disks.
+size
+Yes
+Int
+For a common file system, the value of capacity ranges from 500 to 32768 (in the unit of GB).
+For an enhanced file system where the expand_type field is specified for metadata, the capacity ranges from 10240 to 327680. For details about metadata, see Description of the metadata field.
+availability_zone
+Yes
+String
+Specifies the code of the AZ where the file system is located. For details about the code, see Regions and Endpoints.
+vpc_id
+Yes
+String
+Specifies the VPC ID of a tenant in a region. You can obtain the VPC ID from the console or by following the instructions provided in "Querying VPCs" in Virtual Private Cloud API Reference.
+subnet_id
+Yes
+String
+Specifies the network ID of the subnet of a tenant in a VPC. You can obtain the network ID from the VPC console or by following the instructions provided in "Querying Subnets" in Virtual Private Cloud API Reference.
+security_group_id
+Yes
+String
+Specifies the security group ID of a tenant in a region. You can obtain the security group ID from the console or by following the instructions provided in "Querying Security Groups" in Virtual Private Cloud API Reference.
+backup_id
+No
+String
+Specifies the backup ID. This parameter is mandatory when you create a file system from a backup. This is not supported by the current version.
+description
+No
+String
+Specifies the file system description. The length is 0-255 characters. This is not supported by the current version.
+metadata
+No
+Object
+Specifies the metadata information used to create the file system. The value consists of one or more key and value pairs organized as a dictionary of strings. For details about the parameters, see the description of field metadata.
+ - Description of the metadata field
++
+Parameter
+Mandatory
+Type
+Description
+expand_type
+No
+String
+Specifies the extension type. The current valid value is bandwidth, indicating that an enhanced file system is created. For details about the differences between different types of SFS Turbo file systems, see "Recommended Configurations".
+crypt_key_id
+No
+String
+Specifies the ID of a KMS professional key when an encrypted file system is created. The key ID can be obtained from the console of Data Encryption Workshop (DEW) or by referring to section "Querying the Information About a CMK" in the Data Encryption Workshop API Reference.
+
- The regions mentioned above are the same region. Currently, cross-region configuration is not supported.
- SFS Turbo will create two private IP addresses and one virtual IP address under the subnet you specified.
- To ensure normal use, SFS Turbo will enable the inbound rules for ports 111, 445, 2049, 2051, 2052, and 20048 in the security group you specified.
- An ECS cannot access file systems on VPCs other than the one where the ECS resides. Make sure that you enter the ID of the VPC when creating a file system to be the VPC where the ECS resides for mounting the file system.
- Example request
{ + "share": { + "name": "sfs-turbo-test", + "share_proto": "NFS", + "share_type": "STANDARD", + "size": 100, + "availability_zone": "az1", + "vpc_id": "d651ea2b-2b20-4c6d-8bbf-2adcec18dac9", + "subnet_id": "b8884abe-f47b-4917-9f6c-f64825c365db", + "security_group_id": "8c4ebbd0-6edf-4aae-8353-81ce6d06e1f4", + "metadata": { + "crypt_key_id": "015bf4b8-73cc-4235-8595-46931de7dfd0" + } + } +}+
Response
- Parameter description
++
+Parameter
+Type
+Description
+id
+String
+Specifies the ID of an SFS Turbo file system.
+name
+String
+Specifies the name of an SFS Turbo file system.
+status
+String
+Specifies the status of an SFS Turbo file system. For details, see SFS Turbo File System Statuses.
+
- Example response
{ + "id": "708c017c-54b5-429a-a098-7692e23fa518", + "name": "sfs-turbo-test", + "status": "100" +}+
Deleting a File System
+Function
This API is used to delete an SFS Turbo file system.
+URI
- URI format +
- Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+project_id
+Yes
+String
+Specifies the project ID. For details about how to obtain the project ID, see API Usage Guidelines.
+share_id
+Yes
+String
+Specifies the ID of an SFS Turbo file system.
+
Request
- None
Response
- None
Querying Details About All File Systems
+Function
This API is used to query details about all SFS Turbo file systems.
+URI
- URI format
GET /v1/{project_id}/sfs-turbo/shares/detail?limit={limit}&offset={offset}
+ - Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+project_id
+Yes
+String
+Specifies the project ID. For details about how to obtain the project ID, see API Usage Guidelines.
+limit
+No (query parameter)
+Int
+Specifies the number of returned file systems.
+This parameter takes effect when both limit and offset are used.
+offset
+No (query parameter)
+Int
+Specifies the offset of the number of queried file systems.
+This parameter takes effect when both limit and offset are used.
+
Response
- Parameter description
++
+Parameter
+Type
+Description
+shares
+Array of objects
+Specifies the list of SFS Turbo file systems. For details, see the description of the share field.
+count
+Int
+Specifies the number of SFS Turbo file systems.
+ - Description of the share field
++
+Parameter
+Type
+Description
+id
+String
+Specifies the ID of an SFS Turbo file system.
+name
+String
+Specifies the name of the SFS Turbo file system.
+status
+String
+Specifies the SFS Turbo file system status. For details, see SFS Turbo File System Statuses.
+sub_status
+String
+Specifies the SFS Turbo sub-status. For details, see SFS Turbo File System Substatuses.
+version
+String
+Specifies the version ID of an SFS Turbo file system.
+created_at
+String
+Specifies the creation time. UTC time, for example: 2018-11-19T04:02:03
+export_location
+String
+Specifies the mount point of the SFS Turbo file system.
+action_progress
+Object
+Specifies the creation progress of the SFS Turbo file system. For details, see Description of field action_progress.
+share_type
+String
+Specifies the type of the SFS Turbo file system. The value can be STANDARD or PERFORMANCE.
+region
+String
+Specifies the region of the SFS Turbo file system.
+availability_zone
+String
+Specifies the code of the AZ where the SFS Turbo file system is located.
+az_name
+String
+Specifies the name of the AZ where the SFS Turbo file system is located.
+vpc_id
+String
+Specifies the VPC ID specified by the user.
+subnet_id
+String
+Specifies the network ID of the subnet specified by the user.
+security_group_id
+String
+Specifies the ID of a security group specified by the user.
+crypt_key_id
+String
+Specifies the ID of the encryption key specified by the user. This parameter is not returned for non-encrypted disks.
+size
+String
+Specifies the total capacity of the SFS Turbo file system in the unit of GB.
+pay_model
+String
+Billing mode of the SFS Turbo file system.
+avail_capacity
+String
+Specifies the available capacity of the SFS Turbo file system in the unit of GB.
+share_proto
+String
+Specifies the protocol type of the SFS Turbo file system. The current value is NFS.
+expand_type
+String
+For an enhanced file system, bandwidth is returned for this field. Otherwise, bandwidth is not returned.
+ - Description of field action_progress
Parameter + |
+Type + |
+Description + |
+
|---|---|---|
CREATING + |
+string + |
+Specifies the file system creation progress. + |
+
- Example response
{ + "shares": [ + { + "id": "8fba8253-c914-439d-ae8b-d5c89d0bf5e8", + "name": "sfs-turbo-8468", + "status": "200", + "version": "1.0.0", + "region": "north-1", + "created_at": "2018-11-19T04:02:03", + "export_location": "192.168.0.90:/", + "action_progress": {}, + "share_type": "STANDARD", + "sub_status": "230", + "availability_zone": "az1.dc1", + "az_name": "az1", + "vpc_id": "b24e39e1-bc0c-475b-ae0c-aef9cf240af3", + "subnet_id": "86fc01ea-8ec8-409d-ba7a-e0ea16d4fd97", + "security_group_id": "50586458-aec9-442c-bb13-e08ddc6f1b7a", + "size": "500.00", + "pay_model": "0", + "avail_capacity": "500.00", + "share_proto": "NFS" + }, + { + "id": "65f2d30b-7b4e-4786-9608-4324faef6646", + "name": "sfs-turbo-df12", + "status": "200", + "version": "1.0.0", + "actions": [], + "region": "north-1", + "created_at": "2018-11-15T02:32:10", + "export_location": "192.168.0.197:/", + "action_progress": {}, + "share_type": "STANDARD", + "availability_zone": "az1.dc1", + "az_name": "az1", + "vpc_id": "b24e39e1-bc0c-475b-ae0c-aef9cf240af3", + "subnet_id": "86fc01ea-8ec8-409d-ba7a-e0ea16d4fd97", + "security_group_id": "50586458-aec9-442c-bb13-e08ddc6f1b7a", + "size": "500.00", + "pay_model": "0", + "avail_capacity": "500.00", + "share_proto": "NFS" + } + ] + "count": 2 +}+
Querying Details About a Single File System
+Function
This API is used to query details about an SFS Turbo file system.
+URI
- URI format +
- Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+project_id
+Yes
+String
+Specifies the project ID. For details about how to obtain the project ID, see API Usage Guidelines.
+share_id
+Yes
+String
+Specifies the ID of an SFS Turbo file system.
+
Response
- Parameter description
++
+Parameter
+Type
+Description
+id
+String
+Specifies the ID of an SFS Turbo file system.
+name
+String
+Specifies the name of the SFS Turbo file system.
+status
+String
+Specifies the SFS Turbo file system status. For details, see SFS Turbo File System Statuses.
+sub_status
+String
+Specifies the SFS Turbo sub-status. For details, see SFS Turbo File System Substatuses.
+version
+String
+Specifies the version ID of an SFS Turbo file system.
+created_at
+String
+Specifies the creation time. UTC time, for example: 2018-11-19T04:02:03
+export_location
+String
+Specifies the mount point of the SFS Turbo file system.
+action_progress
+Object
+Specifies the creation progress of the SFS Turbo file system. For details, see Description of field action_progress.
+share_type
+String
+Specifies the type of the SFS Turbo file system. The value can be STANDARD or PERFORMANCE.
+region
+String
+Specifies the region of the SFS Turbo file system.
+availability_zone
+String
+Specifies the code of the AZ where the SFS Turbo file system is located.
+az_name
+String
+Specifies the name of the AZ where the SFS Turbo file system is located.
+vpc_id
+String
+Specifies the VPC ID specified by the user.
+subnet_id
+String
+Specifies the network ID of the subnet specified by the user.
+security_group_id
+String
+Specifies the ID of a security group specified by the user.
+crypt_key_id
+String
+Specifies the ID of the encryption key specified by the user. This parameter is not returned for non-encrypted disks.
+size
+String
+Specifies the total capacity of the SFS Turbo file system in the unit of GB.
+avail_capacity
+String
+Specifies the available capacity of the SFS Turbo file system in the unit of GB.
+pay_model
+String
+Billing mode of the SFS Turbo file system.
+share_proto
+String
+Specifies the protocol type of the SFS Turbo file system. The current value is NFS.
+expand_type
+String
+For an enhanced file system, bandwidth is returned for this field. Otherwise, bandwidth is not returned.
+ - Description of field action_progress + +
- Example response
{ + "id": "8fba8253-c914-439d-ae8b-d5c89d0bf5e8", + "name": "sfs-turbo-8468", + "status": "200", + "version": "1.0.0", + "region": "north-1", + "created_at": "2018-11-19T04:02:03", + "export_location": "192.168.0.90:/", + "action_progress": {}, + "share_type": "STANDARD", + "sub_status": "330", + "availability_zone": "az1.dc1", + "az_name": "az1", + "vpc_id": "b24e39e1-bc0c-475b-ae0c-aef9cf240af3", + "subnet_id": "86fc01ea-8ec8-409d-ba7a-e0ea16d4fd97", + "security_group_id": "50586458-aec9-442c-bb13-e08ddc6f1b7a", + "size": "500.00", + "avail_capacity": "500.00", + + "share_proto": "NFS" +}+
Storage Capacity Management
+ +Expanding the Capacity of a File System
+Function
This API is used to expand the capacity of an SFS Turbo file system. Capacity expansion is an asynchronous operation. You can check whether the expansion is successful by checking field sub_status returned by Querying Details About a Single File System. If the value of the sub-status is 221, the expansion is successful.
+URI
- URI format +
- Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+project_id
+Yes
+String
+Specifies the project ID. For details about how to obtain the project ID, see API Usage Guidelines.
+share_id
+Yes
+String
+Specifies the ID of an SFS Turbo file system.
+
Request
- Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+extend
+Yes
+Object
+Specifies the extend object. For details, see the parameter in the extend field.
+ - Parameter in the extend field
++
+Parameter
+Mandatory
+Type
+Description
+new_size
+Yes
+Int
+Specifies the post-expansion capacity (GB) of the shared file system. The capacity expansion step is greater than or equal to 100 GB.
+For a common file system, the value of capacity ranges from 500 to 32768.
+For an enhanced file system, the value of capacity ranges from 10240 to 327680.
+
- Example request
{ + "extend": { + "new_size": 500 + } +}+
Response
- Parameter description
++
+Parameter
+Type
+Description
+id
+String
+Specifies the ID of an SFS Turbo file system.
+name
+String
+Specifies the name of an SFS Turbo file system.
+
- Example response
{ + "id": "67d4bd5e-7b2f-4c24-9a0b-c0038940c6f8", + "name": "sfs-turbo-cts" +}+ +
Share Tag
+-
+
- Creating a Tag
+
+ - Deleting a Tag from a Shared File System
+
+ - Querying Tag Information About a Shared File System
+
+ - Batch Adding Tags to a Shared File System
+
+ - Querying All Tags of a Tenant's Shared File Systems
+
+ - Querying Details About a Shared File System Based on Tags
+
+
Creating a Tag
+Function
This API is used to add a tag to a specified 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 /v1/{project_id}/sfs-turbo/{share_id}/tags
- Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+project_id
+Yes
+string
+Specifies the project ID of the operator.
+share_id
+Yes
+string
+Specifies the ID of the shared file system.
+
Request
- Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+tag
+Yes
+Object
+Specifies the tag. For details, see Description of field resource_tag.
+
- Description of field resource_tag
++
+Parameter
+Mandatory
+Type
+Description
+key
+Yes
+string
+Specifies the key of the tag. The value can contain a maximum of 36 characters. This parameter cannot be left empty. It cannot contain the following characters: ASCII (0-31), asterisks (*), left angle brackets (<), right angle brackets (>), backslashes (\), equal signs (=), commas (,), vertical bars (|), and slashes (/). It can contain only letters, digits, hyphens (-), and underscores (_).
+value
+Yes
+string
+Specifies the value of the tag. The value contains a maximum of 43 characters and can be an empty string. It cannot contain ASCII (0-31) or the following characters: =*<>\,|/ It can contain only letters, digits, hyphens (-), and underscores (_).
+
- Example request
{ + "tag":{ + "key":"key1", + "value":"value1" + } +}+
Status Codes
- Normal +
- Abnormal
++
+Status Code
+Description
+400 Bad Request
+Invalid value.
+401 Unauthorized
+Authentication failed.
+403 Forbidden
+Access to the requested page is forbidden.
+404 Not Found
+The requested resource was not found.
+500 Internal Server Error
+Failed to complete the request, because of a service error.
+
Deleting a Tag from a Shared File System
+Function
This API is used to delete a tag from a specified shared file system.
+ If the key to be deleted does not exist in the shared file system, error 404 is returned after API calling.
+URI
- DELETE /v1/{project_id}/sfs-turbo/{share_id}/tags/{key}
- Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+project_id
+Yes
+string
+Specifies the project ID of the operator.
+share_id
+Yes
+string
+Specifies the ID of the shared file system.
+key
+Yes
+string
+Specifies the key of the tag. The value can contain a maximum of 36 characters. This parameter cannot be left empty. It cannot contain the following characters: ASCII (0-31), asterisks (*), left angle brackets (<), right angle brackets (>), backslashes (\), equal signs (=), commas (,), vertical bars (|), and slashes (/). It can contain only letters, digits, hyphens (-), and underscores (_).
+NOTE:+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.
+
Status Codes
- Normal +
- Abnormal
++
+Status Code
+Description
+400 Bad Request
+Invalid value.
+401 Unauthorized
+Authentication failed.
+403 Forbidden
+Access to the requested page is forbidden.
+404 Not Found
+The requested resource was not found.
+500 Internal Server Error
+Failed to complete the request, because of a service error.
+
Querying Tag Information About a Shared File System
+Function
This API is used to query information of all tags about the specified shared file system.
+URI
- GET /v1/{project_id}/sfs-turbo/{share_id}/tags
- Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+project_id
+Yes
+string
+Specifies the project ID of the operator.
+share_id
+Yes
+string
+Specifies the ID of the shared file system.
+
Response
- Parameter description
++
+Parameter
+Type
+Description
+tags
+List<resource_tag>
+Specifies the tag list. For details, see Description of field resource_tag.
+sys_tags
+List<resource_tag>
+Only the op_service permission can obtain this field.
+- Currently, only one resource_tag structure key is used, _sys_enterprise_project_id.
- Currently, key contains only one value. 0 indicates the default enterprise project.
This field cannot be returned in non-op_service scenarios.
+For details, see Description of field resource_tag.
+
- Description of field resource_tag + +
- Example response
{ + "tags": [ + { + "key": "key1", + "value": "value1" + }, + { + "key": "key2", + "value": "" + } + ] + }+
Status Codes
- Normal +
- Abnormal
++
+Status Code
+Description
+400 Bad Request
+Invalid value.
+401 Unauthorized
+Authentication failed.
+403 Forbidden
+Access to the requested page is forbidden.
+404 Not Found
+The requested resource was not found.
+500 Internal Server Error
+Failed to complete the request, because of a service error.
+
Batch Adding Tags to a Shared File System
+Function
This API is used to batch add tags to a specified 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 /v1/{project_id}/sfs-turbo/{share_id}/tags/action
- Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+project_id
+Yes
+String
+Specifies the project ID of the operator.
+share_id
+Yes
+String
+Specifies the ID of the shared file system.
+
Request
- Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+action
+Yes
+String
+Specifies the operation identifier. Possible values are create and delete. Use create to batch add tags to a specified shared file system.
+tags
+No
+list<resource_tag>
+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. For details, see Description of field resource_tag.
+sys_tags
+No
+List<resource_tag>
+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.
+The value is ID or 0. 0 indicates the enterprise project by default.
+For details, see Description of field resource_tag.
+
- Description of field resource_tag
++
+Parameter
+Mandatory
+Type
+Description
+key
+Yes
+String
+Specifies the key of the tag. The value can contain a maximum of 36 characters. This parameter cannot be left empty. It cannot contain the following characters: ASCII (0-31), asterisks (*), left angle brackets (<), right angle brackets (>), backslashes (\), equal signs (=), commas (,), vertical bars (|), and slashes (/). It can contain only letters, digits, hyphens (-), and underscores (_).
+value
+Yes
+String
+Specifies the value of the tag. The value contains a maximum of 43 characters and can be an empty string. It cannot contain ASCII (0-31) or the following characters: =*<>\,|/ It can contain only letters, digits, hyphens (-), and underscores (_).
+
- Example request
{ + "action": "create", + "tags": [ + { + "key": "key1", + "value": "value1" + }, + { + "key": "key2", + "value": "value2" + } + ] + }+
Status Codes
- Normal +
- Abnormal
++
+Status Code
+Description
+400 Bad Request
+Invalid value.
+401 Unauthorized
+Authentication failed.
+403 Forbidden
+Access to the requested page is forbidden.
+404 Not Found
+The requested resource was not found.
+500 Internal Server Error
+Failed to complete the request, because of a service error.
+
Common Parameters
+ + + diff --git a/docs/sfs/api-ref/sfs_02_0085.html b/docs/sfs/api-ref/sfs_02_0085.html new file mode 100644 index 00000000..e9234d7a --- /dev/null +++ b/docs/sfs/api-ref/sfs_02_0085.html @@ -0,0 +1,51 @@ + + +SFS Turbo File System Statuses
+- SFS Turbo file system status elements
++
+Returned Value
+Description
+100
+CREATING: The file system is being created.
+200
+ACTIVE: The file system is active. An SFS Turbo file system can be mounted in this status.
+300
+FAILED: The job failed.
+303
+CREATE_FAILED: The cluster failed to be created.
+400
+DELETED: The cluster has been deleted.
+800
+FROZEN: The cluster has been frozen.
+
SFS Turbo File System Substatuses
+- SFS Turbo file system substatus elements
++
+Returned Value
+Description
+121
+Expanding the capacity online.
+221
+Online capacity expansion succeeded.
+321
+Failed to perform online capacity expansion.
+
Appendix
+ +-
+
- Status Codes
+
+ - Error Codes
+
+
Status Codes
+- Normal
++
+Returned Value
+Description
+200 OK
+Specifies the normal response for the GET and PUT operations.
+201 Created
+Specifies the normal response for the POST operation.
+202 Accepted
+The request has been accepted for processing.
+204 No Content
+Specifies the normal response for the DELETE operation.
+ - Abnormal
++
+Returned Value
+Description
+400 Bad Request
+The server failed to process the request.
+401 Unauthorized
+You must enter a username and the password to access the requested page.
+403 Forbidden
+Access to the requested page is forbidden.
+404 Not Found
+The requested page was not found.
+405 Method Not Allowed
+You are not allowed to use the method specified in the request.
+406 Not Acceptable
+The response generated by the server could not be accepted by the client.
+407 Proxy Authentication Required
+You must use the proxy server for authentication. Then the request can be processed.
+408 Request Timeout
+The request timed out.
+409 Conflict
+The request could not be processed due to a conflict.
+500 Internal Server Error
+The request is not completed because of a service error.
+501 Not Implemented
+The request is not completed because the server does not support the requested function.
+502 Bad Gateway
+The request is not completed because the server receives an invalid response from an upstream server.
+503 Service Unavailable
+The request is not completed because the service is unavailable.
+504 Gateway Timeout
+A gateway timeout error occurred.
+
Change History
+Released On + |
+Description + |
+
|---|---|
2021-05-17 + |
+Updated the following content: +Deleted the useless parameters in section "Creating a Shared File System." + |
+
2021-04-30 + |
+Updated the following content: +Added description of the expand_type field in section "Creating a File System." + |
+
2021-03-16 + |
+Updated the following content: +Deleted the capacity range description of file systems created by OBT users in section "Creating a File System." + |
+
2020-12-18 + |
+Updated the following content: +Updated the examples in section "Querying Details About All File Systems." + |
+
2020-12-15 + |
+Updated the following content: +
|
+
2020-12-02 + |
+Updated the following content: +Modified the description of parameter access_type in section "Adding Share Access Rules." + |
+
2020-11-27 + |
+Updated the following content: +Modified the example value in section "Adding Share Access Rules." + |
+
2020-10-10 + |
+Updated the following content: +Added the description of APIs related to tags for shared SFS Turbo file systems. + |
+
2020-06-18 + |
+Updated the following content: +Modified the response example in section "Quota Management." + |
+
2020-06-16 + |
+Updated the following content: +Added the description and request example of the usage parameter in section "Quota Management." + |
+
2020-05-27 + |
+Updated the following content: +
|
+
2020-05-06 + |
+Updated the following content: +Added parameter description in section "Creating a File System." + |
+
2019-10-24 + |
+Updated the following content: +Fixed the links in section "Querying Details About All File Systems" and section "Expanding the Capacity of a File System." + |
+
2019-09-30 + |
+First time that SFS Turbo file systems go online + |
+
2019-05-15 + |
+Updated the following content: +Modified the URI from v1 to v2 in section "Expanding a Shared File System." + |
+
2019-03-30 + |
+Updated the following content: +Added relevant parameters and code examples for the CIFS protocol in sections "Creating a Shared File System", "Querying Mount Locations of a Shared File System", and "Adding Share Access Rules." + |
+
2019-02-03 + |
+Updated the following content: +Accepted in OTC-4.0/Agile. + |
+
2019-01-25 + |
+Updated the following content: +
|
+
2018-12-30 + |
+Updated the following content: +
|
+
2018-05-28 + |
+Updated the following content: +Accepted in OTC 3.1. + |
+
2018-05-11 + |
+Updated the following content: +
|
+
2018-04-30 + |
+Updated the following content: +
|
+
2018-03-30 + |
+Updated the following content: +Added chapter "Share Tag." + |
+
2018-01-25 + |
+Updated the following content: +Added an interface to query the API versions. + |
+
2017-09-30 + |
+Updated the following content: +Added an API for querying all shared file systems. + |
+
2017-09-26 + |
+Updated the following content: +Added the description about how to use the is_public parameter. + |
+
2017-09-25 + |
+Updated the following content: +For the consistency_group_id field of a request, added that SFS does not support consistency group so that the request field is invalid, and no need to configure this parameter. + |
+
2017-08-26 + |
+Updated the following content: +
|
+
2017-08-21 + |
+Updated the following content: +
|
+
2017-07-29 + |
+This issue is the first official release. + |
+
Querying All Tags of a Tenant's Shared File Systems
+Function
This API is used to query the tag set of a tenant's all shared file systems.
+URI
- GET /v1/{project_id}/sfs-turbo/tags
- Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+project_id
+Yes
+String
+Specifies the project ID of the operator.
+
Response
- Parameter description
++
+Parameter
+Type
+Description
+tags
+Array of tags
+Specifies the tag list.
+For details, see Description of field tag.
+ - Description of the tag field + +
- Example response
{ + "tags" : [ { + "key" : "key1", + "values" : [ "value1", "" ] + }, { + "key" : "key2", + "values" : [ "value1", "value2" ] + } ] +}+
Status Codes
- Normal +
- Abnormal
++
+Status Code
+Description
+400 Bad Request
+Invalid value.
+401 Unauthorized
+Authentication failed.
+403 Forbidden
+Access to the requested page is forbidden.
+404 Not Found
+The requested resource was not found.
+500 Internal Server Error
+The request is not completed because of a service error.
+
Querying 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.
+URI
- POST /v1/{project_id}/sfs-turbo/resource_instances/action
- Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+project_id
+Yes
+String
+Specifies the project ID of the operator.
+
Request
- Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+offset
+No
+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
+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 cannot exceed the value of limit.
+action
+Yes
+String
+Specifies the operation identifier. Possible values are filter and count.
+Use filter to query details of a shared file system using tags.
+matches
+No
+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.
+tags
+No
+Array of tags
+Specifies the tag search field, which is a list of tags. Only shared file systems that contain 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
+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
+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
+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
+Array of tags
+Only the op_service permission can use this field to filter resources.
+- Currently, TMS can invoke only one tag structure key, _sys_enterprise_project_id.
- Currently, key contains only one value.
- sys_tags and tenant tag filtering conditions (tags, tags_any, not_tags, and not_tags_any) cannot be used at the same time.
+ In the request parameters, tag search fields tags, tags_any, not_tags, and not_tags_any are optional and can be combined with each other. Such tag search fields are in the AND relationship.
+ - Description of the match field
++
+Parameter
+Mandatory
+Type
+Description
+key
+Yes
+String
+Specifies the key. The value is fixed to resource_name.
+value
+Yes
+String
+Specifies the value. value indicates the name of a shared file system. An empty string specifies an exact match and only shared file systems whose names are empty can be queried. A non-empty string specifies a fuzzy query (case insensitive). The value can contain a maximum of 255 characters.
+ - Description of the tag field
++
+Parameter
+Mandatory
+Type
+Description
+key
+Yes
+String
+Specifies the key of the tag. A tag key can contain a maximum of 127 characters. This parameter cannot be left blank.
+values
+Yes
+Array of strings
+Lists the values. Each value can contain a maximum of 255 characters. If the value is left empty, any value is matched. The values are in the OR relationship.
+ - Example request
{ + "offset": "0", + "limit": "100", + "action": "filter", + "matches": [{ + "key": "resource_name", + "value": "share_name" + }], + "tags": [{ + "key": "key1", + "values": ["value2"] + }, { + "key": "key2", + "values": [] + }], + "tags_any": [{ + "key": "key3", + "values": ["value3"] + }, { + "key": "key4", + "values": [] + }], + "not_tags": [{ + "key": "key5", + "values": ["value5"] + }, { + "key": "key6", + "values": [] + }], + "not_tags_any": [{ + "key": "key7", + "values": ["value7", "value8"] + }, { + "key": "key9", + "values": [] + }] +}+
- Example request (without passing matches)
{ + "offset": "0", + "limit": "100", + "action": "filter", + "tags": [{ + "key": "key1", + "values": ["value2"] + }, { + "key": "key2", + "values": [] + }] +}+ - Example request (without passing limit and offset)
{ + "action": "filter", + "matches": [{ + "key": "resource_name", + "value": "share_name" + }], + "tags": [{ + "key": "key1", + "values": ["value2"] + }, { + "key": "key2", + "values": [] + }] +}+
- Example request (without passing tags, not_tags, tags_any, and not_tags_any)
{ + "offset": "0", + "limit": "100", + "action": "filter", + "matches": [{ + "key": "resource_name", + "value": "share_name" + }] +}+
- Example request (with the action field only)
{ + "action": "filter" +}+
Response
- Parameter description
++
+Parameter
+Type
+Description
+resources
+Array of resources
+Specifies the list of shared file systems that meet the query criteria.
+total_count
+Integer
+Specifies the total number of shared file systems that meet the query criteria.
+NOTE:+total_count specifies the total number of shared file systems that meet the query criteria, instead of the number returned after you set offset and limit.
+ - Data structure of the resource field
++
+Parameter
+Type
+Description
+resource_id
+String
+Specifies the ID of the shared file system.
+resource_detail
+Object
+Specifies the resource details. The value is a resource object, used for extension. This value is left empty by default.
+tags
+Array of resource_tags
+Specifies the list of tags. If no tags exist, the value is an empty array by default.
+sys_tags
+Array of tags
+Only the op_service permission can obtain this field.
+- Currently, only one tag structure key is used, _sys_enterprise_project_id.
- Currently, key contains only one value.
This field cannot be returned in non-op_service scenarios.
+resource_name
+String
+Specifies the resource name.
+ - Data structure of the resource_tag field
++
+Parameter
+Type
+Description
+key
+String
+Specifies the key of the tag. The value can contain a maximum of 36 characters. This parameter cannot be left blank. It can only contain letters, digits, hyphens (-), and underscores (_).
+value
+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 (_).
+
- Example response
{ + "resources":[ + { + "resource_detail":{}, + "resource_id":"b1f3f06f-344d-446b-a4bf-647a225debae", + "resource_name":"share_name", + "tags":[ + { + "key":"key1", + "value": "value1" + }, + { + "key":"key2", + "value": "value2" + } + ] + } + ], + "total_count":1 +}+
Status Codes
- Normal +
- Abnormal
++
+Status Code
+Description
+400 Bad Request
+Invalid value.
+401 Unauthorized
+Authentication failed.
+403 Forbidden
+Access to the requested page is forbidden.
+404 Not Found
+The requested resource was not found.
+500 Internal Server Error
+The request is not completed because of a service error.
+
Connection Management
+ +Changing a Security Group
+Function
This API is used to change the security group bound to an SFS Turbo file system. Security group change is an asynchronous task. You can determine whether the security group status is changed based on the sub_status field returned in Querying Details About a Single File System. If the sub_status field is 232, the security group has been successfully modified.
+URI
- URI format +
- Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+project_id
+Yes
+String
+Specifies the project ID. For details about how to obtain the project ID, see API Usage Guidelines.
+share_id
+Yes
+String
+Specifies the ID of an SFS Turbo file system.
+
Request
- Parameter description
++
+Parameter
+Mandatory
+Type
+Description
+change_security_group
+Yes
+Object
+Specifies the change_security_group object. For details, see the change_security_group parameter description.
+ - change_security_group parameter description + +
- Example request
{ + "change_security_group": { + "security_group_id": "26f6b565-240e-43c3-8867-03f0bd975433" + } +}+
Response
- Parameter description
++
+Parameter
+Type
+Description
+id
+String
+Specifies the ID of the SFS Turbo file system.
+
- Example response
{ + "id": "67d4bd5e-7b2f-4c24-9a0b-c0038940c6f8" +}+ +