文档

ListJobs

更新时间:

调用ListJobs接口获取任务模板列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求头

该接口使用公共请求头,无特殊请求头。更多信息,请参见公共请求和返回头

请求语法

GET /pop/v1/sam/job/listJobs HTTP/1.1

请求参数

名称

类型

位置

是否必选

示例值

描述

CurrentPage Integer Query 1

当前页数。取值从1开始。

PageSize Integer Query 20

页面大小。取值范围为[0,200]。

AppName String Query demo-app

任务模板名称。

NamespaceId String Query cn-beijing:demo

命名空间ID。

Tags String Query [{"key":"key","value":"value"}]

标签列表,JSON字符串。取值说明如下:

  • key:标签键。
  • value:标签值。
OrderBy String Query running

对任务模板进行排序。取值说明如下:

  • running:按照当前实例数进行排序。
  • instances:按照目标实例数进行排序。
Reverse Boolean Query true

根据OrderBy参数传入的字段名排序。取值说明如下:

  • true:按升序排序。
  • false:按降序排序。
FieldType String Query appName

设置筛选任务模板的维度。取值说明如下:

  • appName:任务模板名称。
  • appIds:任务模板ID。
FieldValue String Query demo-app

根据已设置的FieldType筛选维度,选择输入目标任务模板的任务模板名称或任务模板ID。

Workload String Query job

Workload需指定为job

返回数据

名称

类型

示例值

描述

Message String success

调用结果的附加信息。

RequestId String B4D805CA-926D-41B1-8E63-7AD0C1ED****

请求ID。

Data Object

任务模板列表。

CurrentPage Integer 1

当前页数。

TotalSize Integer 2

任务模板总个数。

PageSize Integer 20

页面大小。

Applications Array of Application

任务模板列表。

AppName String demo-app

任务模板名称。

NamespaceId String cn-beijing:demo

命名空间ID。

AppId String f7730764-d88f-4b9a-8d8e-cd8efbfe****

任务模板ID。

Tags Array of Tags

任务模板标签。

Key String key

标签键。

Value String value

标签值。

RegionId String cn-beijing

地域ID。

AppDescription String description

任务模板描述信息。

TriggerConfig String {"type":"time","config":"0 1 */1 * ?","timezone":"GMT+8:00"}

任务触发配置,根据任务类型进行配置。

  • 定时任务type字段设为time,config字段为具体Cron表达式,timezone字段为指定时区。

    配置示例:{"type":"time","config":"0 1 */1 * ?","timezone":"GMT+8:00"}

  • 一次性任务type字段设为http,config配置具体的HTTP触发规则。更多信息,请参见请求参数SourceHttpEventParameters

    配置示例:{"type":"http","config":{"type":"HTTPS","method"、["GET"],"ip":[],"referer":[],"securityConfig":"none"}}

Suspend Boolean false

是否暂停任务模板。

Active Long 0

正在运行的实例数。

Succeeded Long 3

运行成功的实例数。

Failed Long 0

运行失败的实例数。

LastStartTime Long 1657522800

上一次任务启动时间。

CompletionTime Long 1657522839

上一次任务完成时间。

LastChangeorderState String 1

上一次发布单执行是否成功,取值说明如下:

  • 0:发布单执行失败。
  • 1:发布单执行成功。
LastJobState String 0

上一次任务的运行状态。取值说明如下:

  • 0:未执行。
  • 1:执行成功。
  • 2:执行失败。
  • 3:正在执行。
Cpu Integer 500

每个实例所需的CPU,单位为毫核,不能为0。目前仅支持以下固定规格:

  • 500
  • 1000
  • 2000
  • 4000
  • 8000
  • 16000
  • 32000
Mem Integer 1024

每个实例所需的内存,单位为MB,不能为0。与CPU为一一对应关系,目前仅支持以下固定规格:

  • 1024:对应CPU为500毫核和1000毫核。
  • 2048:对应CPU为500、1000毫核和2000毫核。
  • 4096:对应CPU为1000、2000毫核和4000毫核。
  • 8192:对应CPU为2000、4000毫核和8000毫核。
  • 12288:对应CPU为12000毫核。
  • 16384:对应CPU为4000、8000毫核和16000毫核。
  • 24576:对应CPU为12000毫核。
  • 32768:对应CPU为16000毫核。
  • 65536:对应CPU为8000、16000和32000毫核。
  • 131072:对应CPU为32000毫核。
