接口说明
该接口用于查询定时任务列表。
注意事项：
- 参数
instanceIds最多输入100个实例ID。
URL
GET https://ecloud.10086.cn/api/openapi-instance/v4/task/list
请求参数
Query
|
参数名称
|
类型
|
必填
|
描述
|
|
instanceIds
|
<string> array(multi)
|
否
|
实例ID数组。可通过查询实例状态列表接口获取。 |
|
taskIds
|
<string> array(multi)
|
否
|
任务ID数组。 |
|
taskTypes
|
<string> array(multi)
|
否
|
任务执行策略。取值范围：
|
|
taskStatus
|
<integer(int32)> array(multi)
|
否
|
任务执行状态。取值范围：
|
|
taskName
|
string
|
否
|
任务名称。 |
|
page
|
integer(int32)
|
否
|
列表分页页数，起始页为1。 |
|
pageSize
|
integer(int32)
|
否
|
列表分页每页大小，最大值为100，默认值为10。 |
请求示例
GET https://ecloud.10086.cn/api/openapi-instance/v4/task/list返回参数
返回码：200
OK
|
参数名称
|
类型
|
描述
|
|
body
|
PageListResp«InstanceActionTaskResp»
|
请求成功时返回的数据。 |
|
content
|
<InstanceActionTaskResp> array
|
分页查询返回的具体结构体。 |
|
taskId
|
string
|
任务ID。 |
|
taskName
|
string
|
任务名称。 |
|
taskType
|
string
|
任务执行策略。取值范围：
|
|
taskStrategy
|
string
|
任务执行策略。取值范围：- SINGLE: 单次执行
|
|
taskCycleSelectedDays
|
<string> array
|
任务执行周期，该参数仅在taskStrategy为CYCLE时生效。取值范围：- SUN: 周日
|
|
taskExecTime
|
string
|
任务开始执行时间。 |
|
taskExecEndTime
|
string
|
任务结束执行时间。 |
|
createTime
|
string
|
任务创建时间。 |
|
taskStatus
|
integer(int32)
|
任务执行状态。取值范围：
|
|
instanceActionTaskInstanceInfos
|
<InstanceActionTaskInstanceInfo> array
|
任务执行实例信息数组。 |
|
instanceId
|
string
|
实例ID。 |
|
instanceName
|
string
|
实例名称。 |
|
instanceExecStatus
|
integer(int32)
|
实例执行状态。取值范围：
|
|
instanceExecReason
|
string
|
实例执行失败原因。 |
|
total
|
integer
|
满足查询条件的总个数。 |
|
errorCode
|
string
|
统一错误码。 |
|
errorMessage
|
string
|
页面国际化错误提示。 |
|
errorParams
|
<string> array
|
统一错误码的自定义参数。 |
|
requestId
|
string
|
每个请求的序列号。 |
|
state
|
enum(OK,ERROR,EXCEPTION,ALARM,FORBIDDEN)
|
返回状态码。返回正常：OK，返回错误：ERROR，返回异常：EXCEPTION，需要告警实现的：ALARM，禁止访问：FORBIDDEN。 |
返回示例
返回码：200
OK
{
"requestId":"reqId-183034f5e1b14295bfc73d8ba82a947b",
"state":"OK",
"body":{
"total":36,
"content":[
{
"taskId":"c274ec8e631a4ab591bdf1ae573d06ae",
"taskName":"ECS_STOP_2025_10_17_10_20_47",
"taskType":"STOP",
"taskStrategy":"SINGLE",
"taskCycleSelectedDays":null,
"taskExecTime":"2025-10-17 10:51:42",
"taskExecEndTime":null,
"createTime":"2025-10-17 10:20:48",
"taskStatus":2,
"instanceActionTaskInstanceInfos":[
{
"instanceId":"44f61a36-eba1-4b7c-8912-a49bd00fb0cd",
"instanceName":"勿动-内存优化型",
"instanceExecStatus":2,
"instanceExecReason":null
},
{
"instanceId":"761cbfb4-a09d-4523-841a-c19e99049ccf",
"instanceName":"ECS-75953459-003",
"instanceExecStatus":2,
"instanceExecReason":null
}
]
}
]
}
}