1. 接口描述
接口请求域名： tbdsnew.api3.fincloud.tencent.com。
获取HDFS指定目录文件列表
默认接口请求频率限制：20次/秒。
接口更新时间：2025-09-12 15:04:13。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeHDFSFolderFiles |
| Version | 是 | 否 | String | 公共参数，本接口取值：2019-01-03 |
| Region | 是 | 否 | String | 公共参数，地域信息本接口不需要传递此参数。 |
| ClusterId | 是 | 否 | String | 集群id 示例值： tbds-9kr93vco |
| FilePath | 是 | 否 | String | 文件或目录路径 示例值： / |
| Offset | 否 | 否 | Int64 | 偏移量，页编号，默认为0，表示第一页，如果ReturnTotal和ReturnTotalDir都为false则必须填 示例值： 0 |
| Limit | 否 | 否 | Int64 | 每页数量，默认值为10，最大值为200，如果ReturnTotal和ReturnTotalDir都为false则必须填 示例值： 10 |
| FilterWord | 否 | 否 | String | 过滤词 示例值： 1 |
| ReturnTotal | 是 | 否 | Bool | 是否返回全部, true: 返回全部, 返回全部的情况下Offset, Limit, FilterWord字段不生效 示例值： False |
| ReturnTotalDir | 是 | 否 | Bool | 是否只返回全部目录; ReturnTotalDir优先级高于ReturnTotal, 该字段为true则ReturnTotal, Offset, Limit, FilterWord字段不生效 示例值： False |
| Filters | 否 | 否 | Array of Api3Filter | 过滤字段，Name支持字段：Path，values为文件名或文件夹名 示例值：查看 |
| OrderFields | 否 | 否 | Array of Api3Order | 排序字段，Fields支持字段：最近更新时间ModificationTime，文件大小Length，Direction支持"DESC"和"ASC" 示例值：查看 |
| CatalogName | 否 | 否 | String | 数据管理Catalog名称，当不填时，用的默认catalog 示例值： tbds-9kr93vco-HDFS78000003 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | FolderFilesResponse | hdfs目录下的文件信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：查看 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |