流计算 Oceanus 获取指定作业的事件-作业接口-API 中心-腾讯云

1. 接口描述

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

获取指定作业的事件，包括作业启动停止、运行失败、快照失败、作业异常等各种事件类型

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeJobEvents。
Version	是	String	公共参数，本接口取值：2019-04-22。
Region	是	String	公共参数，详见产品支持的地域列表。
JobId	是	String	作业的 ID 示例值：cql-6w8eab6f
StartTimestamp	是	Integer	筛选条件：起始 Unix 时间戳（秒）示例值：1630932161
EndTimestamp	是	Integer	筛选条件：结束 Unix 时间戳（秒）示例值：1631232466
Types.N	否	Array of String	事件类型。如果不传则返回所有类型的数据示例值：[1,2]
RunningOrderIds.N	否	Array of Integer	运行实例 ID 数组示例值：[1,2,3]
WorkSpaceId	否	String	工作空间 SerialId 示例值：space-xxx

3. 输出参数

参数名称	类型	描述
Events	Array of JobEvent	该作业指定范围内的事件列表注意：此字段可能返回 null，表示取不到有效值。示例值：[]
RunningOrderIds	Array of Integer	该作业指定范围内运行实例 ID 数组，仅当入参没有传入 RunningOrderIds 参数时才会返回。倒序输出注意：此字段可能返回 null，表示取不到有效值。示例值：[3,2,1]
TotalCount	Integer	事件的总数注意：此字段可能返回 null，表示取不到有效值。示例值：10
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询作业事件

输入示例

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

{
    "RunningOrderIds": [
        1
    ],
    "Types": [
        "1",
        "2"
    ],
    "EndTimestamp": 1630933910,
    "StartTimestamp": 1630833910,
    "JobId": "cql-21f5a2ve"
}

输出示例

{
    "Response": {
        "RunningOrderIds": [
            1
        ],
        "Events": [
            {
                "RunningOrderId": 1,
                "Description": "作业停止事件",
                "Timestamp": 1630933810,
                "Type": "11"
            }
        ],
        "TotalCount": 1,
        "RequestId": "123345be-e89b-52f3-a456-426616274040"
    }
}

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. 错误码

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

错误码	描述
AuthFailure	CAM签名/鉴权错误。
FailedOperation	操作失败。
InternalError	内部错误。
InvalidParameter	参数错误。
InvalidParameter.InvalidAppId	appid错误。
InvalidParameterValue.JobIdValueError	作业id的参数无效。
InvalidParameterValue.Timestamp	时间戳范围有误。
InvalidParameterValue.Type	非法的类型字段。
ResourceNotFound.Job	作业不存在。
UnsupportedOperation.NoPermissionAccess	权限拦截,没有进入权限。

获取指定作业的事件

本页目录：