Message String success

调用结果的附加信息。

ErrorCode String

错误码。取值说明如下:

  • 请求成功:不返回ErrorCode字段。
  • 请求失败:返回ErrorCode字段。具体信息,请参见本文的错误码目录。
Code String 200

接口状态或POP错误码。取值说明如下:

  • 2xx:成功。
  • 3xx:重定向。
  • 4xx:请求错误。
  • 5xx:服务器错误。
Success Boolean true

获取任务模板列表是否成功。取值说明如下:

  • true:获取成功。
  • false:获取失败。
CurrentPage Integer 1

当前页数。

TotalSize Integer 2

任务模板总个数。

PageSize Integer 20

页面大小。

示例

请求示例

GET /pop/v1/sam/app/listApplications?CurrentPage=1&PageSize=20&AppName=demo-app&NamespaceId=cn-beijing:demo&Tags=[{"key":"key","value":"value"}]&OrderBy=running&Reverse=true&FieldType=appName&FieldValue=demo-app HTTP/1.1
Host:sae.aliyuncs.com
Content-Type:application/json

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ListJobsResponse>
    <Message>success</Message>
    <RequestId>B4D805CA-926D-41B1-8E63-7AD0C1ED****</RequestId>
    <Data>
        <CurrentPage>1</CurrentPage>
        <TotalSize>2</TotalSize>
        <PageSize>20</PageSize>
        <Applications>
            <AppName>demo-app</AppName>
            <NamespaceId>cn-beijing:demo</NamespaceId>
            <AppId>f7730764-d88f-4b9a-8d8e-cd8efbfe****</AppId>
            <Tags>
                <Key>key</Key>
                <Value>value</Value>
            </Tags>
            <RegionId>cn-beijing</RegionId>
            <AppDescription>description</AppDescription>
            <TriggerConfig>{"type":"time","config":"0 1 */1 * ?","timezone":"GMT+8:00"}</TriggerConfig>
            <Suspend>false</Suspend>
            <Active>0</Active>
            <Succeeded>3</Succeeded>
            <Failed>0</Failed>
            <LastStartTime>1657522800</LastStartTime>
            <CompletionTime>1657522839</CompletionTime>
            <LastChangeorderState>1</LastChangeorderState>
            <LastJobState>0</LastJobState>
            <Cpu>500</Cpu>
            <Mem>1024</Mem>
            <Message>success</Message>
        </Applications>
    </Data>
    <Code>200</Code>
    <Success>true</Success>
    <CurrentPage>1</CurrentPage>
    <TotalSize>2</TotalSize>
    <PageSize>20</PageSize>
</ListJobsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Message" : "success",
  "RequestId" : "B4D805CA-926D-41B1-8E63-7AD0C1ED****",
  "Data" : {
    "CurrentPage" : 1,
    "TotalSize" : 2,
    "PageSize" : 20,
    "Applications" : [ {
      "AppName" : "demo-app",
      "NamespaceId" : "cn-beijing:demo",
      "AppId" : "f7730764-d88f-4b9a-8d8e-cd8efbfe****",
      "Tags" : [ {
        "Key" : "key",
        "Value" : "value"
      } ],
      "RegionId" : "cn-beijing",
      "AppDescription" : "description",
      "TriggerConfig" : "{\"type\":\"time\",\"config\":\"0 1 */1 * ?\",\"timezone\":\"GMT+8:00\"}",
      "Suspend" : false,
      "Active" : 0,
      "Succeeded" : 3,
      "Failed" : 0,
      "LastStartTime" : 1657522800,
      "CompletionTime" : 1657522839,
      "LastChangeorderState" : "1",
      "LastJobState" : "0",
      "Cpu" : 500,
      "Mem" : 1024,
      "Message" : "success"
    } ]
  },
  "Code" : "200",
  "Success" : true,
  "CurrentPage" : 1,
  "TotalSize" : 2,
  "PageSize" : 20
}

错误码

HttpCode

错误码

错误信息

描述

404 InvalidAppId.NotFound The specified AppId does not exist. 指定的AppId不存在。

访问错误中心查看更多错误码。

  • 本页导读 (1)