Obtaining the File System List

Function

This API is used to obtain the file system list.

URI

GET /v1/{project_id}/sfs-turbo/shares/detail

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Long	Number of the file systems returned. The maximum value is 200. Minimum: 0 Maximum: 200
offset	No	Long	Offset where the file system listing starts Minimum: 0

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Account token
Content-Type	Yes	String	MIME type

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
shares	Array of ShareInfo objects	List of SFS Turbo file systems
count	Integer	Number of SFS Turbo file systems

**Table 5** ShareInfo
Parameter	Type	Description
action_progress	ActionProgress object	Task progress of the SFS Turbo file system, for example, the file system creation progress
version	String	Version of the SFS Turbo file system
avail_capacity	String	Available capacity of the SFS Turbo file system, in GB
availability_zone	String	Code of the AZ where the SFS Turbo file system resides
az_name	String	Name of the AZ where the SFS Turbo file system resides
created_at	String	Time when the file system was created. UTC time, for example: 2018-11-19T04:02:03
crypt_key_id	String	ID of the encryption key specified by the user. This parameter is not returned for non-encrypted file systems.
expand_type	String	File system extension type. If the requested file system is an enhanced file system, bandwidth will be returned. Or, this parameter is not returned.
export_location	String	Location where the SFS Turbo file system is mounted
id	String	ID of the SFS Turbo file system
name	String	Name of the SFS Turbo file system specified during creation
pay_model	String	Billing mode of the SFS Turbo file system. Value 0 indicates pay-per-use, and 1 indicates yearly/monthly subscription. Enumeration values: 0 1
region	String	Region where the SFS Turbo file system resides
security_group_id	String	ID of the security group specified by the user
share_proto	String	Protocol used by the SFS Turbo file system. The valid value is NFS.
share_type	String	Storage class of the SFS Turbo file system. Valid values are STANDARD and PERFORMANCE.
size	String	Total capacity of the SFS Turbo file system, in GB
status	String	SFS Turbo file system status. The value can be as follows: 100 (creating), 200 (available), 303 (creation failed), and 800 (frozen)
sub_status	String	Sub-status of the SFS Turbo file system. The value can be as follows: 121 (expanding capacity), 132 (changing security group), 137 (adding authorized VPC), 138 (deleting VPC), 150* (adding target), 151 (deleting target) 221 (expansion succeeded), 232 (security group changed), 237 (VPC added), 238 (VPC deleted), 250 (target added), 251* (target deleted) 321 (expansion failed), 332 (changing security group failed), 337 (adding VPC failed), 338 (deleting VPC failed), 350 (adding target failed), 351 (deleting target failed)
subnet_id	String	ID of the subnet specified by the user
vpc_id	String	ID of the VPC specified by the user
enterprise_project_id	String	ID of the enterprise project to which the SFS Turbo file system is added
tags	Array of ResourceTag objects	Tag list

**Table 6** ActionProgress
Parameter	Type	Description
CREATING	String	File system creation progress

**Table 7** ResourceTag
Parameter	Type	Description
key	String	Tag key. It can contain a maximum of 36 characters. It cannot be left blank and cannot contain the following characters: ASCII (0-31), equal signs (=), asterisks (*), left angle brackets (<), right angle brackets (>), backslashes (\), commas (,), vertical bars (\|), and slashes (/). It can contain only letters, digits, hyphens (-), and underscores (_). Minimum: 1 Maximum: 36
value	String	Tag value. It can contain a maximum of 43 characters and can be left blank. It cannot contain the following characters: ASCII (0-31), equal signs (=), asterisks (*), left angle brackets (<), right angle brackets (>), backslashes (\), commas (,), vertical bars (\|), and slashes (/). It can contain only letters, digits, hyphens (-), and underscores (_). Minimum: 0 Maximum: 43

Example Requests

Querying file systems in the project whose ID e1e45b08f3ea4480ab4655ef9c7160ba

GET HTTPS://{endpoint}/v1/e1e45b08f3ea4480ab4655ef9c7160ba/sfs-turbo/shares/detail

Example Responses

Status code: 200

Response body for querying the file system list

{
  "shares" : [ {
    "id" : "8fba8253-c914-439d-ae8b-d5c89d0bf5e8",
    "name" : "sfs-turbo-8468",
    "status" : "100",
    "version" : "1.0.0",
    "region" : "north-1",
    "created_at" : "2018-11-19T04:02:03",
    "export_location" : "192.168.0.90:/",
    "action_progress" : {
      "CREATING" : "22%"
    },
    "share_type" : "STANDARD",
    "sub_status" : "",
    "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",
    "pay_model" : "0",
    "avail_capacity" : "500.00",
    "share_proto" : "NFS"
  }, {
    "id" : "65f2d30b-7b4e-4786-9608-4324faef6646",
    "name" : "sfs-turbo-df12",
    "status" : "200",
    "version" : "1.0.0",
    "region" : "north-1",
    "created_at" : "2018-11-15T02:32:10",
    "export_location" : "192.168.0.197:/",
    "share_type" : "STANDARD",
    "sub_status" : "",
    "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",
    "pay_model" : "0",
    "avail_capacity" : "500.00",
    "share_proto" : "NFS"
  } ]
}