查询任务执行,支持多种过滤方式。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
oos:ListTaskExecutions | get |
|
| 无 |
请求语法
POST /ListTaskExecutions
GET /ListTaskExecutions
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 否 | 地域 ID | cn-hangzhou |
ExecutionId | string | 否 | 执行 ID | exec-xxx |
Status | string | 否 | 执行状态,取值范围:Running, Started, Success, Failed, Waiting, Cancelled, Pending, Skipped。 | Running |
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 |
TaskExecutionId | string | 否 | 任务执行 ID | task-exec-xxx |
TaskName | string | 否 | 任务名称 | describeInstance |
TaskAction | string | 否 | 任务动作 | ACS::Sleep |
ParentTaskExecutionId | string | 否 | 父任务执行 ID。Loop 情况会用到,一般是 Loop 的 Parent 的 TaskExecutionId。 | task-exec-xxx |
IncludeChildTaskExecution | boolean | 否 | 标记是否展示 Loop 产生的子 Task。默认为 False。 | false |
MaxResults | integer | 否 | 分页大小。取值范围:20-100。默认为 50。 | 50 |
NextToken | string | 否 | 翻页标记的 Token | MTRBMDc0NjAtRUJFNy00N0NBLTk3NTctMTJDQzQ3NjFENDdB |
SortField | string | 否 | 排序字段。取值范围:
| StartDate |
SortOrder | string | 否 | 排序方向。取值范围:
| Ascending |
返回参数
示例
正常返回示例
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-15 | API 内部配置变更,不影响调用 | 查看变更详情 |