Compute
Elastic Cloud Server
Huawei Cloud Flexus
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Management & Governance
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
OneAccess
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
IAM Identity Center
Cloud Operations Center
Resource Governance Center
Migration
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Analytics
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
Data Lake Factory
DataArts Lake Formation
IoT
IoT Device Access
Others
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Security & Compliance
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Anti-DDoS Service
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Edge Security
Situation Awareness
Managed Threat Detection
Blockchain
Blockchain Service
Web3 Node Engine Service
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
Storage
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service Turbo
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Containers
Cloud Container Engine
SoftWare Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
Multi-Site High Availability Service
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Business Applications
Workspace
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Video Intelligent Analysis Service
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Content Delivery & Edge Computing
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Intelligent EdgeCloud
Solutions
SAP Cloud
High Performance Computing
Developer Services
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
CodeArts Repo
Cloud Application Engine
MacroVerse aPaaS
KooMessage
KooPhone
KooDrive

Obtaining the File System List

Updated on 2024-11-13 GMT+08:00

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, 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

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. Value 0 indicates pay-per-use. If the file system is being created, this field 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. 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

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

    - "500M": 500 MB/s/TiB

    - "1000M": 1,000 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.

features

String

Whether backup is supported for SFS turbo file systems.

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 (_).

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" : "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.

We use cookies to improve our site and your experience. By continuing to browse our site you accept our cookie policy. Find out more

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback