文档

ListExecutions - 查询执行

更新时间:

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

调试

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

授权信息

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

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

执行的标签

{ "k1": "v1", "k2": "v2" }
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******
Descriptionstring

执行的描述。

MyDescription
Depthstring

执行的深度,可分为 RootDepth、FirstChildDepth RootDepth 只返回主执行,FirstChildDepth 只返回第一层的子执行。此参数和 IncludeChildExecution 参数只能同时传入一个,推荐使用 Depth。

RootDepth
Categoriesstring

执行的模板类型列表。可分为 Other、TimerTrigger、EventTrigger、AlarmTrigger。此参数和 Category 参数只能同时传入一个,推荐使用 Categories。

["TimerTrigger"、"EventTrigger"]

返回参数

名称类型描述示例值
object
NextTokenstring

翻页标记的 Token

MTRBMDc0NjAtRUJFNy00N0NBLTk3NTctMTJDQzQ
RequestIdstring

请求 ID

14A074-47CA-9757-12CC4761D47A
MaxResultsinteger

分页大小

50
Executionsobject []

执行数据

Statusstring

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

Success
WaitingStatusstring

等待状态

""
Targetsstring

目标资源

"{"ResourceType": "ALIYUN::ECS::Instance", "Filters": [{"ResourceIds": ["i-bp14z07dg3464980x72o"], "RegionId": "cn-hangzhou", "Type": "ResourceIds"}]}"
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

执行描述

MyDescription
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

执行的输入参数

{ "Status":"Running" }
Countersobject

任务按执行状态计数

{"Failed": 0,"Success": 1,"Total": 2}
ResourceGroupIdstring

资源组 ID

rg-acfmxsn4m4******
Categorystring

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

Other
TemplateIdstring

模板 ID

123
RamRolestring

执行当前模板的角色

OOSServiceRole
ResourceStatusstring

资源状态

{ "Success": 1 }
CurrentTasksobject []

当前正在运行的 Tasks

TaskExecutionIdstring

Task 执行 ID

task-exec-44d32b45d2a49899#1
TaskNamestring

Task 名称

installSLSILogtail
TaskActionstring

Task 执行模板

acs::Template
LastTriggerStatusMessagestring

最近一次任务执行状态(定时、事件、告警类执行表示的是最近一次触发的执行状态,非触发类执行此字段与 StatusMessage 字段内容一致)

""
LastTriggerOutputsstring

最近一次执行输出结果(定时、事件、告警类执行表示的是最近一次触发的输出结果,非触发类执行此字段与 Outputs 字段内容一致)

{ "InstanceId": "i-xxx" }

示例

正常返回示例

JSON格式

{
  "NextToken": "MTRBMDc0NjAtRUJFNy00N0NBLTk3NTctMTJDQzQ",
  "RequestId": "14A074-47CA-9757-12CC4761D47A",
  "MaxResults": 50,
  "Executions": [
    {
      "Status": "Success",
      "WaitingStatus": "\"\"",
      "Targets": "\"{\"ResourceType\": \"ALIYUN::ECS::Instance\", \"Filters\": [{\"ResourceIds\": [\"i-bp14z07dg3464980x72o\"], \"RegionId\": \"cn-hangzhou\", \"Type\": \"ResourceIds\"}]}\"",
      "StatusReason": "\"\"",
      "Tags": {},
      "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": "MyDescription",
      "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",
      "Parameters": {
        "Status": "Running"
      },
      "Counters": {
        "Failed": 0,
        "Success": 1,
        "Total": 2
      },
      "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"
        }
      ],
      "LastTriggerStatusMessage": "\"\"",
      "LastTriggerOutputs": "{\n      \"InstanceId\": \"i-xxx\"\n}"
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-04-27OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:Depth
    新增入参:Categories
2023-03-27OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:Description
  • 本页导读 (0)