流计算 Oceanus
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 流计算 Oceanus > API 文档 > 作业接口 > 查询作业

查询作业

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

我的收藏

本页目录：

1. 接口描述

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

查询作业

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeJobs。
Version 是 String 公共参数，本接口取值：2019-04-22。
Region 是 String 公共参数，详见产品支持的 地域列表。
JobIds.N 否 Array of String 按照一个或者多个作业ID查询。作业ID形如：cql-11112222，每次请求的作业上限为100。参数不支持同时指定JobIds和Filters。
示例值：[]
Filters.N 否 Array of Filter 过滤条件，支持的 Filter.Name 为：作业名 Name、作业状态 Status、所属集群 ClusterId、作业id JobId、集群名称 ClusterName。 每次请求的 Filters 个数的上限为 5，Filter.Values 的个数上限为 5。参数不支持同时指定 JobIds 和 Filters。
Offset 否 Integer 偏移量，默认为0
示例值：0
Limit 否 Integer 分页大小，默认为20，最大值为100
示例值：20
WorkSpaceId 否 String 工作空间 SerialId
示例值：space-1327
ExtraResult.N 否 Array of String 查询额外的作业信息,例如 JobEventInfo
示例值：["JobEventInfo"]

3. 输出参数

参数名称 类型 描述
TotalCount Integer 作业总数
示例值：1
JobSet Array of JobV1 作业列表
示例值：[]
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询作业

查询作业

输入示例

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

{
    "Limit": 1,
    "WorkSpaceId": "space-53rqk422"
}

输出示例

{
    "Response": {
        "JobSet": [
            {
                "AppId": 1257048945,
                "ClusterId": "cluster-5c43n3a5",
                "ClusterName": "cluster-test",
                "ClusterStatus": 2,
                "CreateTime": "2023-11-20 15:19:57",
                "CreatorUin": "100032489761",
                "CuMem": 4,
                "CurrentRunMillis": 0,
                "FlinkVersion": "Flink-1.13",
                "JobId": "cql-e92rh2pb",
                "JobType": 1,
                "LastOpResult": "",
                "LatestJobConfigVersion": 0,
                "Name": "create_job_test",
                "OwnerUin": "100006376216",
                "PublishedJobConfigVersion": -1,
                "Region": "ap-guangzhou",
                "Remark": "",
                "RunningCu": 0,
                "RunningCuNum": 0,
                "SchedulerType": 2,
                "StartTime": "-",
                "Status": 1,
                "StatusDesc": "create",
                "StopTime": "-",
                "Tags": null,
                "TotalRunMillis": 0,
                "UpdateTime": "2023-11-20 15:19:57",
                "WebUIUrl": "",
                "WorkSpaceId": "space-53rek422",
                "WorkSpaceName": "name",
                "Zone": "ap-guangzhou-7"
            }
        ],
        "RequestId": "ac6a62a7-45f1-4066-963d-eabea0f2824d",
        "TotalCount": 5
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AuthFailure CAM签名/鉴权错误。
AuthFailure.UnauthorizedOperation 未授权操作。
FailedOperation 操作失败。
InternalError 内部错误。
InternalError.CamCgwError CAM 网关错误。
InternalError.DB 数据库异常。
ResourceNotFound.JobId 找不到作业。
ResourceUnavailable.GetJobPublishedJobConfig 获取发布的作业配置错误。
UnsupportedOperation 操作不支持。
UnsupportedOperation.NoPermissionAccess 权限拦截,没有进入权限。
中国站