ListExecutions - 查询执行 - 系统运维管理

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

调试

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

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
oos:ListExecutions	list	Execution acs:oos:{#regionId}:{#accountId}:execution/* Execution acs:oos:{#regionId}:{#accountId}:execution/{#executionId}	oos:tag	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	否	地域 ID	cn-hangzhou
TemplateName	string	否	模板名称。名称未包含关系，最终列出包含所填模板名称的所有模板。	MyTemplate
Status	string	否	执行状态，取值范围：Running, Started, Success, Failed, Waiting, Cancelled, Pending, Skipped。	Running
ExecutionId	string	否	执行 ID	exec-xxx
StartDateBefore	string	否	开始时间小于等于指定时间的执行	2019-05-16T10:26:14Z
StartDateAfter	string	否	开始时间大于等于指定时间的执行	2019-05-16T10:26:14Z
EndDateBefore	string	否	结束时间小于等于指定时间的执行	2019-05-16T10:26:14Z
EndDateAfter	string	否	结束时间大于等于指定时间的执行	2019-05-16T10:26:14Z
Mode	string	否	执行模式。取值范围： Automatic Debug	Automatic
ExecutedBy	string	否	执行者	vme
ParentExecutionId	string	否	父执行 ID	exec-xxx
RamRole	string	否	RAM 角色	OOSServiceRole
IncludeChildExecution	boolean	否	是否包含子执行。默认为 False。	true
Category	string	否	执行的模版类型。可分为 Other、TimerTrigger、EventTrigger、AlarmTrigger。	Other
Tags	object	否	执行的标签	{ "k1": "v1", "k2": "v2" }
MaxResults	integer	否	分页大小。取值范围：10-100。默认为 50。	50
NextToken	string	否	翻页标记的 Token	MTRBMDc0NjAtRUJFNy00N0NBLTk3NTctMTJDQzQ
SortField	string	否	排序字段。取值范围： StartDate（默认值）：创建时间 EndDate：结束时间 Status：状态	StartDate
SortOrder	string	否	排序方向。取值范围： Ascending：升序 Descending（默认值）：降序	Ascending
ResourceId	string	否	ECS 资源 ID	i-xxx
ResourceTemplateName	string	否	资源的模板名称	ACS-ECS-TEST
ResourceGroupId	string	否	资源组 ID。	rg-acfmxsn4m4******
Description	string	否	执行的描述。	MyDescription
Depth	string	否	执行的深度，可分为 RootDepth、FirstChildDepth RootDepth 只返回主执行，FirstChildDepth 只返回第一层的子执行。此参数和 IncludeChildExecution 参数只能同时传入一个，推荐使用 Depth。	RootDepth
Categories	string	否	执行的模板类型列表。可分为 Other、TimerTrigger、EventTrigger、AlarmTrigger。此参数和 Category 参数只能同时传入一个，推荐使用 Categories。	["TimerTrigger"、"EventTrigger"]

返回参数

名称	类型	描述	示例值
	object
NextToken	string	翻页标记的 Token	MTRBMDc0NjAtRUJFNy00N0NBLTk3NTctMTJDQzQ
RequestId	string	请求 ID	14A074-47CA-9757-12CC4761D47A
MaxResults	integer	分页大小	50
Executions	array<object>	执行数据
Execution	object
Status	string	执行状态。取值范围为 Started, Queued, Running, Waiting, Success, Failed, Cancelled。	Success
WaitingStatus	string	等待状态	""
Targets	string	目标资源	"{"ResourceType": "ALIYUN::ECS::Instance", "Filters": [{"ResourceIds": ["i-bp14z07dg3464980x72o"], "RegionId": "cn-hangzhou", "Type": "ResourceIds"}]}"
StatusReason	string	状态原因	""
Tags	object	执行的标签	{}
LastSuccessfulTriggerTime	string	最近一次成功触发模板的时间	2019-05-27T09:29:18Z
Mode	string	执行模式	Automatic
SafetyCheck	string	安全检查模式。取值范围为 Skip, ConfirmEveryHighRiskAction。	Skip
TemplateName	string	模板名称	MyTemplate
TemplateVersion	string	模板版本号	v1
CreateDate	string	执行创建时间	2019-05-16T10:26:14Z
UpdateDate	string	执行更新时间	2019-05-16T10:26:14Z
Description	string	执行描述	MyDescription
LastTriggerTime	string	最近一次触发模板的时间	2019-05-27T09:29:18Z
ParentExecutionId	string	父执行 ID	exec-xxx
LastTriggerStatus	string	最近一次触发模版后的执行状态	Success
StatusMessage	string	任务执行状态	“”
Outputs	string	执行输出结果	{ "InstanceId":"i-xxx" }
ExecutedBy	string	执行模板者	1309252800
EndDate	string	执行结束时间	2019-05-16T10:26:14Z
IsParent	boolean	标记是否包含子任务	false
StartDate	string	执行开始时间	2019-05-16T10:26:14Z
ExecutionId	string	执行的唯一标识	exec-44d32b45d2a449e
Parameters	object	执行的输入参数	{ "Status":"Running" }
Counters	object	任务按执行状态计数	{"Failed": 0,"Success": 1,"Total": 2}
ResourceGroupId	string	资源组 ID	rg-acfmxsn4m4******
Category	string	执行的模版类型。可分为 Other、TimerTrigger、EventTrigger、AlarmTrigger。	Other
TemplateId	string	模板 ID	123
RamRole	string	执行当前模板的角色	OOSServiceRole
ResourceStatus	string	资源状态	{ "Success": 1 }
CurrentTasks	array<object>	当前正在运行的 Tasks
CurrentTask	object
TaskExecutionId	string	Task 执行 ID	task-exec-44d32b45d2a49899#1
TaskName	string	Task 名称	installSLSILogtail
TaskAction	string	Task 执行模板	acs::Template
LastTriggerStatusMessage	string	最近一次任务执行状态（定时、事件、告警类执行表示的是最近一次触发的执行状态，非触发类执行此字段与 StatusMessage 字段内容一致）	""
LastTriggerOutputs	string	最近一次执行输出结果（定时、事件、告警类执行表示的是最近一次触发的输出结果，非触发类执行此字段与 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-27	OpenAPI 入参发生变更	查看变更详情
2023-03-27	OpenAPI 入参发生变更	查看变更详情