- 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
- Migrating Data to SFS
- Testing SFS Turbo Performance
- Testing SFS Turbo Latency
- Creating a Readable and Writable Subdirectory on the File System for a Common User
- Using OBS+SFS Turbo for Storage Acceleration in AI Scenarios
-
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 Storage Backend
- Listing Storage Backends
- Obtaining Details About a Storage Backend
- Removing a Storage Backend
- Update the Attributes of a Storage Backend
- Updating the Auto Synchronization Policy of a Storage Backend
- Creating a Data Import or Export Task
- Querying Details About a Data Import or Export Task
- Listing Data Import and Export Tasks
- Deleting a Data Import or Export Task
- Updating a File System
- Directory Management
- Permissions Management
- 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.
Obtaining Details About an Asynchronous Task of a File System
Function
This API is used to obtain details about an asynchronous task of a file system. Only tasks for querying the directory usage can be queried. Such tasks are also referred to as DU tasks. The value of feature in the API request path is dir-usage.
Constraints
This API is only supported for file systems created after August 1, 2023. The obtained data may not be the latest as there is a 5-minute delay between the frontend and background. The value of feature in the API request path can only be the following:
-
dir-usage
This API is only supported for the following types of file systems:
-
20 MB/s/TiB
-
40 MB/s/TiB
-
125 MB/s/TiB
-
250 MB/s/TiB
-
500 MB/s/TiB
-
1,000 MB/s/TiB
For SFS Turbo Standard, Standard-Enhanced, Performance, Performance-Enhanced file systems, use the API for querying the file system directory usage.
URI
GET /v1/{project_id}/sfs-turbo/shares/{share_id}/fs/{feature}/tasks/{task_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
The project ID. |
share_id |
Yes |
String |
The file system ID. |
feature |
Yes |
String |
The task type. For example, the value for DU tasks is dir-usage. |
task_id |
Yes |
String |
The task ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
The account token. |
Content-Type |
Yes |
String |
The MIME type, which can be application or json. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
task_id |
String |
The task ID. |
status |
String |
The task status, which can be SUCCESS, DOING, or FAIL. Enumeration values:
|
dir_usage |
FsDuInfo object |
The resource usages of a directory (subdirectories included). |
begin_time |
String |
The task start time in UTC format, for example, 2006-01-02 15:04:05. |
end_time |
String |
The task end time in UTC format, for example, 2006-01-02 15:04:06. |
Parameter |
Type |
Description |
---|---|---|
path |
String |
The valid full path of a directory in the file system. |
used_capacity |
Long |
The used capacity, in bytes. |
file_count |
FsFileCount object |
The total number of files in this directory. |
message |
String |
The error message. |
Parameter |
Type |
Description |
---|---|---|
dir |
Long |
The number of directories. |
regular |
Long |
The number of regular files. |
pipe |
Long |
The number of pipe files. |
char |
Long |
The number of character devices. |
block |
Long |
The number of block devices. |
socket |
Long |
The number of sockets. |
symlink |
Long |
The number of symbolic links. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
X-request-id |
String |
The request ID. |
Parameter |
Type |
Description |
---|---|---|
errCode |
String |
The error code. |
errMsg |
String |
The error message. |
Status code: 404
Parameter |
Type |
Description |
---|---|---|
X-request-id |
String |
The request ID. |
Parameter |
Type |
Description |
---|---|---|
errCode |
String |
The error code. |
errMsg |
String |
The error message. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
X-request-id |
String |
The request ID. |
Parameter |
Type |
Description |
---|---|---|
errCode |
String |
The error code. |
errMsg |
String |
The error message. |
Example Requests
Obtaining details of the task whose ID is 11abef677ac40f46644d1d5cfc2424a4 for the file system whose ID is 630509b1-ded4-476e-8d06-dbbc3dc23900
GET HTTPS://{endpoint}/v1/{project_id}/sfs-turbo/shares/630509b1-ded4-476e-8d06-dbbc3dc23900/fs/dir-usage/tasks/11abef677ac40f46644d1d5cfc2424a4
Example Responses
Status code: 200
Success
{
"task_id" : "2b31ed520xxxxxxebedb6e57xxxxxxxx",
"status" : "SUCCESS",
"dir_usage" : {
"path" : "/path",
"used_capacity" : 0,
"file_count" : {
"dir" : 0,
"regular" : 0,
"pipe" : 0,
"char" : 0,
"block" : 0,
"socket" : 0,
"symlink" : 0
},
"message" : ""
},
"begin_time" : "2023-03-01 11:46:01",
"end_time" : "2023-03-01 11:46:01"
}
Status code: 400
Error response
{
"errCode" : "SFS.TURBO.0123",
"errMsg" : "feature invalid"
}
Status code: 404
Error response
{
"errCode" : "SFS.TURBO.0124",
"errMsg" : "task_id not found"
}
Status code: 500
Error response
{
"errCode" : "SFS.TURBO.0005",
"errMsg" : "Internal server error"
}
Status Codes
Status Code |
Description |
---|---|
200 |
Success |
400 |
Error response |
404 |
Error response |
500 |
Error response |
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