文档

ListDisposeStrategy - 获取处置策略列表

更新时间:

获取处置策略列表。

调试

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

授权信息

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

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

请求参数

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

SOAR 处置策略 ID。

a50a49b7-6044-4593-ab15-2b46567caadd
EntityIdentitystring

实体特征值,可以对处置实体进行模糊搜索。

test22.php
EntityTypestring

剧本支持的实体类型。取值:

  • ip:ip
  • process:进程
  • file:文件
ip
PlaybookNamestring

剧本唯一标识名称。

WafBlockIP
PlaybookUuidstring

剧本 UUID。

system_aliyun_clb_process_book
PlaybookTypesstring

剧本类型。取值:

  • system:手动处置
  • custom:事件触发剧本
  • custom_alert:告警触发剧本
  • soar-manual:手动运行剧本
  • soar-mdr:MDR 运行剧本
system
EffectiveStatusinteger

策略状态。取值:

  • 0:失效
  • 1:有效
0
OrderFieldstring

排序字段。取值:

  • GmtModified:按更新时间排序
  • GmtCreate:按创建时间排序
  • FinishTime:按策略结束时间排序
GmtModified
Orderstring

排序方向。取值:

  • desc:降序排列
  • asc:升序排列
desc
StartTimelong

查询开始时间,单位毫秒。

1577808000000
EndTimelong

查询结束时间,单位毫秒。

1577808000000
CurrentPageinteger

列表当前页号,大于等于 1。

1
PageSizeinteger

列表每页条数,最大不超过 100。

10
RoleTypeinteger

视图类型。

  • 0:当前阿里云账号视图。
  • 1:企业下所有账号的视图。
1
RoleForlong

管理员切换成其他成员视角的用户 ID。

113091674488****
RegionIdstring

威胁分析的数据管理中心所在地。您需要根据资产所在地域,选择管理中心所在地。取值:

  • cn-hangzhou:资产属于中国内地与中国香港
  • ap-southeast-1:资产属于海外地域
cn-hangzhou

返回参数

名称类型描述示例值
object

PageResponse<List>

Successboolean

请求是否成功。取值:

  • true:成功
  • false:失败
true
Codeinteger

请求状态码。

200
Messagestring

请求返回消息。

success
RequestIdstring

请求 ID。

9AAA9ED9-78F4-5021-86DC-D51C7511****
Dataobject

请求返回值。

PageInfoobject

分页记录。

CurrentPageinteger

列表当前页号。

1
PageSizeinteger

每页返回记录数。

10
TotalCountlong

记录总数。

100
ResponseDataarray<object>

详细数据。

ResponseDataobject
Idlong

策略 ID。

123
GmtCreatestring

创建时间。

2021-01-06 16:37:29
GmtModifiedstring

修改时间。

2021-01-06 16:37:29
Aliuidlong

策略关联 SIEM 主账号 ID。

127608589417****
SubAliuidlong

配置策略阿里账号 ID。

176555323***
IncidentNamestring

事件名称。

Multiple type of alerts, including Miner Network, Command line download and run malicious files, Backdoor Process, etc
Scopearray

处置作用域。

Scopeany

处置作用域。

[{ aliUid: 1766185894104675 }]
IncidentUuidstring

事件全局唯一 UUID。

85ea4241-798f-4684-a876-65d4f0c3****
AlertUuidstring

告警 UUID。

sas_71e24437d2797ce8fc59692905a4****
SophonTaskIdstring

SOAR 处置策略 ID。

577bbf90-a770-44a7-8154-586aa2d318fa
PlaybookNamestring

剧本唯一标识名称。

WafBlockIP
PlaybookUuidstring

剧本 UUID。

system_aliyun_clb_process_book
PlaybookTypestring

剧本类型。取值:

  • system:手动处置
  • custom:事件触发剧本
  • custom_alert:告警触发剧本
  • soar-manual:手动运行剧本
  • soar-mdr:MDR 运行剧本
system
TaskUrlstring

剧本 url

EntityIdlong

实体 ID。

123456789
Entityarray

实体详情,json 数组格式。

Entityany

实体详情,json 数组格式。

[{"ip":"1.1.1.1"}]
EntityTypestring

实体类型。取值:

  • ip:ip
  • process:进程
  • file:文件
ip
TaskParamstring

触发剧本参数,json 格式。

