1. 接口描述
接口请求域名: chdfs.tencentcloudapi.com 。
查看文件系统详细信息。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeFileSystem。 |
Version | 是 | String | 公共参数,本接口取值:2020-11-12。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
FileSystemId | 是 | String | 文件系统ID 示例值:f4mhaqkciq0 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
FileSystem | FileSystem | 文件系统 |
CapacityUsed | Integer | 文件系统已使用容量(byte) 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
ArchiveCapacityUsed | Integer | 已使用COS归档存储容量(byte) 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
StandardCapacityUsed | Integer | 已使用COS标准存储容量(byte) 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
DegradeCapacityUsed | Integer | 已使用COS低频存储容量(byte) 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
DeepArchiveCapacityUsed | Integer | 已使用COS深度归档存储容量(byte) 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
IntelligentCapacityUsed | Integer | 已使用COS智能分层存储容量(byte) 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查看文件系统详细信息
查看文件系统详细信息
输入示例
POST / HTTP/1.1
Host: chdfs.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeFileSystem
<公共请求参数>
{
"FileSystemId": "f4mhaqkciq0"
}
输出示例
{
"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. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.InvalidFileSystemId | FileSystemId参数取值错误。 |
MissingParameter | 缺少参数错误。 |
ResourceNotFound.FileSystemNotExists | 文件系统不存在。 |
ResourceUnavailable | 资源不可用。 |
UnauthorizedOperation | 未授权操作。 |