查看作业列表

最近更新时间:2020-11-30 08:07:05

1. 接口描述

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

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

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeJobs。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
JobIds.N Array of String 作业ID列表,与Filters参数不能同时指定。
Filters.N Array of Filter 过滤条件
  • job-id - String - 是否必填:否 -(过滤条件)按照作业ID过滤。
  • job-name - String - 是否必填:否 -(过滤条件)按照作业名称过滤。
  • job-state - String - 是否必填:否 -(过滤条件)按照作业状态过滤。
  • zone - String - 是否必填:否 -(过滤条件)按照可用区过滤。
  • tag-key - String - 是否必填:否 -(过滤条件)按照标签键进行过滤。
  • tag-value - String - 是否必填:否 -(过滤条件)按照标签值进行过滤。
  • tag:tag-key - String - 是否必填:否 -(过滤条件)按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。

  • 与JobIds参数不能同时指定。
    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-7e7evk2x
    &JobIds.1=job-3n2weaqt
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "TotalCount": 2,
        "JobSet": [
          {
            "EndTime": null,
            "JobState": "STARTING",
            "Tags": [
              {
                "Key": "batch-test-tag-job-key",
                "Value": "batch-test-tag-job-value"
              }
            ],
            "TaskMetrics": {
              "PendingCount": 0,
              "FailedCount": 0,
              "StartingCount": 1,
              "SucceedCount": 0,
              "FailedInterruptedCount": 0,
              "SubmittedCount": 0,
              "RunnableCount": 0,
              "RunningCount": 0
            },
            "JobId": "job-3n2weaqt",
            "Priority": 1,
            "Placement": {
              "Zone": "ap-guangzhou-4"
            },
            "JobName": "hello-test-job",
            "CreateTime": "2020-09-22T07:14:54Z"
          },
          {
            "EndTime": "2020-09-21T08:59:45Z",
            "JobState": "FAILED",
            "Tags": [
              {
                "Key": "job-key1",
                "Value": "job-value1"
              },
              {
                "Key": "job-key",
                "Value": "job-value"
              }
            ],
            "TaskMetrics": {
              "PendingCount": 0,
              "FailedCount": 1,
              "StartingCount": 0,
              "SucceedCount": 0,
              "FailedInterruptedCount": 0,
              "SubmittedCount": 0,
              "RunnableCount": 0,
              "RunningCount": 0
            },
            "JobId": "job-7e7evk2x",
            "Priority": 1,
            "Placement": {
              "Zone": "ap-guangzhou-4"
            },
            "JobName": "hello-test-job",
            "CreateTime": "2020-09-21T08:57:01Z"
          }
        ],
        "RequestId": "ba5df388-51bd-434d-81aa-d640f284b4e7"
      }
    }

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InternalError 内部错误。
    InvalidFilter 指定的Filter不被支持。
    InvalidParameter.InvalidParameterCombination 非法的参数组合。
    InvalidParameter.JobIdMalformed 非法的作业ID格式。
    InvalidParameterValue 参数取值错误。
    InvalidZone.MismatchRegion 指定的zone不存在。
    UnknownParameter 未知参数错误。
    目录