Listing File Systems

Updated on 2025-04-28 GMT+08:00

View PDF

Function

This API is used to list file systems.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	The project ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	The maximum number of returned file systems. If not specified, 1000 is used by default.
offset	No	Integer	The offset of the returned file systems.

Request Parameters

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

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
shares	Array of ShareInfo objects	The list of SFS Turbo file systems.
count	Integer	The number of SFS Turbo file systems.

**Table 5** ShareInfo
Parameter	Type	Description
action_progress	ActionProgress object	The file system creation progress. This field is only returned when the file system is being created.
version	String	The file system version.
avail_capacity	String	The available capacity of the file system, in GB.
availability_zone	String	The code of the AZ where the file system resides.
az_name	String	The name of the AZ where the file system resides.
created_at	String	The time when the file system was created. UTC time, for example: 2018-11-19T04:02:03.
crypt_key_id	String	The ID of the encryption key. This parameter is not returned for non-encrypted file systems.
expand_type	String	For an Enhanced file system, bandwidth is returned. For a 1,000 MB/s/TiB, 500 MB/s/TiB, 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.
export_location	String	The file system location, for example, 192.168.0.90:/. This field is not returned when the file system is being created.
id	String	The file system ID.
name	String	The file system name specified during creation.
pay_model	String	The file system billing mode. Value 0 indicates pay-per-use. This field is not returned when the file system is being created. Enumeration values: 0 1
region	String	The region where the file system resides.
security_group_id	String	The ID of the specified security group.
share_proto	String	The protocol used by the file system. The value is NFS.
share_type	String	The file system performance type. Valid values are STANDARD and PERFORMANCE.
size	String	The file system total capacity, in GB.
status	String	The file system status. The value can be as follows: 100 (creating), 200 (available), 303 (creation failed), and 800 (frozen)
sub_status	String	The substatus of the SFS Turbo file system. The value can be as follows: This field is not returned if no modification is made to the file system. 121 (expanding capacity), 132 (changing security group), 137 (adding authorized VPC), 138 (removing authorized VPC), 150* (adding storage backend), 151 (removing storage backend) 221 (expansion succeeded), 232 (security group changed), 237 (authorized VPC added), 238 (authorized VPC removed), 250 (storage backend added), 251* (storage backend removed) 321 (expansion failed), 332 (changing security group failed), 337 (adding authorized VPC failed), 338 (removing authorized VPC failed), 350 (adding storage backend failed), 351 (removing storage backend failed)
subnet_id	String	The ID of the specified subnet.
vpc_id	String	The ID of the specified VPC.
enterprise_project_id	String	The ID of the enterprise project that file system is added to.
tags	Array of ResourceTag objects	The tag list.
optional_endpoint	String	The alternative IP addresses that can be used for mount. This field is not returned for previous-generation file systems.
hpc_bw	String	The file system bandwidth. "20M": 20 MB/s/TiB "40M": 40 MB/s/TiB "125M": 125 MB/s/TiB "250M": 250 MB/s/TiB "500M": 500 MB/s/TiB "1000M": 1,000 MB/s/TiB
instanceId	String	The node ID of the file system type, which has no meaning. This is a reserved field.
instanceType	String	The node type of the file system type, which has no meaning. This is a reserved field.
statusDetail	String	The file system request ID, which has no meaning. This is a reserved field.
features	ShareInfoFeatures object	The file system feature settings.

**Table 6** ActionProgress
Parameter	Type	Description
CREATING	String	The file system creation progress.

**Table 7** ResourceTag
Parameter	Type	Description
key	String	The tag key. It can contain a maximum of 128 characters. It cannot be left empty 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 (_).
value	String	The tag value. Each tag value can contain a maximum of 255 characters and can be an empty string. 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 (_).

**Table 8** ShareInfoFeatures
Parameter	Type	Description
backup	ShareInfoFeature object	Whether the file system supports backup.

**Table 9** ShareInfoFeature
Parameter	Type	Description
is_support	Boolean	Whether the file system supports this feature.
message	String	The message.
msg_code	String	The message code.

Example Requests

Listing file systems in the project whose ID is e1e45b08f3ea4480ab4655ef9c7160ba

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

Example Responses

Status code: 200

Success response body

Listing file systems in the project whose ID is e1e45b08f3ea4480ab4655ef9c7160ba

{
  "shares" : [ {
    "id" : "8fba8253-c914-439d-ae8b-d5c89d0bf5e8",
    "name" : "sfs-turbo-8468",
    "status" : "100",
    "version" : "1.0.0",
    "region" : "example",
    "created_at" : "2018-11-19T04:02:03",
    "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"
  } ]
}

Listing file systems in the project whose ID is 5694xxx8f3e0000xxxx655exxxxx60b7

{
  "shares" : [ {
    "id" : "65f2d30b-7b4e-4786-9608-4324faef6646",
    "name" : "sfs-turbo-df12",
    "status" : "200",
    "version" : "1.0.0",
    "region" : "example",
    "created_at" : "2018-11-15T02:32:10",
    "export_location" : "192.168.xx.xx:/",
    "optional_endpoint" : "192.168.xx.xx 192.168.xx.xx",
    "share_type" : "HPC_PERFORMANCE_250M",
    "expand_type" : "hpc",
    "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" : "3686.00",
    "pay_model" : "0",
    "avail_capacity" : "3686.00",
    "share_proto" : "NFS"
  } ]
}