- Product Introduction
- Purchase Guide
- Getting Started
- Operation Guide
- Best Practice
- API Documentation
- FAQs
- Glossary
- Product Introduction
- Purchase Guide
- Getting Started
- Operation Guide
- Best Practice
- API Documentation
- FAQs
- Glossary
1. API Description
Domain name for API request: chdfs.tencentcloudapi.com.
This API is used to view the details of a file system.
A maximum of 20 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribeFileSystem. |
| Version | Yes | String | Common Params. The value used for this API: 2020-11-12. |
| Region | No | String | Common Params. This parameter is not required for this API. |
| FileSystemId | Yes | String | File system ID |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| FileSystem | FileSystem | File system |
| CapacityUsed | Integer | Used capacity of the file system, in bytes Note: this field may return null, indicating that no valid value was found. |
| ArchiveCapacityUsed | Integer | Used ARCHIVE capacity of COS, in bytes Note: this field may return null, indicating that no valid values can be obtained. |
| StandardCapacityUsed | Integer | Used STANDARD capacity of COS, in bytes Note: this field may return null, indicating that no valid values can be obtained. |
| DegradeCapacityUsed | Integer | Used STANDARD_IA capacity of COS, in bytes Note: this field may return null, indicating that no valid value was found. |
| DeepArchiveCapacityUsed | Integer | COS DEEP ARCHIVE storage usage, in bytes Note: This field may return null, indicating that no valid values can be obtained. |
| IntelligentCapacityUsed | Integer | COS INTELLIGENT TIERING storage usage, in bytes Note: This field may return null, indicating that no valid values can be obtained. |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
4. Example
Example1 Viewing the details of a file system
This example shows you how to view the details of a file system.
Input Example
POST / HTTP/1.1
Host: chdfs.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeFileSystem
<Common request parameters>
{
"FileSystemId": "f4mhaqkciq0"
}
Output Example
{
"Response": {
"FileSystem": {
"AppId": 1251006373,
"FileSystemName": "test",
"Description": "",
"Region": "ap-guangzhou",
"FileSystemId": "f4mhaqkciq0",
"CreateTime": "2019-07-30T17:03:20+08:00",
"BlockSize": 4194304,
"CapacityQuota": 1073741824,
"SuperUsers": [
"hadoop"
],
"PosixAcl": true,
"Status": 2,
"EnableRanger": false,
"RangerServiceAddresses": [
"127.0.0.1:8080"
]
},
"CapacityUsed": 0,
"ArchiveCapacityUsed": 0,
"StandardCapacityUsed": 0,
"DegradeCapacityUsed": 0,
"DeepArchiveCapacityUsed": 0,
"IntelligentCapacityUsed": 0,
"RequestId": "22e36f95-9295-4132-a75e-09a08d2e13fc"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
6. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation | Operation failed. |
| InternalError | Internal error. |
| InvalidParameter | Incorrect parameter. |
| InvalidParameterValue | Incorrect parameter value. |
| InvalidParameterValue.InvalidFileSystemId | Incorrect parameter value: FileSystemId. |
| MissingParameter | Missing parameter. |
| ResourceNotFound.FileSystemNotExists | The file system does not exist. |
| ResourceUnavailable | The resource is unavailable. |
| UnauthorizedOperation | Unauthorized operation. |
Yes
No
Was this page helpful?