tencent cloud

Cloud HDFS

제품 소개
구매 가이드
시작하기
운영 가이드
CHDFS 생성
권한 그룹 생성
권한 규칙 생성
마운트 포인트 생성
CHDFS 마운트
CAM 라이선스로 액세스
Java 코드로 CHDFS 액세스
파일 시스템 삭제
사례 튜토리얼
CHDFS를 Druid의 Deep storage로 사용
네이티브 HDFS에서 Tencent Cloud CHDFS로 데이터 마이그레이션
DataX 사용하여 CHDFS 가져오기 또는 내보내기
CDH의 CHDFS 설정 가이드
CHDFS Ranger 권한 시스템 솔루션
API 참조
History
Introduction
API Category
Making API Requests
Restoration task APIs
Permission rule APIs
Permission group APIs
Other APIs
Mount point APIs
Lifecycle rule APIs
File system APIs
Data Types
Error Codes
FAQ
용어집
Related Protocol
Privacy Policy
Data Processing And Security Agreement

DescribeFileSystem

PDF
포커스 모드
폰트 크기
마지막 업데이트 시간: 2025-11-13 20:52:27

1. API Description

Domain name for API request: chdfs.intl.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 Yes String Common Params. For more information, please see the list of regions supported by the product.
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, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). 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.intl.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.

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.

도움말 및 지원

문제 해결에 도움이 되었나요?

피드백