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	Specifies the maximum number of returned file systems. If this parameter is not specified, the default value 1000 is used.
offset	No	Long	Sets the offset of the returned file system.

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	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, this field returns bandwidth. For 20MB/s/TiB, 40MB/s/TiB, 125MB/s/TiB, 250MB/s/TiB, this field returns hpc. Otherwise, this field is not returned.
export_location	String	Location where the SFS Turbo file system is mounted For example, 192.168.0.90:/. If the file system is being created, this parameter 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. '0' indicates pay-per-use. If the file system is being created, this parameter is not returned.
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. This field is not returned if the user does not perform any modification operation on the file system. '121' indicates that the capacity is being expanded. '132' indicates that the security group is being modified. '150' indicates that the associated backend is being configured. '151' indicates that the linkage backend configuration is being deleted. '221' indicates that the capacity expansion is successful. '232' indicates that the security group is modified successfully. '250' indicates that the associated backend is configured successfully. '251' indicates that the linkage backend configuration is deleted successfully. '321' indicates that the capacity expansion fails. '332' indicates that the security group fails to be modified. '350' indicates that the associated backend fails to be configured. '351' Failed to delete the linkage backend configuration.
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
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. "20M": 20 MB/s/TiB "40M": 40 MB/s/TiB "125M": 125 MB/s/TiB "250M": 250 MB/s/TiB
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.

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 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	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 ShareInfoFeature
Parameter	Type	Description
is_support	Boolean	Whether the file system supports this feature.
message	String	Message about whether the file system supports this feature.
msg_code	String	Code of the message about whether the file system supports this feature.

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

Response example for querying the file system list of 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"
  } ]
}

Response example for querying the file system list of 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"
  }, {
    "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"
  } ]
}

Status Codes

Status Code	Description
200	Response body for querying the file system list

Error Codes

See Error Codes.

Parent topic: Lifecycle Management

Предыдущая статья

Deleting a File System

Следующая статья

Expanding the Capacity of a File System

Была ли эта статья полезна?

Поддержка Юридические документы