查询文件夹

最近更新时间:2024-03-12 01:42:37

我的收藏

1. 接口描述

接口请求域名: oceanus.tencentcloudapi.com 。

查询指定文件夹及其相应的子文件夹信息

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeFolder。
Version String 公共参数,本接口取值:2019-04-22。
Region String 公共参数,详见产品支持的 地域列表
FolderId String folder id
示例值:folder-lfqkt10s
WorkSpaceId String workspace id
示例值:space-53rqk422
FolderType Integer 1:资源文件夹
其他:作业文件夹
示例值:1

3. 输出参数

参数名称 类型 描述
FolderId String folder id
示例值:folder-lfqkt10s
FolderName String folder name
示例值:test
ParentId String 父文件夹id
示例值:folder-lfqkt10i
FolderType Integer 文件夹类型
示例值:1
WorkSpaceId String workspace id
SubFolderInfo Array of SubFolderInfo 子文件夹信息
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询文件夹

查询文件夹

输入示例

POST / HTTP/1.1
Host: oceanus.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeFolder
<公共请求参数>

{
    "FolderId": "folder-bnjsm2sb",
    "WorkSpaceId": "space-7rfcnslf",
    "FolderType": 1
}

输出示例

{
    "Response": {
        "FolderId": "folder-bnjsm2sb",
        "FolderName": "6.9_connector",
        "FolderType": 1,
        "ParentId": "root",
        "RequestId": "3ca249e8-b742-4e97-856d-1fca5a95d6a5",
        "SubFolderInfo": [
            {
                "FolderId": "folder-gbtcphg0",
                "FolderName": "hive_catalog_config_311"
            },
            {
                "FolderId": "folder-79b2dxuc",
                "FolderName": "sql_server"
            },
            {
                "FolderId": "folder-oc406jen",
                "FolderName": "doris"
            },
            {
                "FolderId": "folder-3ldo2w3g",
                "FolderName": "mysql_cdc"
            },
            {
                "FolderId": "folder-nodi86tq",
                "FolderName": "kudu"
            }
        ],
        "WorkSpaceId": "space-7rfcnslf"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码