流计算 Oceanus 自定义树状结构

1. 接口描述

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

生成树状作业显示结构

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeTreeJobs。
Version	是	String	公共参数，本接口取值：2019-04-22。
Region	是	String	公共参数，详见产品支持的地域列表。
Filters.N	否	Array of Filter	筛选条件字段，使用了筛选字段后不支持分页，最多返回2000条记录
WorkSpaceId	否	String	工作空间 Serialid 示例值：space-1327

3. 输出参数

参数名称	类型	描述
ParentId	String	父节点ID 注意：此字段可能返回 null，表示取不到有效值。示例值：root-xxx
Id	String	当前文件夹ID 注意：此字段可能返回 null，表示取不到有效值。示例值：folder-xxx
Name	String	当前文件夹名注意：此字段可能返回 null，表示取不到有效值。示例值：New Folder
JobSet	Array of TreeJobSets	当前文件夹下的作业列表注意：此字段可能返回 null，表示取不到有效值。
Children	Array of DescribeTreeJobsRsp	迭代子目录注意：此字段可能返回 null，表示取不到有效值。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 DescribeTreeJobs

输入示例

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

{
    "WorkSpaceId": "space-1257058945ap-chengdu",
    "Filters": []
}

输出示例

{
    "Response": {
        "Children": [
            {
                "ParentId": "root",
                "Id": "folder-n130omz7",
                "Name": "test1",
                "JobSet": [
                    {
                        "JobId": "cql-ladx4cg1",
                        "Name": "test9261_1",
                        "JobType": 1,
                        "RunningCu": 0,
                        "Status": 4,
                        "ScalingType": 0,
                        "RunningCpu": 2,
                        "RunningMem": 8,
                        "DecodeSqlCode": "",
                        "PublishedJobConfigId": 139473
                    }
                ],
                "Children": null,
                "RequestId": "d9c3b849-da95-4275-83de-7f9170aa7061",
                "PageAttach": "",
                "HasMore": false
            }
        ],
        "Id": "root",
        "JobSet": [
            {
                "JobId": "cql-rvmmrqgq",
                "Name": "agent_datagen2print_test_0409",
                "JobType": 1,
                "RunningCu": 0,
                "Status": 1,
                "ScalingType": 0,
                "RunningCpu": 0,
                "RunningMem": 0,
                "DecodeSqlCode": "",
                "PublishedJobConfigId": -1
            }
        ],
        "Name": "作业列表",
        "ParentId": "",
        "RequestId": "d9c3b849-da95-4275-83de-7f9170aa7061"
    }
}

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: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
AuthFailure	CAM签名/鉴权错误。
AuthFailure.UnauthorizedOperation	未授权操作。
FailedOperation	操作失败。
UnsupportedOperation.NoPermissionAccess	权限拦截,没有进入权限。

自定义树状结构

本页目录：