Help Center > > API Reference> SFS APIs> File Sharing> Creating a Shared File System

Creating a Shared File System

Updated at: Jan 10, 2020 GMT+08:00

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. For details about mounting the file system, see SFS Getting Started.

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. For details about how to obtain the project ID, see Obtaining a Project ID.

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 (_).

    snapshot_id

    No

    String

    Specifies the UUID (0 to 36 characters) of the source snapshot that is used to create the shared file system. This parameter is reserved, because snapshots are not supported currently.

    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.

    share_type

    No

    String

    Specifies the share type. This value determines the storage service type for the shared file system, such as high-performance storage (composed of SSDs) or large-capacity storage (composed of SATA disks). Currently, only one service type is supported and the parameter will be automatically set to the supported one. Do not manually set it, because application for the file service will fail if an unsupported type is entered.

    consistency_group_id

    No

    String

    (Supported by API versions from v2.31 to v2.42.) Specifies the UUID of the consistency group to which the share is to be created. SFS does not support a consistency group. Therefore, this field is invalid, and this parameter is not needed.

    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

    share_network_id

    No

    String

    Specifies the UUID (0 to 36 characters) of the share network to which the share service belongs or will be created. This parameter is reserved, because share network management is not supported currently.

  • 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 Data Encryption Workshop 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.
  • When you create a file system with an enterprise project ID, the following key is required in the metadata.

    Key

    Value Type

    Mandatory

    Description

    enterprise_project_id

    String

    Yes

    Specifies the enterprise project ID.

    When the Enterprise Project function is enabled, enterprise_project_id is used as a key for specifying the enterprise project ID of the shared file system.

  • Example request: POST https://{endpoint}/v2/16e1ab15c35a457e9c2b2aa189f544e1/shares
    {
       "share": {
           "share_type": null,
           "name": "test",
           "snapshot_id": null,
           "description": "test description",
           "metadata": {
               "key1": "value1",
               "key2": "value2"
           },
           "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
       }
    }
  • Example request (with the Enterprise Project function enabled): POST https://{endpoint}/v2/16e1ab15c35a457e9c2b2aa189f544e1/shares
    {
       "share": {
           "share_type": null,
           "name": "test",
           "snapshot_id": null,
           "description": "test description",
           "metadata": {
               "enterprise_project_id": "9130c90d-73b8-4203-b790-d49f98d503df"
           },
           "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 UUID for managing share services.

    share_network_id

    string

    Specifies the UUID of the share network. This parameter is reserved, because share network management is not supported currently.

    snapshot_id

    string

    Specifies the UUID 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 UUID of the shared file system.

    size

    integer

    Specifies the size (GB) of the shared file system.

    consistency_group_id

    string

    Specifies the UUID 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 UUID 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. enterprise_project_id is the key, and the corresponding value is the ID of the enterprise project to which the shared file system belongs.

    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.

    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.

    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 UUID 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

    bool

    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.

  • 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 Code

  • Normal

    200

  • 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.

Did you find this page helpful?

Submit successfully!

Thank you for your feedback. Your feedback helps make our documentation better.

Failed to submit the feedback. Please try again later.

Which of the following issues have you encountered?







Please complete at least one feedback item.

Content most length 200 character

Content is empty.

OK Cancel