ListJobs - ListJobs_Serverless 应用引擎(SAE)-阿里云帮助中心

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

调试

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

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
sae:ListJobs		全部资源 *	无	无

请求语法

GET /pop/v1/sam/job/listJobs

请求参数

名称	类型	必填	描述	示例值
CurrentPage	integer	否	当前页数。取值从 1 开始。	1
PageSize	integer	否	页面大小。取值范围为[0,200]。	20
AppName	string	否	任务模板名称。	demo-app
NamespaceId	string	否	命名空间 ID。	cn-beijing:demo
Tags	string	否	标签列表，JSON 字符串。取值说明如下： key：标签键。 value：标签值。	[{"key":"key","value":"value"}]
OrderBy	string	否	对任务模板进行排序。取值说明如下： running：按照当前实例数进行排序。 instances：按照目标实例数进行排序。	running
Reverse	boolean	否	根据 OrderBy 参数传入的字段名排序。取值说明如下： true：按升序排序。 false：按降序排序。	true
FieldType	string	否	设置筛选任务模板的维度。取值说明如下： appName：任务模板名称。 appIds：任务模板 ID。	appName
FieldValue	string	否	根据已设置的 FieldType 筛选维度，选择输入目标任务模板的任务模板名称或任务模板 ID。	demo-app
Workload	string	否	Workload 需指定为`job`。	job

返回参数

名称	类型	描述	示例值
	object	返回数据。
Message	string	调用结果的附加信息。	success
RequestId	string	请求 ID。	B4D805CA-926D-41B1-8E63-7AD0C1ED****
Data	object	任务模板列表。
CurrentPage	integer	当前页数。	1
TotalSize	integer	任务模板总个数。	2
PageSize	integer	页面大小。	20
Applications	array<object>	任务模板列表。
	object	任务模板详细信息。
AppName	string	任务模板名称。	demo-app
NamespaceId	string	命名空间 ID。	cn-beijing:demo
AppId	string	任务模板 ID。	f7730764-d88f-4b9a-8d8e-cd8efbfe****
Tags	array<object>	任务模板标签。
	object	任务模板标签详细信息。
Key	string	标签键。	key
Value	string	标签值。	value
RegionId	string	地域 ID。	cn-beijing
AppDescription	string	任务模板描述信息。	description
TriggerConfig	string	任务触发配置，根据任务类型进行配置。定时任务：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"}}`	{"type":"time","config":"0 1 /1 ?","timezone":"GMT+8:00"}
Suspend	boolean	是否暂停任务模板。	false
Active	long	正在运行的实例数。	0
Succeeded	long	运行成功的实例数。	3
Failed	long	运行失败的实例数。	0
LastStartTime	long	上一次任务启动时间。	1657522800
CompletionTime	long	上一次任务完成时间。	1657522839
LastChangeorderState	string	上一次发布单执行是否成功，取值说明如下： 0：发布单执行失败。 1：发布单执行成功。	1
LastJobState	string	上一次任务的运行状态。取值说明如下： 0：未执行。 1：执行成功。 2：执行失败。 3：正在执行。	0
Cpu	integer	每个实例所需的 CPU，单位为毫核，不能为 0。目前仅支持以下固定规格： 500 1000 2000 4000 8000 16000 32000	500
Mem	integer	每个实例所需的内存，单位为 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 毫核。	1024
Message	string	调用结果的附加信息。	success
ErrorCode	string	错误码。取值说明如下：请求成功：不返回 ErrorCode 字段。请求失败：返回 ErrorCode 字段。具体信息，请参见本文的错误码目录。	空
Code	string	接口状态或 POP 错误码。取值说明如下： 2xx：成功。 3xx：重定向。 4xx：请求错误。 5xx：服务器错误。	200
Success	boolean	获取任务模板列表是否成功。取值说明如下： true：获取成功。 false：获取失败。	true
CurrentPage	integer	当前页数。	1
TotalSize	integer	任务模板总个数。	2
PageSize	integer	页面大小。	20

示例

正常返回示例

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"
      }
    ]
  },
  "ErrorCode": "空",
  "Code": "200",
  "Success": true,
  "CurrentPage": 1,
  "TotalSize": 2,
  "PageSize": 20
}

错误码

HTTP status code	错误码	错误信息	描述
404	InvalidAppId.NotFound	The specified AppId does not exist.	指定的AppId不存在。

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

变更历史

变更时间	变更内容概要	操作
2023-03-30	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情