首页 运维编排服务 API参考 API目录 执行 ListTaskExecutions - 查询任务执行

ListTaskExecutions - 查询任务执行

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

调试

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

调试

授权信息

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

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

请求参数

名称类型必填描述示例值
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
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

附加数据

Propertiesstring

执行的输入参数

{ "Status":"Running" }

示例

请求示例

http(s)://oos.cn-hangzhou.aliyuncs.com/?Action=ListTaskExecutions
&<公共请求参数>

正常返回示例

JSON格式

{
    "code": 200,
    "data": {
        "RequestId": "CDABABABAB-FC28-4D9C-8FB5-68DC6F0486FC",
        "MaxResults": 100,
        "TaskExecutions": {
            "Status": "Success",
            "Loop": "",
            "TaskAction": "ACS::Sleep",
            "ExtraData": {
                "NotifyNote": ""
            },
            "Properties": {
                "Duration": "PT1M"
            },
            "CreateDate": "2019-10-16T07:45:09Z",
            "EndDate": "2019-10-16T07:46:10Z",
            "StatusMessage": "Sleep estimated finish time (2019-10-16 07:46:09.502154)",
            "StartDate": "2019-10-16T07:45:09Z",
            "UpdateDate": "2019-10-16T07:46:10Z",
            "LoopItem": "",
            "TaskName": "waitDataRecover",
            "Outputs": "",
            "TaskExecutionId": "exec-934bc37ea31f4b9e9312.t0001",
            "ExecutionId": "exec-934bc37ea31f4b9e9312"
        }
    },
    "requestId": "CDABABABAB-FC28-4D9C-8FB5-68DC6F0486FC",
    "successResponse": true
}

XML格式

<code>200</code>
<data>
    <RequestId>CDABABABAB-FC28-4D9C-8FB5-68DC6F0486FC</RequestId>
    <MaxResults>100</MaxResults>
    <TaskExecutions>
        <Status>Success</Status>
        <Loop/>
        <TaskAction>ACS::Sleep</TaskAction>
        <ExtraData>
            <NotifyNote/>
        </ExtraData>
        <Properties>
            <Duration>PT1M</Duration>
        </Properties>
        <CreateDate>2019-10-16T07:45:09Z</CreateDate>
        <EndDate>2019-10-16T07:46:10Z</EndDate>
        <StatusMessage>Sleep estimated finish time (2019-10-16 07:46:09.502154)</StatusMessage>
        <StartDate>2019-10-16T07:45:09Z</StartDate>
        <UpdateDate>2019-10-16T07:46:10Z</UpdateDate>
        <LoopItem/>
        <TaskName>waitDataRecover</TaskName>
        <Outputs/>
        <TaskExecutionId>exec-934bc37ea31f4b9e9312.t0001</TaskExecutionId>
        <ExecutionId>exec-934bc37ea31f4b9e9312</ExecutionId>
    </TaskExecutions>
</data>
<requestId>CDABABABAB-FC28-4D9C-8FB5-68DC6F0486FC</requestId>
<successResponse>true</successResponse>

错误码

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

阿里云首页 运维编排服务 相关技术圈