批量查询HDFS空间信息
最近更新时间: 2026-09-17 00:05:49
1. 接口描述
接口请求域名: tbdsnew.api3.fincloud.tencent.cn。
批量查询HDFS集群的空间信息,比如剩余存储容量,剩余可用文件数等
默认接口请求频率限制:20次/秒。
接口更新时间:2025-09-12 15:04:51。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:DescribeHDFSSpaces |
| Version | 是 | 否 | String | 公共参数,本接口取值:2019-01-03 |
| Region | 是 | 否 | String | 公共参数,地域信息本接口不需要传递此参数。 |
| Data | 是 | 否 | Array of String | 集群id列表 示例值: [{'ClusterId': 'tbds-rvz8fjf4', 'CatalogName': 'tbds-rvz8fjf4-HDFS78000009'}] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | Array of HDFSSpace | HDFS空间信息列表 注意:此字段可能返回 null,表示取不到有效值。 示例值:查看 |
| RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
5. 示例
示例1 批量查询HDFS空间信息
输入示例
POST / HTTP/1.1
Host: tbdsnew.api3.{conf.main_domain}
Content-Type: application/json
X-TC-Action: DescribeHDFSSpaces
<公共请求参数>
{
"Data": [
{
"ClusterId": "tbds-rvz8fjf4",
"CatalogName": "tbds-rvz8fjf4-HDFS78000009"
}
]
}
输出示例
{
"Response": {
"RequestId": "2434fc8f-3d94-4edd-82fc-b928a3ad4c2d",
"Data": [
{
"ClusterId": "tbds-rvz8fjf4",
"TotalSpace": 1513189539840,
"UsedSpace": 7187916288,
"RemainingSpace": 1426796929024,
"TotalFileCount": 300000000,
"UsedFileCount": 4417,
"RemainingFileCount": 299995583,
"Result": true,
"Msg": null,
"CatalogName": "tbds-rvz8fjf4-HDFS78000009"
}
]
}
}