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

ListExecutions - 查询执行

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

调试

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

调试

授权信息

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

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

请求参数

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

地域ID

cn-hangzhou
TemplateNamestring

模板名称。名称未包含关系,最终列出包含所填模板名称的所有模板。

MyTemplate
Statusstring

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

Running
ExecutionIdstring

执行ID

exec-xxx
StartDateBeforestring

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

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

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

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

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

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

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

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

执行模式。取值范围:

  • Automatic
  • Debug
Automatic
ExecutedBystring

执行者

vme
ParentExecutionIdstring

父执行ID

exec-xxx
RamRolestring

RAM角色

OOSServiceRole
IncludeChildExecutionboolean

是否包含子执行。默认为False。

true
Categorystring

执行的模版类型。可分为Other、TimerTrigger、EventTrigger、AlarmTrigger。

Other
Tagsobject

执行的标签

MaxResultsinteger

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

50
NextTokenstring

翻页标记的Token

MTRBMDc0NjAtRUJFNy00N0NBLTk3NTctMTJDQzQ
SortFieldstring

排序字段。取值范围:

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

排序方向。取值范围:

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

ECS资源ID

i-xxx
ResourceTemplateNamestring

资源的模板名称

ACS-ECS-TEST
ResourceGroupIdstring

资源组ID。

rg-acfmxsn4m4******

返回参数

名称类型描述示例值
object
NextTokenstring

翻页标记的Token

MTRBMDc0NjAtRUJFNy00N0NBLTk3NTctMTJDQzQ
RequestIdstring

请求ID

14A074-47CA-9757-12CC4761D47A
MaxResultsinteger

分页大小

50
Executionsarray

执行数据

object
Statusstring

执行状态。取值范围为Started, Queued, Running, Waiting, Success, Failed, Cancelled。

Success
WaitingStatusstring

等待状态

""
Targetsstring

目标资源

""
StatusReasonstring

状态原因

""
Tagsobject

执行的标签

LastSuccessfulTriggerTimestring

最近一次成功触发模板的时间

2019-05-27T09:29:18Z
Modestring

执行模式

Automatic
SafetyCheckstring

安全检查模式。取值范围为Skip, ConfirmEveryHighRiskAction。

Skip
TemplateNamestring

模板名称

MyTemplate
TemplateVersionstring

模板版本号

v1
CreateDatestring

执行创建时间

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

执行更新时间

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

执行描述

test execution.
LastTriggerTimestring

最近一次触发模板的时间

2019-05-27T09:29:18Z
ParentExecutionIdstring

父执行ID

exec-xxx
LastTriggerStatusstring

最近一次触发模版后的执行状态

Success
StatusMessagestring

任务执行状态

“”
Outputsstring

执行输出结果

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

执行模板者

1309252800
EndDatestring

执行结束时间

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

标记是否包含子任务

false
StartDatestring

执行开始时间

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

执行的唯一标识

exec-44d32b45d2a449e
Parametersobject

执行的输入参数

Countersobject

任务按执行状态计数

ResourceGroupIdstring

资源组ID

rg-acfmxsn4m4******
Categorystring

执行的模版类型。可分为Other、TimerTrigger、EventTrigger、AlarmTrigger。

Other
TemplateIdstring

模板ID

123
RamRolestring

执行当前模板的角色

OOSServiceRole
ResourceStatusstring

资源状态

{ "Success": 1 }
CurrentTasksarray

当前正在运行的Tasks

object
TaskExecutionIdstring

Task执行ID

task-exec-44d32b45d2a49899#1
TaskNamestring

Task名称

installSLSILogtail
TaskActionstring

Task执行模板

acs::Template

示例

请求示例

http(s)://[Endpoint]/?Action=ListExecutions
&RegionId=cn-hangzhou
&TemplateName=MyTemplate
&Status=Running
&ExecutionId=exec-xxx
&StartDateBefore=2019-05-16T10:26:14Z
&StartDateAfter=2019-05-16T10:26:14Z
&EndDateBefore=2019-05-16T10:26:14Z
&EndDateAfter=2019-05-16T10:26:14Z
&Mode=Automatic
&ExecutedBy=vme
&ParentExecutionId=exec-xxx
&RamRole=OOSServiceRole
&IncludeChildExecution=true
&Category=Other
&MaxResults=50
&NextToken=MTRBMDc0NjAtRUJFNy00N0NBLTk3NTctMTJDQzQ
&SortField=StartDate
&SortOrder=Ascending
&ResourceId=i-xxx
&ResourceTemplateName=ACS-ECS-TEST
&ResourceGroupId=rg-acfmxsn4m4******
&公共请求参数

