ListJobs - 获取任务列表_微服务引擎(MSE)-阿里云帮助中心

获取任务列表。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
ClusterId	string	是	集群	xxljob-b6ec1xxxx
AppName	string	是	应用名	test-app
Status	string	否	状态	0
JobId	long	否	任务 ID	10
JobName	string	否	任务名	job01
Description	string	否	描述信息	job01单机任务
JobHandler	string	否	jobhandler 名称	jobDemoHandler
PageNum	integer	否	页数	1
PageSize	integer	否	每页数	20

返回参数

名称	类型	描述	示例值
	object	Schema of Response
Code	integer	响应码	200
Message	string	错误信息	Parameter error: content is null.
RequestId	string	本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题	1DF6732E-15D8-5E1F-95E3-C10077F556B5
Success	boolean	是否调用成功。 true：调用成功 false：调用失败	true
Data	object
Records	array<object>
Record	object
JobId	long	任务 ID	74
Name	string	任务名	job01
Description	string	任务描述	job01单机任务
JobType	string	任务类型	xxljob
Status	integer	任务状态。具体取值如下： 0: DISABLE (禁用) 1: ENABLE (启用) 10: ACTIVE_DISABLE (主动禁用) 11: PASSIVE_DISABLE (被动禁用)	1
Parameters	string	任务参数	name=10
MaxConcurrency	integer	总体并发数阈值	100
MaxAttempt	integer	错误最大重试次数，根据业务需求填写	5
AttemptInterval	integer	错误重试间隔，单位 s	30
JobHandler	string	jobhandler 名称	jobDemoHandler
Priority	integer	执行作业优先级	1
TimeType	integer	时间类型，目前支持以下几种类型： -1: none 1：cron 3：fix_rate 5：one_time 100:：api	1
TimeExpression	string	时间表达式	0 0 12 * * ?
TimeZone	string	时区	Hongkong
Calendar	string	日历	work-day
DataOffset	integer	数据偏移	3
CleanMode	string	清理模式	{"cleanMode":"NUM_ONLY","totalRemain":300}
Creator	string	创建者	1963096506470832
Updater	string	更新者	1963096506470832
Xattrs	string	扩展属性说明暂不支持	暂无
NoticeConfig	string	Notice 配置	{"failLimitTimes":1,"failEnable":true,"timeoutKillEnable":false,"missWorkerEnable":true,"timeoutEnable":true,"sendChannel":"","timeout":300,"successNotice":false}
NoticeContacts	string	通知联系人	[{"contactType":1,"name":"恰橙"}]
RouteStrategy	integer	路由策略： 1: 轮询 2: 随机 3: 第一个 4: 最后一个 5: 最不经常使用 6: 最近最久未使用 7: 一致性哈希 8: 分片广播	1
AppName	string	应用名	test-app
Timezone	string	时区	HangKong
Total	integer	总数	65
PageNumber	integer	页码	1
PageSize	integer	分页大小	20

示例

正常返回示例

JSON格式

{
  "Code": 200,
  "Message": "Parameter error: content is null.",
  "RequestId": "1DF6732E-15D8-5E1F-95E3-C10077F556B5",
  "Success": true,
  "Data": {
    "Records": [
      {
        "JobId": 74,
        "Name": "job01",
        "Description": "job01单机任务",
        "JobType": "xxljob",
        "Status": 1,
        "Parameters": "name=10",
        "MaxConcurrency": 100,
        "MaxAttempt": 5,
        "AttemptInterval": 30,
        "JobHandler": "jobDemoHandler",
        "Priority": 1,
        "TimeType": 1,
        "TimeExpression": "0 0 12 * * ?",
        "TimeZone": "Hongkong",
        "Calendar": "work-day",
        "DataOffset": 3,
        "CleanMode": "{\"cleanMode\":\"NUM_ONLY\",\"totalRemain\":300}",
        "Creator": "1963096506470832",
        "Updater": "1963096506470832",
        "Xattrs": "暂无",
        "NoticeConfig": "{\"failLimitTimes\":1,\"failEnable\":true,\"timeoutKillEnable\":false,\"missWorkerEnable\":true,\"timeoutEnable\":true,\"sendChannel\":\"\",\"timeout\":300,\"successNotice\":false}",
        "NoticeContacts": "[{\"contactType\":1,\"name\":\"恰橙\"}]",
        "RouteStrategy": 1,
        "AppName": "test-app",
        "Timezone": "HangKong"
      }
    ],
    "Total": 65,
    "PageNumber": 1,
    "PageSize": 20
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParameter	Parameter error: %s.	参数错误: %s
401	IllegalRequest	IllegalRequest: %s.	非法请求：%s
403	NoPermission	No permission to perform this operation: %s.	没有权限去执行该操作：%s
404	NotFound	Not found: %s.	资源不存在：%s
500	InternalError	InternalError: %s.	系统内部错误：%s

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

变更历史

变更时间	变更内容概要	操作
2024-11-29	OpenAPI 返回结构发生变更	查看变更详情