• Scalable File Service

sfs
  1. Help Center
  2. Scalable File Service
  3. API Reference
  4. SFS APIs
  5. File Sharing
  6. Querying Details About All Shared File Systems

Querying Details About All Shared File Systems

Function

This interface 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}& 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)

    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 UUID 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, 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 UUID of the mount path. This field is supported since API v2.35.

    export_location_path

    No (query parameter)

    string

    Specifies the field used for filtering based on the mount path. This field is supported since API v2.35.

    name~

    No (query parameter)

    string

    Specifies the field used for fuzzy filtering based on the share name. This field is supported since API v2.36.

    description~

    No (query parameter)

    string

    Specifies the field used for fuzzy filtering based on the share description. This field is supported since API v2.36.

    with_count

    No (query parameter)

    string

    Specifies that the number of queried shared file systems will be returned. This field is supported since API v2.42.

Request

  • Parameter description

    None

  • Example request

    None

Response

  • Parameter description

    Parameter

    Type

    Description

    shares

    array

    Specifies the list of shares.

    count

    string

    Specifies the number of returned shared file systems.

  • Description of field share

    Parameter

    Type

    Description

    links

    array

    Specifies the share links.

    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.

    id

    string

    Specifies the UUID of the shared file system.

    size

    integer

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

    share_group_id

    string

    (Supported since API v2.31) Specifies the UUID of a consistency group. Currently, the consistency group is not supported. This field is reserved.

    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.

    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 since API v2.11) Specifies whether any replication exists. Currently, replication is not supported. This field is reserved.

    replication_type

    string

    (Supported since API v2.11) Specifies the replication type. Currently, replication is not supported. This field is reserved.

    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 v2.10 to API 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 UUID 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

    bool

    (Supported since API v2.8). 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 since API v2.31) Specifies the UUID of a consistency snapshot source. Currently, the consistency group is not supported. This field is reserved.

    revert_to_snapshot_support

    boolean

    (Supported since API v2.27) Specifies whether reversion to snapshot is supported. Currently, snapshot is not supported. This field is reserved.

    create_share_from_snapshot_support

    boolean

    (Supported since API v2.24) Specifies whether creating file systems from snapshot is supported. Currently, snapshot is not supported. This field is reserved.

    mount_snapshot_support

    boolean

    (Supported since API v2.32) Specifies whether snapshot mounting is supported. Currently, snapshot is not supported. This field is reserved.

    user_id

    string

    (Supported since API v2.16) Specifies the user ID.

  • Example response
    {
        "count": 1,
        "shares": [
            {
                "links": [
                    {
                        "href": "https://100.133.170.97:8796/v2/61b01a94b84448cfac2424e46553d7e7/shares/54d0bac6-45c8-471c-bf0d-16ffd81ef88a",
                        "rel": "self"
                    },
                    {
                        "href": "https://100.133.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

    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

    You are forbidden to access the requested page.

    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.