文档

ListTaskExecutions - 查询任务执行

更新时间:

查询任务执行,支持多种过滤方式。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
oos:ListTaskExecutionsget
  • Execution
    acs:oos:{#regionId}:{#accountId}:execution/{#executionId}
  • oos:tag

请求语法

POST /ListTaskExecutions

GET /ListTaskExecutions

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID

cn-hangzhou
ExecutionIdstring

执行 ID

exec-xxx
Statusstring

执行状态,取值范围:Running, Started, Success, Failed, Waiting, Cancelled, Pending, Skipped。

Running
StartDateBeforestring

开始时间小于等于指定时间的执行

2019-05-16T10:26:14Z
StartDateAfterstring

开始时间大于等于指定时间的执行

2019-05-16T10:26:14Z
EndDateBeforestring

结束时间小于等于指定时间的执行

2019-05-16T10:26:14Z
EndDateAfterstring

结束时间大于等于指定时间的执行

2019-05-16T10:26:14Z
TaskExecutionIdstring

任务执行 ID

task-exec-xxx
TaskNamestring

任务名称

describeInstance
TaskActionstring

任务动作

ACS::Sleep
ParentTaskExecutionIdstring

父任务执行 ID。Loop 情况会用到,一般是 Loop 的 Parent 的 TaskExecutionId。

task-exec-xxx
IncludeChildTaskExecutionboolean

标记是否展示 Loop 产生的子 Task。默认为 False。

false
MaxResultsinteger

分页大小。取值范围:20-100。默认为 50。

50
NextTokenstring

翻页标记的 Token

MTRBMDc0NjAtRUJFNy00N0NBLTk3NTctMTJDQzQ3NjFENDdB
SortFieldstring

排序字段。取值范围:

  • StartDate(默认值):创建时间
  • EndDate:结束时间
  • Status:状态
StartDate
SortOrderstring

排序方向。取值范围:

  • Ascending:升序
  • Descending(默认值):降序
Ascending

返回参数

名称类型描述示例值
object
NextTokenstring

翻页标记的 Token

MTRBMDc0NjAtRUJFNy00N0NBLTk3NTctMTJDQzQ3NjFENDdB
RequestIdstring

请求 ID

CDABABABAB-FC28-4D9C-8FB5-68DC6F0486FC
MaxResultsinteger

分页大小

50
TaskExecutionsarray<object>

执行数据

object
ChildExecutionIdstring

子任务执行 ID

exec-xxx
Outputsstring

执行输出结果

{ "InstanceId":"i-xxx" }
Statusstring

任务状态

Running
EndDatestring

结束时间

2019-05-16T10:26:14Z
ParentTaskExecutionIdstring

父任务执行 ID

task-exec-xxx
TaskNamestring

任务名称

describeInstance
StartDatestring

开始时间

2019-05-16T10:26:14Z
LoopItemstring

循环中的元素

i-1234566zxcvvb
CreateDatestring

执行创建时间

2019-05-16T10:26:14Z
ExecutionIdstring

执行 ID

exec-44d32b45d2a449e49899
TaskActionstring

任务动作

ACS::Sleep
TaskExecutionIdstring

任务执行 ID

task-exec-xxx
UpdateDatestring

更新时间

2019-05-16T10:26:14Z
Loopobject

Loop 配置和统计信息,仅 Loop 父节点有此信息。

{}
TemplateIdstring

模板 ID

xxx
LoopBatchNumberinteger

循环批次数

2
StatusMessagestring

状态信息

""
ExtraDataobject

附加数据

{ "NotifyNote":"" }
Propertiesstring

执行的输入参数

{ "Status":"Running" }

示例

正常返回示例

JSON格式

{
  "NextToken": "MTRBMDc0NjAtRUJFNy00N0NBLTk3NTctMTJDQzQ3NjFENDdB",
  "RequestId": "CDABABABAB-FC28-4D9C-8FB5-68DC6F0486FC",
  "MaxResults": 50,
  "TaskExecutions": [
    {
      "ChildExecutionId": "exec-xxx",
      "Outputs": "{ \"InstanceId\":\"i-xxx\" }",
      "Status": "Running",
      "EndDate": "2019-05-16T10:26:14Z",
      "ParentTaskExecutionId": "task-exec-xxx",
      "TaskName": "describeInstance\t",
      "StartDate": "2019-05-16T10:26:14Z",
      "LoopItem": "i-1234566zxcvvb",
      "CreateDate": "2019-05-16T10:26:14Z",
      "ExecutionId": "exec-44d32b45d2a449e49899",
      "TaskAction": "ACS::Sleep",
      "TaskExecutionId": "task-exec-xxx",
      "UpdateDate": "2019-05-16T10:26:14Z",
      "Loop": {},
      "TemplateId": "xxx",
      "LoopBatchNumber": 2,
      "StatusMessage": "\"\"",
      "ExtraData": {
        "NotifyNote": ""
      },
      "Properties": "{ \"Status\":\"Running\" }"
    }
  ]
}

JSON格式

{
  "NextToken": "MTRBMDc0NjAtRUJFNy00N0NBLTk3NTctMTJDQzQ3NjFENDdB",
  "RequestId": "CDABABABAB-FC28-4D9C-8FB5-68DC6F0486FC",
  "MaxResults": 50,
  "TaskExecutions": [
    {
      "ChildExecutionId": "exec-xxx",
      "Outputs": "{ \"InstanceId\":\"i-xxx\" }",
      "Status": "Running",
      "EndDate": "2019-05-16T10:26:14Z",
      "ParentTaskExecutionId": "task-exec-xxx",
      "TaskName": "describeInstance\t",
      "StartDate": "2019-05-16T10:26:14Z",
      "LoopItem": "i-1234566zxcvvb",
      "CreateDate": "2019-05-16T10:26:14Z",
      "ExecutionId": "exec-44d32b45d2a449e49899",
      "TaskAction": "ACS::Sleep",
      "TaskExecutionId": "task-exec-xxx",
      "UpdateDate": "2019-05-16T10:26:14Z",
      "Loop": {},
      "TemplateId": "xxx",
      "LoopBatchNumber": 2,
      "StatusMessage": "\"\"",
      "ExtraData": {
        "NotifyNote": ""
      },
      "Properties": "{ \"Status\":\"Running\" }"
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-08-15API 内部配置变更,不影响调用查看变更详情