1. 接口描述
接口请求域名： oceanus.tencentcloudapi.com 。
查询树状结构资源列表
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeTreeResources。 |
| Version | 是 | String | 公共参数，本接口取值：2019-04-22。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| Filters.N | 否 | Array of Filter | 筛选条件字段 |
| WorkSpaceId | 否 | String | 工作空间 SerialId 示例值：space-xxx |
| Offset | 否 | Integer | 分页游标 示例值：0 |
| Limit | 否 | Integer | 单页显示数 示例值：200 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ParentId | String | 父节点ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：root |
| Id | String | 文件夹ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：folder-id |
| Name | String | 文件夹名 注意：此字段可能返回 null，表示取不到有效值。 示例值：folder-xxx |
| Items | Array of TreeResourceItem | 文件列表 注意：此字段可能返回 null，表示取不到有效值。 |
| Children | Array of DescribeTreeResourcesRsp | 子目录列表 注意：此字段可能返回 null，表示取不到有效值。 |
| TotalCount | Integer | 资源总数 注意：此字段可能返回 null，表示取不到有效值。 示例值：200 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询指定依赖
查询指定依赖
输入示例
POST / HTTP/1.1
Host: oceanus.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTreeResources
<公共请求参数>
{
"Filters": [
{
"Name": "ResourceName",
"Values": [
"normal"
]
}
],
"WorkSpaceId": "space-53rqk422"
}输出示例
{
"Response": {
"Children": null,
"Id": "root",
"Items": [
{
"FileName": "1317959670/deep_normal_flink-hello-world-1.0.0.jar",
"FolderId": "root",
"Name": "1317959670/deep_normal_flink-hello-world-1.0.0.jar",
"RefJobStatusCountSet": [],
"Remark": "deep normal size",
"ResourceId": "resource-er9pkk0o",
"ResourceType": 1
},
{
"FileName": "normal_flink-hello-world-1.0.0.jar",
"FolderId": "root",
"Name": "normal_flink-hello-world-1.0.0.jar",
"RefJobStatusCountSet": [],
"Remark": "normal size",
"ResourceId": "resource-jvwtg594",
"ResourceType": 1
}
],
"Name": "依赖目录",
"ParentId": "",
"RequestId": "78d06002-44d2-46fa-8f63-14f51b0237d3",
"TotalCount": 2
}
}示例2 分类中的自定义树状结构并筛选
用户点击作业管理页面中的分类的自定义树状结构并点击分类旁的筛选按钮选择作业类型
输入示例
POST / HTTP/1.1
Host: oceanus.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTreeResources
<公共请求参数>
{
"Filters": [
{
"Name": "ResourceName",
"Values": [
"111"
]
}
]
}输出示例
{
"Response": {
"Children": [
{
"ParentId": "root",
"Id": "folder-xxxxx",
"Name": "folder-name",
"Items": null,
"Children": null,
"TotalCount": 0
}
],
"Id": "root",
"Items": [
{
"ResourceId": "resource-xxxxxx",
"Name": "flink-connector-jdbc.jar",
"ResourceType": 1,
"Remark": "pgsql1",
"FileName": "flink-connector-jdbc.jar",
"FolderId": "root",
"RefJobStatusCountSet": [
{
"JobStatus": 5,
"Count": 2
}
]
}
],
"Name": "依赖目录",
"ParentId": "",
"RequestId": "4aafc302-4fc5-44f5-9e90-2e0a2702ab81",
"TotalCount": 333
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| AuthFailure.UnauthorizedOperation | 未授权操作。 |
| FailedOperation | 操作失败。 |
| FailedOperation.DataSourceConnectionFailed | 数据库连接失败，请检查参数是否填写正确。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| UnsupportedOperation.NoPermissionAccess | 权限拦截,没有进入权限。 |
