更新时间:2022-02-22 GMT+08:00

查询作业对象列表

功能介绍

查询所有的作业对象列表。该接口兼容Sahara。

URI

  • URI格式

    GET /v1.1/{project_id}/jobs

  • 参数说明
    表1 URI参数说明

    名称

    是否必选

    说明

    project_id

    项目编号。获取方法,请参见获取项目ID

    limit

    返回数据中最大对象个数。

    取值范围:1~1073741822

    marker

    列表中最后一个元素的ID,该元素不会出现在返回数据中。

    sort_by

    排序字段,-号表示降序排列。例如:

    • sort_by=name表示按name升序排序
    • sort_by=-name表示按name降序排序

请求消息

请求参数

无。

响应消息

表2 响应参数说明

名称

参数类型

说明

markers

Object

markers对象。参数说明,请参见表3

jobs

Array

作业对象列表。参数说明,请参见表4

表3 markers参数说明

名称

参数类型

说明

prev

String

上一页的marker。

next

String

下一页的marker。

表4 jobs参数说明

名称

参数类型

说明

description

String

作业对象描述信息。

tenant_id

String

项目编号。获取方法,请参见获取项目ID

created_at

String

作业对象的创建时间。

mains

Array

作业对象的执行程序集合。

updated_at

String

作业对象的更新时间。

libs

Array

作业对象的依赖包集合。

is_protected

Bool

作业对象是否受保护。

  • true
  • false

当前版本不支持该功能。

interface

Array

自定义接口集合。

is_public

Bool

作业对象是否公开。

  • true
  • false

当前版本不支持该功能。

type

String

作业对象类型。

id

String

作业对象ID。

name

String

作业对象名称。

示例

  • 请求示例
    GET /v1.1/{project_id}/jobs?limit=2&sort_by=name&marker=4f59aa66-bf38-402c-9b6f-320e77219b9b
  • 响应示例
    {
        "markers": {
            "prev": "62a287e9-76c3-458d-a2f8-56e2d824a9ee",
            "next": null
        },
        "jobs": [
            {
                "name": "my-mapreduce-job",
                "type": "MapReduce",
                "description": "This is the Map Reduce job template",
                "mains": [],
                "libs": [
                    {
                        "name": "my-job-binary-666",
                        "url": "/simple/mapreduce/program",
                        "description": "this is the job binary template",
                        "id": "2628d0e4-6109-4a09-a338-c4ee1b0963ed",
                        "tenant_id": "5a3314075bfa49b9ae360f4ecd333695",
                        "is_public": false,
                        "is_protected": false,
                        "extra": null
                    }
                ],
                "created_at": "2017-06-22T09:39:13",
                "updated_at": "2017-06-22T09:39:13",
                "id": "38a04cba-c113-4868-b11f-f50e8b1bf252",
                "tenant_id": "5a3314075bfa49b9ae360f4ecd333695",
                "is_public": false,
                "is_protected": false,
                "interface": []
            },
            {
                "name": "my-mapreduce-job-update",
                "type": "MapReduce",
                "description": "This is the Map Reduce job template",
                "mains": [],
                "libs": [
                    {
                        "name": "my-job-binary-666",
                        "url": "/simple/mapreduce/program",
                        "description": "this is the job binary template",
                        "id": "2628d0e4-6109-4a09-a338-c4ee1b0963ed",
                        "tenant_id": "5a3314075bfa49b9ae360f4ecd333695",
                        "is_public": false,
                        "is_protected": false,
                        "extra": null
                    }
                ],
                "created_at": "2017-06-22T12:05:58",
                "updated_at": "2017-06-22T12:05:58",
                "id": "b8ea4daa-0042-45e0-a522-e8b714e74760",
                "tenant_id": "5a3314075bfa49b9ae360f4ecd333695",
                "is_public": false,
                "is_protected": false,
                "interface": []
            }
        ]
    }

状态码

状态码如表5所示。

表5 状态码

状态码

描述

200

查询作业对象列表成功。

异常状态码请参见状态码