Help Center > > API Reference> SFS APIs> File Sharing> Querying Details About All Shared File Systems

Querying Details About All Shared File Systems

Updated at: Oct 26, 2019 GMT+08:00

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

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

    enterprise_project_id

    No (query parameter)

    String

    Specifies the enterprise project to which the shared file systems are bound.

    To query the current user's shared file systems binding to all enterprise projects, use the all_granted_eps parameter.

Request

  • Parameter description

    None

  • Example request

    None

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 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
    {
        "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",
                "": 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

    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