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
Parameter | Mandatory | Type | Description |
|---|---|---|---|
project_id | Yes | String | Project ID |
Parameter | Mandatory | Type | Description |
|---|---|---|---|
limit | No | Long | Maximum number of the file systems returned is 200. If not specified, 1000 is used by default. |
offset | No | Long | Offset where the file system listing starts. |
Request Parameters¶
Parameter | Mandatory | Type | Description |
|---|---|---|---|
X-Auth-Token | Yes | String | Account token |
Content-Type | Yes | String | MIME type |
Response Parameters¶
Status code: 200
Parameter | Type | Description |
|---|---|---|
shares | Array of ShareInfo objects | List of SFS Turbo file systems |
count | Integer | Number of SFS Turbo file systems |
Parameter | Type | Description |
|---|---|---|
action_progress | ActionProgress object | Creation progress of the SFS Turbo file system. This field is only returned when the file system is being created. |
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 | 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. |
export_location | String | Location 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. |
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. If the file system is being created, this field is not returned. Enumeration values:
|
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: 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) 221 (expansion succeeded), 232 (security group changed), 237 (authorized VPC added), 238 (authorized VPC removed) 321 (expansion failed), 332 (changing security group failed), 337 (adding authorized VPC failed), 338 (removing authorized VPC failed) |
subnet_id | String | ID of the subnet specified by the user |
vpc_id | String | ID of the VPC specified by the user |
tags | Array of ResourceTag objects | Tag list |
optional_endpoint | String | Alternative IP addresses that can be used for mounting. This field is not returned for previous-generation file systems. |
hpc_bw | String | File system bandwidth.
|
instanceId | String | Node ID of the file system type. This is a reserved field. |
instanceType | String | Node type of the file system type. This is a reserved field. |
statusDetail | String | Request ID of the file system. This is a reserved field. |
features | String | Whether backup is supported for SFS turbo file systems. |
Parameter | Type | Description |
|---|---|---|
CREATING | String | File system creation progress |
Parameter | Type | Description |
|---|---|---|
key | String | 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 ( Minimum: 1 Maximum: 128 |
value | String | 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 ( Minimum: 0 Maximum: 255 |
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" : "65f2d30b-7b4e-4786-9608-4324faef6646.sfsturbo.internal:/",
"optional_endpoint" : "192.168.0.90 192.168.0.89",
"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"
} ]
}
Status Codes¶
Status Code | Description |
|---|---|
200 | Response body for querying the file system list |
Error Codes¶
See Error Codes.