用户在使用响应编排的功能进行事件处置时,处置中心会生成相应的处置任务,该接口用于获取处置任务的列表信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
yundun-sas:DescribeProcessTasks | Read |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ProcessStrategyUuid | string | 否 | 处置策略的 UUID。 说明
调用 ListDisposeStrategy 接口可以获取该参数。
| 92af3c79-1754-4646-9366-9ddbd1e45536_xxxx |
EntityName | string | 否 | 处置的实体的名称。 | 127.0.0.1 |
EntityType | string | 否 | 处置的实体类型,取值:
| ip |
SceneCode | string | 否 | 处置任务的场景 CODE。 说明
调用 DescribeEnumItems 接口可以获取该参数,接口的入参 EnumType 为 process。
| event_xxx_whole_process |
TaskStatus | string | 否 | 处置任务的状态列表,为数据字符串的格式,取值:
| ["11","21"] |
Scope | string | 否 | 处置的阿里云账户 ID。 | 125xxxxx9870 |
Source | string | 否 | 处置任务的触发来源,为数组字符串格式,取值:
| ["system"] |
ProcessActionStart | long | 否 | 处置时间的查询开始时间,格式:13 位的时间戳。 | 1700031183572 |
ProcessActionEnd | long | 否 | 处置时间的查询结束时间,格式:13 位的时间戳。 | 1700031183572 |
ProcessRemoveStart | long | 否 | 解封时间的查询开始时间,格式:13 位的时间戳。 | 1700031183572 |
ProcessRemoveEnd | long | 否 | 解封时间的查询结束时间,格式:13 位的时间戳。 | 1700031183572 |
ParamContent | string | 否 | 模糊匹配,会查询实体、处置场景、处置参数字段。 | 12.x.x.x |
PageSize | integer | 否 | 指定分页查询时,每页显示的数据最大条数。每页默认显示的数据条数为 20 条,PageSize 参数值为空时,将默认返回 10 条数据。 说明
建议 PageSize 取值不要为空。
| 10 |
PageNumber | string | 否 | 设置从返回结果的第几页开始显示查询结果。默认值为 1,表示从第 1 页开始显示。 | 1 |
YunCode | string | 否 | 处置任务关联的云产品,为数据字符串格式,取值:
| ["WAF"] |
TaskId | string | 否 | 处置任务的唯一标识。 说明
用于查询某具体任务,参数可由接口的返回值中获取。
| 150xxxxxxxxx95066 |
OrderField | string | 否 | 结果的排序字段。 说明
排序的字段,由接口的返回结果中获取。
| gmtCreate |
Direction | string | 否 | 排序方向,取值:
| desc |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "E7698CFB-4E1C-5840-8EC9-691B86729E94",
"ProcessTasks": [
{
"TaskId": "150xxxxxxxxx95066",
"Creator": "123xxxx355",
"GmtCreateMillis": 1700031183572,
"GmtModifiedMillis": 1700031183572,
"YunCode": "WAF",
"EntityName": "1.1.1.x",
"EntityType": "ip",
"TaskStatus": 11,
"Scope": "123xxxxx234",
"InputParams": "{\"groupuuid\":\"c6a9b1df-f4ac-4078-bef4-99xxxxxx\"}",
"SceneCode": "event_xxx_whole_process",
"SceneName": "waf_whole_process",
"ProcessTime": 1700031183572,
"RemoveTime": 1700031183572,
"ProcessStrategyUuid": "92af3c79-1754-4646-9366-9ddbd1e45536_xxxx",
"Source": "system",
"ErrCode": "sts_openapi.Info.DefenseSceneNotSupported",
"ErrMsg": "ParamError : The parameters of your request are invalid",
"ErrTip": "Verify that the input parameters of the components are correct"
}
],
"Page": {
"TotalCount": 30,
"PageNumber": 1,
"PageSize": 10
}
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||
---|---|---|---|---|
2024-05-21 | OpenAPI 返回结构发生变更 | 看变更集 | ||
| ||||
2024-03-19 | OpenAPI 返回结构发生变更 | 看变更集 | ||
|