• Scalable File Service

sfs
  1. Help Center
  2. Scalable File Service
  3. API Reference(cli)
  4. API Description
  5. File Sharing
  6. Querying Details About a Shared File System

Querying Details About a Shared File System

Function

This interface is used to query the details about a shared file system.

Command

  • Usage
    manila show <share>
  • Parameter description

    Name

    Mandatory

    Type

    Description

    share

    Yes

    string

    Specifies name or id for the shared file system.

  • Example command
    manila show 416112b6-e5c9-4a46-8dd1-80749fc09336

Response

  • Parameter description

    Name

    Mandatory

    Type

    Description

    status

    Yes

    string

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

    share_type_name

    Yes

    string

    Specifies the name of a share type. A share type is used to specify the type of the storage service to be allocated. Currently, SFS provides only one share type and the value is fixed to default.

    description

    Yes

    string

    Describes the shared file system.

    availability_zone

    Yes

    string

    Specifies the availability zone.

    share_network_id

    Yes

    string

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

    export_locations

    Yes

    string

    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.

    host

    Yes

    string

    Specifies the host name of the shared file system.

    access_rules_status

    Yes

    string

    Specifies the configuration status of the access rule. Possible values are active (effective), error (configuration failed), syncing (configuration in progress).

    snapshot_id

    Yes

    string

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

    is_public

    Yes

    boolean

    (Since API v2.8) Specifies the level of visibility for the shared file system. If this parameter is set to true, the share can be queried by other tenants using interfaces such as the one in Querying Details About a Shared File System. If this parameter is set to false, the share is visible only to the tenant who creates the share. The default value is false.

    NOTE:

    Share access rules added for different tenants are isolated from each other. Therefore, even if a share is set to be visible to other tenants, the share can only be queried by other tenants using the interface in Querying Details About a Shared File System. Other tenants are not allowed to mount or use the share.

    task_state

    Yes

    string

    Specifies the data migration status. This parameter is reserved, because data migration is not supported currently.

    snapshot_support

    Yes

    boolean

    Specifies whether snapshots are supported. This parameter is reserved, because snapshots are not supported currently.

    id

    Yes

    string

    Specifies the UUID of the shared file system.

    size

    Yes

    string

    Specifies the size of the shared file system in GB.

    name

    Yes

    string

    Specifies the name of the shared file system.

    share_type

    Yes

    string

    Specifies the UUID of the share type. A share type is used to specify the type of the storage service to be allocated. Currently, SFS provides only one share type and the value is default.

    has_replicas

    Yes

    boolean

    Specifies whether replicas exist. This parameter is reserved, because replication is not supported currently.

    replication_type

    Yes

    string

    Specifies the replication type. This parameter is reserved, because replication is not supported currently.

    created_at

    Yes

    string

    Specifies the date and time stamp when the shared file system was created.

    share_proto

    Yes

    string

    Specifies the protocol for sharing file systems.

    consistency_group_id

    Yes

    string

    Specifies the UUID of the consistency group. This parameter is reserved, because consistency groups are not supported currently.

    source_cgsnapshot_member_id

    Yes

    string

    Specifies the UUID of the snapshot's source. This parameter is reserved, because consistency snapshot is not supported currently.

    project_id

    Yes

    string

    Tenant ID

    metadata

    Yes

    object

    Sets that one or more metadata key and value pairs as a dictionary of strings.

  • Example response
    # manila show 416112b6-e5c9-4a46-8dd1-80749fc09336
    +-----------------------------+-------------------------------------------------------------------------------+
    | Property                    | Value                                                                         |
    +-----------------------------+-------------------------------------------------------------------------------+
    | status                      | available                                                                     |
    | share_type_name             | default                                                                       |
    | description                 | None                                                                          |
    | availability_zone           | az-01                                                                      |
    | share_network_id            | None                                                                          |
    | export_locations            |                                                                               |
    |                             | path = sfs-nas1.eu-de.otc.t-systems.com:/share-cff11cb8                       |
    |                             | id = 6014f802-7b74-4fb2-8436-a58c94f86e84                                     |
    |                             | preferred = False                                                             |
    | host                        | DJ1@28281404-884d-4eda-8240-c54903a178fe#28281404-884d-4eda-8240-c54903a178fe |
    | access_rules_status         | active                                                                        |
    | snapshot_id                 | None                                                                          |
    | is_public                   | False                                                                         |
    | task_state                  | None                                                                          |
    | snapshot_support            | True                                                                          |
    | id                          | 416112b6-e5c9-4a46-8dd1-80749fc09336                                          |
    | size                        | 1                                                                             |
    | name                        | sample1                                                                      |
    | share_type                  | 500fcfac-357b-4f0f-beeb-240d09da4dab                                          |
    | has_replicas                | False                                                                         |
    | replication_type            | None                                                                          |
    | created_at                  | 2017-10-24T13:27:55.936861                                                    |
    | share_proto                 | NFS                                                                           |
    | consistency_group_id        | None                                                                          |
    | source_cgsnapshot_member_id | None                                                                          |
    | project_id                  | 703fdd5a62c84cbfb1385c212881f695                                              |
    | metadata                    | {u'share_used': u'0'}                                                         |
    +-----------------------------+-------------------------------------