- What's New
- Function Overview
- Service Overview
-
Billing
- Billing Overview
- Billing Modes
- Billed Items
- Billing Examples
- Billing Mode Changes
- Renewing Subscriptions
- Bills
- Arrears
- Billing Termination
- Cost Management
-
Billing FAQ
- How Do I Purchase SFS?
- How Do I Renew the Service?
- How Do I Check Whether the Subscriber Is in Arrears?
- Can I Purchase SFS Capacity-Oriented Resource Packages When I Still Have Valid Ones in Use?
- How Do I Check the Usage of an SFS Capacity-Oriented Resource Package?
- How Do I Adjust the Size of an SFS Capacity-Oriented Resource Package?
- Do SFS Capacity-Oriented and SFS Turbo Share One Resource Package?
- Getting Started
- User Guide
- Best Practices
-
API Reference
- Before You Start
- API Overview
- Calling APIs
- Calling General Purpose File System APIs
- Getting Started (SFS Capacity-Oriented)
- Getting Started with SFS Turbo
- Getting Started with General Purpose File System
-
SFS Capacity-Oriented APIs
- API Version Queries
- File Systems
- File System Access Rules
- Quota Management
- Expansion and Shrinking
-
Tag Management
- Adding a Tag to a Shared File System
- Deleting a Tag from a Shared File System
- Querying Tags of a Shared File System
- Querying Tags of All File Systems of a Tenant
- Batch Adding Tags to a Shared File System
- Batch Deleting Tags from a Shared File System
- Querying Shared File Systems by Tag
- Querying the Number of Shared File Systems by Tag
- AZ
-
SFS Turbo APIs
- Lifecycle Management
- Connection Management
- Tag Management
- Name Management
- File System Management
-
Storage Interworking Management
- Adding a Backend Target
- Querying Backend Targets
- Obtaining Details About a Backend Target
- Deleting a Backend Target
- Updating the Properties of a Storage Backend
- Updating the Auto Synchronization Policy of a Storage Backend
- Creating an Import or Export Task
- Querying Details About an Import or Export Task
- Listing Import and Export Tasks
- Deleting an Import or Export Task
- Updating a File System
- Directory Management
-
Permissions Management
- Creating a Permission Rule
- Querying Permission Rules of a File System
- Querying a Permission Rule of a File System
- Modifying a Permission Rule
- Deleting a Permissions Rule
- Creating and Binding the LDAP Configuration
- Querying the LDAP Configuration
- Modifying the LDAP Configuration
- Deleting the LDAP Configuration
- Task Management
- General Purpose File System APIs
- Permissions Policies and Supported Actions
- Common Parameters
- Appendix
- SDK Reference
-
Troubleshooting
- Mounting a File System Times Out
- Mounting a File System Fails
- File System Performance Is Poor
- Failed to Create an SFS Turbo File System
- A File System Is Automatically Disconnected from the Server
- A Server Fails to Access a File System
- The File System Is Abnormal
- Data Fails to Be Written into a File System Mounted to ECSs Running Different Types of Operating Systems
- Failed to Mount an NFS File System to a Windows IIS Server
- Writing to a File System Fails
- Error Message "wrong fs type, bad option" Is Displayed During File System Mounting
- Failed to Access the Shared Folder in Windows
-
FAQs
- Concepts
- Specifications
- Restrictions
- Networks
-
Billing
- How Do I Purchase SFS?
- How Do I Renew the Service?
- How Do I Check Whether the Subscriber Is in Arrears?
- Can I Purchase SFS Capacity-Oriented Resource Packages When I Still Have Valid Ones in Use?
- How Do I Check the Usage of an SFS Capacity-Oriented Resource Package?
- How Do I Adjust the Size of an SFS Capacity-Oriented Resource Package?
- Do SFS Capacity-Oriented and SFS Turbo Share One Resource Package?
-
Others
- How Do I Access a File System from a Server?
- How Do I Check Whether a File System on a Linux Server Is Available?
- What Resources Does SFS Occupy?
- Why Is the Capacity Displayed as 10P After I Mount My SFS Capacity-Oriented File System?
- Why the Capacity Is Displayed as 250TB After I Mount My General Purpose File System?
- How Can I Migrate Data Between SFS and OBS?
- Can a File System Be Accessed Across Multiple AZs?
- Can I Upgrade an SFS Capacity-Oriented File System to an SFS Turbo File System?
- Can I Upgrade an SFS Turbo File System from Standard to Standard-Enhanced?
- How Can I Migrate Data Between SFS and EVS?
- Can I Directly Access SFS from On-premises Devices?
- How Do I Delete .nfs Files?
- Why My File System Used Space Increases After I Migrate from SFS Capacity-Oriented to SFS Turbo?
- How Can I Improve the Copy and Delete Efficiency with an SFS Turbo File System?
- How Do Second- and Third-level Directory Permissions of an SFS Turbo File System Be Inherited?
- How Do I Deploy SFS Turbo on CCE?
- Videos
-
More Documents
- User Guide (ME-Abu Dhabi Region)
- API Reference (ME-Abu Dhabi Region)
-
User Guide (Paris Region)
- Introduction
- Getting Started
- Management
- Typical Applications
-
Troubleshooting
- Mounting a File System Times Out
- Mounting a File System Fails
- Failed to Create an SFS Turbo File System
- A File System Is Automatically Disconnected from the Server
- A Server Fails to Access a File System
- The File System Is Abnormal
- Data Fails to Be Written into a File System Mounted to ECSs Running Different Types of Operating Systems
- Failed to Mount an NFS File System to a Windows IIS Server
- Writing to a File System Fails
- Error Message "wrong fs type, bad option" Is Displayed During File System Mounting
- Failed to Access the Shared Folder in Windows
-
FAQs
- Concepts
- Specifications
- Restrictions
- Networks
-
Others
- How Do I Access a File System from a Server?
- How Do I Check Whether a File System on a Linux Server Is Available?
- What Resources Does SFS Occupy?
- Why Is the Capacity Displayed as 10P After I Mount My SFS Capacity-Oriented File System?
- Can a File System Be Accessed Across Multiple AZs?
- How Can I Migrate Data Between SFS and EVS?
- Can I Directly Access SFS from On-premises Devices?
- How Do I Delete .nfs Files?
- Why My File System Used Space Increases After I Migrate from SFS Capacity-Oriented to SFS Turbo?
- How Can I Improve the Copy and Delete Efficiency with an SFS Turbo File System?
- How Do Second- and Third-level Directory Permissions of an SFS Turbo File System Be Inherited?
- Other Operations
- Change History
- API Reference (Paris Region)
- User Guide (Kuala Lumpur Region)
- API Reference (Kuala Lumpur Region)
- Glossary
- General Reference
Copied.
Querying Details About a File System
Function
This API is used to query details about an SFS Turbo file system.
URI
GET /v1/{project_id}/sfs-turbo/shares/{share_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID |
share_id |
Yes |
String |
File system ID |
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 |
---|---|---|
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.
|
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 |
---|---|---|
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 the file system whose ID is 77ba6f4b-6365-4895-8dda-bc7142af4dde
GET HTTPS://{endpoint}/v1/{project_id}/sfs-turbo/shares/77ba6f4b-6365-4895-8dda-bc7142af4dde
Example Responses
Status code: 200
Response body for querying a file system
{ "id" : "8fba8253-c914-439d-ae8b-d5c89d0bf5e8", "name" : "sfs-turbo-8468", "status" : "200", "version" : "1.0.0", "region" : "example", "availability_zone" : "example", "az_name" : "example", "created_at" : "2018-11-19T04:02:03", "export_location" : "192.168.xx.xx:/", "action_progress" : { }, "share_type" : "STANDARD", "sub_status" : "221", "vpc_id" : "b24e39e1-bc0c-475b-ae0c-aef9cf240af3", "subnet_id" : "86fc01ea-8ec8-409d-ba7a-e0ea16d4fd97", "security_group_id" : "50586458-aec9-442c-bb13-e08ddc6f1b7a", "size" : "600.00", "avail_capacity" : "600.00", "pay_model" : "0", "share_proto" : "NFS" }
Status Codes
Status Code |
Description |
---|---|
200 |
Response body for querying a file system |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot