查询作业配置

1. 接口描述

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

查询作业配置列表，一次最多查询100个

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

2. 输入参数

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

3. 输出参数

4. 示例

示例1 查询作业配置

查询指定的作业配置

输入示例

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

{
    "JobId": "cql-ahnkqtay",
    "WorkSpaceId": "space-1257058945ap-guangzhou"
}

输出示例

{
    "Response": {
        "JobConfigSet": [
            {
                "AutoRecover": 1,
                "COSBucket": "autotest-gz-bucket-1257058945",
                "CheckpointRetainedNum": 0,
                "ClazzLevels": [],
                "ClsLogsetId": "",
                "ClsTopicId": "",
                "CreateTime": "2023-10-20 10:55:12",
                "CreatorUin": "100032959577",
                "DefaultParallelism": 1,
                "EntrypointClass": "",
                "ExpertModeOn": false,
                "JobId": "cql-ahnkqtay",
                "JobManagerSpec": 1,
                "LogCollect": 4,
                "LogLevel": "INFO",
                "MaxParallelism": 2048,
                "ProgramArgs": "{\"CheckpointInterval\":600,\"Metadata\":\"{\\\"Metadata\\\":{\\\"ReferenceTables\\\":[],\\\"Variables\\\":[]}}\",\"SqlCode\":\"-- Datagen Connector 可以随机生成一些数据用于测试\\n-- 参见 https://cloud.tencent.com/document/product/849/58713\\nCREATE TABLE datagen_source_table_b ( \\n    id INT, \\n    name STRING \\n) WITH ( \\n    'connector' = 'datagen',\\n    'rows-per-second'='1'  -- 每秒产生的数据条数\\n);\\n\\n\\n-- 输入到 Blackhole Sink 的数据, 会被全部丢弃。这个 Sink 适合做性能测试。\\n-- 参见 https://ci.apache.org/projects/flink/flink-docs-release-1.11/zh/dev/table/connectors/blackhole.html\\nCREATE TABLE blackhole_sink_b ( \\n    id INT, \\n    name STRING \\n) WITH ( \\n    'connector' = 'blackhole'\\n);\\n\\nINSERT INTO blackhole_sink_b SELECT * FROM datagen_source_table_b;\\n\\n\\n\"}",
                "Properties": [
                    {
                        "Key": "pipeline.max-parallelism",
                        "Value": "2048"
                    }
                ],
                "PythonVersion": "",
                "Remark": "v1",
                "ResourceRefDetails": null,
                "TaskManagerSpec": 1,
                "TraceModeConfiguration": null,
                "TraceModeOn": false,
                "UpdateTime": "2023-11-13 17:19:04",
                "Version": 1
            }
        ],
        "RequestId": "21ac3206-2b1a-4095-93cd-ceed11cf5379",
        "TotalCount": 1
    }
}

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

命令行工具

• Tencent Cloud CLI 3.0

6. 错误码

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