Querying Details About a Single File System

Function

This API is used to query details about an SFS Turbo file system.

URI

URI format
GET /v1/{project_id}/sfs-turbo/shares/{share_id}

Parameter description

Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the project ID. For details about how to obtain the project ID, see Obtaining a Project ID.
share_id	Yes	String	Specifies the ID of the SFS Turbo file system.

Request Header

The operation message header is the same as that of a common request. For details, see Table 3.

Request

Parameter description
None
Example request
None

Response

Parameter description

Parameter	Type	Description
id	String	Specifies the ID of the SFS Turbo file system.
name	String	Specifies the name of the SFS Turbo file system.
status	String	Specifies the status of the SFS Turbo file system. For details, see SFS Turbo File System Statuses.
sub_status	String	Specifies the sub-status of the SFS Turbo file system. For details, see SFS Turbo File System Substatuses.
version	String	Specifies the version ID of the 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. For a previous-generation file system, an IP address is returned, for example, 192.168.0.90:/. For a 250 MB/s/TiB, 125 MB/s/TiB, 40 MB/s/TiB, or 20 MB/s/TiB file system, a domain name is returned, for example, 2c568e3b-da13-4041-b5f8-fb77f611914e.sfsturbo.internal:/. If the file system is being created, this field is not returned.
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.
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 a 250 MB/s/TiB, 125 MB/s/TiB, 40 MB/s/TiB, or 20 MB/s/TiB file system, hpc is returned. For other types of file systems, this field is not returned.
hpc_bw	String	File system bandwidth 20M: 20 MB/s/TiB 40M: 40 MB/s/TiB 125M: 125 MB/s/TiB 250M: 250 MB/s/TiB

Description of field action_progress

Parameter	Type	Description
CREATING	String	Specifies the file system creation 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"
}