DescribeDisposeAndPlaybook - 获取需要被处置的实体列表与剧本列表_云安全中心(Security Center)-阿里云帮助中心

获取需要被处置的实体列表与剧本列表。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

yundun-sas:DescribeDisposeAndPlaybook

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
EntityType	string	否	实体类型。取值： ip：ip process：进程 file：文件	ip
IncidentUuid	string	否	事件 UUID。	85ea4241-798f-4684-a876-65d4f0c3****
EntityUuid	string	否	实体 uuid。	85ea4241-798f-4684-a876-65d4f0c3****
CurrentPage	integer	否	列表当前页号，大于等于 1。	1
PageSize	integer	否	列表每页条数，最大不超过 100。	10
RoleType	integer	否	视图类型。 0：当前阿里云账号视图。 1：企业下所有账号的视图。	1
RoleFor	integer	否	管理员切换成其他成员视角的用户 ID。	113091674488****
RegionId	string	否	威胁分析的数据管理中心所在地。您需要根据资产所在地域，选择管理中心所在地。取值： cn-hangzhou：资产属于中国内地与中国香港 ap-southeast-1：资产属于海外地域	cn-hangzhou

返回参数

名称	类型	描述	示例值
	object	PageResponse<List>
Success	boolean	请求是否成功。取值： true：成功 false：失败	true
Code	integer	请求状态码。	200
Message	string	请求返回消息。	success
RequestId	string	请求 ID。	9AAA9ED9-78F4-5021-86DC-D51C7511****
Data	object	请求返回值。	123456
PageInfo	object	分页记录。
CurrentPage	integer	列表当前页号。	1
PageSize	integer	每页返回记录数。	10
TotalCount	integer	记录总数。	100
ResponseData	array<object>	详细数据。
	object
EntityId	integer	实体 ID。	12345****
EntityType	string	实体类型。取值： ip:ip domain：域名 url：url process：进程 file：文件 host：主机	ip
OpcodeMap	object	opcode 与 oplevel 键值对。	12345
	string	opcode 与 oplevel 键值对。	{"7","2"}
OpcodeSet	array	实体处置推荐剧本 code。	[1,3]
	string	实体处置推荐剧本 code。	7
EntityInfo	object	实体信息。	{"file_path": "c:/www/leixi.jsp","file_hash": "aa0ca926ad948cd820e0a3d9a18c**","host_uuid": "efed2cf7-0b77-45d9-a97b-d2cf246b","malware_type": "${aliyun.siem.sas.alert_tag.webshell}","host_name": "launch-advisor-2023**"}
Dispose	string	处置对象。	192.168..
Scope	array	处置作用域，可进行处置用户 ID 列表。	176618589410****
	any	处置作用域，可进行处置用户 ID 列表。	[127608589417****]
PlaybookList	array<object>	能够处置该实体的剧本列表。	[{"name":"云安全中心-云服务器安全","code":"1"}]
	object
OpCode	string	剧本 opcode，与处置实体的推荐剧本 opcode 相对应。	7
OpLevel	string	事件一键处置是否默认勾选。取值： 2：勾选 1：只展示不勾选	2
Description	string	剧本描述。	WafBlockIP
DisplayName	string	剧本显示名称。	WafBlockIP
TaskConfig	string	opcode 配置。	{"opCode":"3"}
Name	string	剧本名称，剧本唯一标识。	kill_process_isolate_file
Uuid	string	剧本 uuid，剧本唯一标识。	kill_process_isolate_file
ParamConfig	array	剧本的参数列表以及对应参数属性
	any	当前剧本的入参列表以及入参格式要求。	{ "ParamConfig": [ { "Field": "dispose", "Necessary": true, "CheckField": "[{"fieldPath":"$.ip","fieldName":"ip"}]" }, { "Field": "alert", "Necessary": true, "CheckField": "[{"fieldPath":"$.host_uuid","fieldName":"host_uuid"}]" }, { "Field": "scope", "Necessary": true, "Value": "$.main_user_id" }, { "Field": "startTime", "Necessary": true }, { "Field": "endTime", "Necessary": true } ] }
WafPlaybook	boolean	是否是 waf 剧本。取值： true：是 false：不是	false
Available	string	是否可用。 1：可用 0：不可用	1
AlertNum	integer	该实体关联的告警数。	1

示例

正常返回示例

JSON格式

{
  "Success": true,
  "Code": 200,
  "Message": "success",
  "RequestId": "9AAA9ED9-78F4-5021-86DC-D51C7511****",
  "Data": {
    "PageInfo": {
      "CurrentPage": 1,
      "PageSize": 10,
      "TotalCount": 100
    },
    "ResponseData": [
      {
        "EntityId": 0,
        "EntityType": "ip",
        "OpcodeMap": {
          "key": "{\"7\",\"2\"}"
        },
        "OpcodeSet": [
          "7"
        ],
        "EntityInfo": {
          "file_path": "c:/www/leixi.jsp",
          "file_hash": "aa0ca926ad948cd820e0a3d9a18c****",
          "host_uuid": "efed2cf7-0b77-45d9-a97b-d2cf246b****",
          "malware_type": "${aliyun.siem.sas.alert_tag.webshell}",
          "host_name": "launch-advisor-2023****"
        },
        "Dispose": "192.168.*.*",
        "Scope": [
          "[127608589417****]"
        ],
        "PlaybookList": [
          {
            "OpCode": "7",
            "OpLevel": "2",
            "Description": "WafBlockIP",
            "DisplayName": "WafBlockIP",
            "TaskConfig": "{\"opCode\":\"3\"}",
            "Name": "kill_process_isolate_file",
            "Uuid": "kill_process_isolate_file",
            "ParamConfig": [
              "{\n\t\"ParamConfig\": [\n\t\t{\n\t\t\t\"Field\": \"dispose\",\n\t\t\t\"Necessary\": true,\n\t\t\t\"CheckField\": \"[{"fieldPath":"$.ip","fieldName":"ip"}]\"\n\t\t},\n\t\t{\n\t\t\t\"Field\": \"alert\",\n\t\t\t\"Necessary\": true,\n\t\t\t\"CheckField\": \"[{"fieldPath":"$.host_uuid","fieldName":"host_uuid"}]\"\n\t\t},\n\t\t{\n\t\t\t\"Field\": \"scope\",\n\t\t\t\"Necessary\": true,\n\t\t\t\"Value\": \"$.main_user_id\"\n\t\t},\n\t\t{\n\t\t\t\"Field\": \"startTime\",\n\t\t\t\"Necessary\": true\n\t\t},\n\t\t{\n\t\t\t\"Field\": \"endTime\",\n\t\t\t\"Necessary\": true\n\t\t}\n\t]\n}"
            ],
            "WafPlaybook": false,
            "Available": "1"
          }
        ],
        "AlertNum": 1
      }
    ]
  }
}

错误码

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

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

变更历史

更多信息，参考变更详情。