查看作业列表

最近更新时间:2018-11-08 20:28:47

1. 接口描述

接口请求域名: batch.tencentcloudapi.com 。

用于查询若干个作业的概览信息

默认接口请求频率限制:2次/秒。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeJobs
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,详见产品支持的地域列表
JobIds.N Array of String 作业ID
Filters.N Array of Filter 过滤条件
  • job-id - String - 是否必填:否 -(过滤条件)按照作业ID过滤。
  • job-name - String - 是否必填:否 -(过滤条件)按照作业名称过滤。
  • job-state - String - 是否必填:否 -(过滤条件)按照作业状态过滤。
  • zone - String - 是否必填:否 -(过滤条件)按照可用区过滤。
  • Offset Integer 偏移量
    Limit Integer 返回数量

    3. 输出参数

    参数名称 类型 描述
    JobSet Array of JobView 作业列表
    TotalCount Integer 符合条件的作业数量
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查询作业信息

    输入示例

    https://batch.tencentcloudapi.com/?Action=DescribeJobs
    &JobIds.0=job-97zcl3wt
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "JobSet": [
          {
            "CreateTime": "2018-02-07T09:29:09Z",
            "EndTime": "2018-02-07T09:33:01Z",
            "JobId": "job-97zcl3wt",
            "JobName": "test job",
            "JobState": "SUCCEED",
            "Placement": {
              "Zone": "ap-guangzhou-2"
            },
            "Priority": 1,
            "TaskMetrics": {
              "FailedCount": 0,
              "FailedInterruptedCount": 0,
              "PendingCount": 0,
              "RunnableCount": 0,
              "RunningCount": 0,
              "StartingCount": 0,
              "SubmittedCount": 0,
              "SucceedCount": 4
            }
          }
        ],
        "RequestId": "c76c5368-6e2d-46bc-9867-5a3019510b76",
        "TotalCount": 1
      }
    }

    5. 开发者资源

    API Explorer

    该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InternalError 内部错误
    InvalidParameter.JobIdMalformed 非法的作业ID格式。
    InvalidParameterValue 非法的参数值。
    InvalidZone.MismatchRegion 指定的zone不存在。
    UnknownParameter 未知参数错误