正常返回示例

JSON格式

{
    "NextToken": "MTRBMDc0NjAtRUJFNy00N0NBLTk3NTctMTJDQzQ",
    "RequestId": "14A074-47CA-9757-12CC4761D47A",
    "MaxResults": 50,
    "Executions": [
        {
            "Status": "Success",
            "WaitingStatus": "\"\"",
            "Targets": "\"\"",
            "StatusReason": " \"\"",
            "LastSuccessfulTriggerTime": "2019-05-27T09:29:18Z",
            "Mode": "Automatic",
            "SafetyCheck": "Skip",
            "TemplateName": "MyTemplate",
            "TemplateVersion": "v1",
            "CreateDate": "2019-05-16T10:26:14Z",
            "UpdateDate": "2019-05-16T10:26:14Z",
            "Description": "test execution.",
            "LastTriggerTime": "2019-05-27T09:29:18Z",
            "ParentExecutionId": "exec-xxx",
            "LastTriggerStatus": "Success",
            "StatusMessage": "“”",
            "Outputs": "{ \"InstanceId\":\"i-xxx\" }",
            "ExecutedBy": "1309252800",
            "EndDate": "2019-05-16T10:26:14Z",
            "IsParent": false,
            "StartDate": "2019-05-16T10:26:14Z",
            "ExecutionId": "exec-44d32b45d2a449e",
            "ResourceGroupId": "rg-acfmxsn4m4******",
            "Category": "Other",
            "TemplateId": "123",
            "RamRole": "OOSServiceRole",
            "ResourceStatus": "{ \t\t\t\"Success\": 1 \t\t}",
            "CurrentTasks": [
                {
                    "TaskExecutionId": "task-exec-44d32b45d2a49899#1",
                    "TaskName": "installSLSILogtail",
                    "TaskAction": "acs::Template"
                }
            ]
        }
    ]
}

XML格式

<ListExecutionsResponse>
    <NextToken>MTRBMDc0NjAtRUJFNy00N0NBLTk3NTctMTJDQzQ</NextToken>
    <RequestId>14A074-47CA-9757-12CC4761D47A</RequestId>
    <MaxResults>50</MaxResults>
    <Executions>
        <Status>Success</Status>
        <WaitingStatus>""</WaitingStatus>
        <Targets>""</Targets>
        <StatusReason> ""</StatusReason>
        <LastSuccessfulTriggerTime>2019-05-27T09:29:18Z</LastSuccessfulTriggerTime>
        <Mode>Automatic</Mode>
        <SafetyCheck>Skip</SafetyCheck>
        <TemplateName>MyTemplate</TemplateName>
        <TemplateVersion>v1</TemplateVersion>
        <CreateDate>2019-05-16T10:26:14Z</CreateDate>
        <UpdateDate>2019-05-16T10:26:14Z</UpdateDate>
        <Description>test execution.</Description>
        <LastTriggerTime>2019-05-27T09:29:18Z</LastTriggerTime>
        <ParentExecutionId>exec-xxx</ParentExecutionId>
        <LastTriggerStatus>Success</LastTriggerStatus>
        <StatusMessage>“”</StatusMessage>
        <Outputs>{ "InstanceId":"i-xxx" }</Outputs>
        <ExecutedBy>1309252800</ExecutedBy>
        <EndDate>2019-05-16T10:26:14Z</EndDate>
        <IsParent>false</IsParent>
        <StartDate>2019-05-16T10:26:14Z</StartDate>
        <ExecutionId>exec-44d32b45d2a449e</ExecutionId>
        <ResourceGroupId>rg-acfmxsn4m4******</ResourceGroupId>
        <Category>Other</Category>
        <TemplateId>123</TemplateId>
        <RamRole>OOSServiceRole</RamRole>
        <ResourceStatus>{ 			"Success": 1 		}</ResourceStatus>
        <CurrentTasks>
            <TaskExecutionId>task-exec-44d32b45d2a49899#1</TaskExecutionId>
            <TaskName>installSLSILogtail</TaskName>
            <TaskAction>acs::Template</TaskAction>
        </CurrentTasks>
    </Executions>
</ListExecutionsResponse>

错误码

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

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