{ "file": { "op_code": "2", "file_path": "/root/alert0913/a886.jsp", "entity_type": "file", "entity_name": "a886.jsp", "file_name": "a886.jsp", "file_owner": "USER:,GROUP:", "hash_value": "5def10c9a4287d0920d86b42420b20b0", "op_level": "2", "entity_id": "/root/alert0913/a886.jsp", "host_uuid": { "entity_type": "host", "entity_name": "N/A", "is_comprised": "1", "os_type": "linux", "entity_id": "5f58ef67-8803-4314-8d67-c87dc92b****", "host_uuid": "5f58ef67-8803-4314-8d67-c87dc92b****", "host_name": "N/A" }, "malware_type": "${aliyun.siem.sas.alert_tag.webshell}" }, "_sys_siem": { "cloudCode": "aliyun", "alertId": "89416745494****" }, "scope": [ { "aliUid": 1766185894104**** } ] }
ErrorMessagestring

任务的失败摘要信息。

DisposalEntity failed which description is Aegis Quarantine File , return_info failed which description is Check Aegis Process Result , [ERROR DETAIL] *******.php:file not found
FinishTimestring

任务的结束时间。

2021-08-10 21:34:07
EffectiveStatusinteger

策略状态。取值:

  • 0:失效
  • 1:有效
0
Statusinteger

剧本调用状态。取值:

  • 200:成功
  • 10:删除
  • 5:失败
  • 0:初始状态
10

示例

正常返回示例

JSON格式

{
  "Success": true,
  "Code": 200,
  "Message": "success",
  "RequestId": "9AAA9ED9-78F4-5021-86DC-D51C7511****",
  "Data": {
    "PageInfo": {
      "CurrentPage": 1,
      "PageSize": 10,
      "TotalCount": 100
    },
    "ResponseData": [
      {
        "Id": 123,
        "GmtCreate": "2021-01-06 16:37:29",
        "GmtModified": "2021-01-06 16:37:29",
        "Aliuid": 0,
        "SubAliuid": 0,
        "IncidentName": "Multiple type of alerts, including Miner Network, Command line download and run malicious files, Backdoor Process, etc",
        "Scope": [
          "[{ aliUid: 1766185894104675 }]"
        ],
        "IncidentUuid": "85ea4241-798f-4684-a876-65d4f0c3****",
        "AlertUuid": "sas_71e24437d2797ce8fc59692905a4****",
        "SophonTaskId": "577bbf90-a770-44a7-8154-586aa2d318fa",
        "PlaybookName": "WafBlockIP",
        "PlaybookUuid": "system_aliyun_clb_process_book",
        "PlaybookType": "system",
        "TaskUrl": "",
        "EntityId": 123456789,
        "Entity": [
          "[{\"ip\":\"1.1.1.1\"}]"
        ],
        "EntityType": "ip",
        "TaskParam": "{\n      \"file\": {\n            \"op_code\": \"2\",\n            \"file_path\": \"/root/alert0913/a886.jsp\",\n            \"entity_type\": \"file\",\n            \"entity_name\": \"a886.jsp\",\n            \"file_name\": \"a886.jsp\",\n            \"file_owner\": \"USER:,GROUP:\",\n            \"hash_value\": \"5def10c9a4287d0920d86b42420b20b0\",\n            \"op_level\": \"2\",\n            \"entity_id\": \"/root/alert0913/a886.jsp\",\n            \"host_uuid\": {\n                  \"entity_type\": \"host\",\n                  \"entity_name\": \"N/A\",\n                  \"is_comprised\": \"1\",\n                  \"os_type\": \"linux\",\n                  \"entity_id\": \"5f58ef67-8803-4314-8d67-c87dc92b****\",\n                  \"host_uuid\": \"5f58ef67-8803-4314-8d67-c87dc92b****\",\n                  \"host_name\": \"N/A\"\n            },\n            \"malware_type\": \"${aliyun.siem.sas.alert_tag.webshell}\"\n      },\n      \"_sys_siem\": {\n            \"cloudCode\": \"aliyun\",\n            \"alertId\": \"89416745494****\"\n      },\n      \"scope\": [\n            {\n                  \"aliUid\": 1766185894104****\n            }\n      ]\n}",
        "ErrorMessage": "DisposalEntity failed which description is Aegis Quarantine File , return_info failed which description is Check Aegis Process Result , [ERROR DETAIL] *******.php:file not found",
        "FinishTime": "2021-08-10 21:34:07",
        "EffectiveStatus": 0,
        "Status": 10
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
500InternalErrorThe request processing has failed due to some unknown error.服务发生某些未知错误,请稍后再试

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

变更历史

变更时间变更内容概要操作
2024-04-17OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情