华为云用户手册

URI GET /v1/{project_id}/workspaces 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id 表2 Query参数 参数 是否必选 参数类型 描述 offset 是 Number 偏移量 指定返回记录的开始位置，必须为数字，取值范围为大于或等于0， limit 是 Number 每页显示个数 region_id 否 String 区域id name 否 String 名称查询 description 否 String 描述查询 view_bind_id 否 String 视图绑定的空间id view_bind_name 否 String 视图绑定的空间名称 create_time_start 否 String 创建时间开始，例如2024-04-26T16:08:09Z+0800 create_time_end 否 String 创建时间结束，例如2024-04-2T16:08:09Z+0800 is_view 否 Boolean 是否查询视图 true or false ids 否 String 工作空间id数组，英文逗号分隔 normal_project_id 否 String 普通项目的项目id enterprise_project_id 否 String 企业项目的项目id

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 workspaces Array of CreateWorkspaceResponseBody objects 空间信息 count Number 数据总量 表5 CreateWorkspaceResponseBody 参数 参数类型 描述 id String 工作空间id create_time String 创建时间 update_time String 更新时间 name String 工作空间名称 description String 工作空间描述 creator_id String 创建人id creator_name String 创建人名称 modifier_id String 修改人id modifier_name String 修改人名称 project_id String 所属项目id project_name String 所属项目名称 domain_id String 所属租户id domain_name String 所属租户名称 enterprise_project_id String 企业项目id enterprise_project_name String 企业项目名称 is_view Boolean 是否是视图 region_id String 区域id view_bind_id String 视图绑定的空间id view_bind_name String 视图绑定的空间名称 workspace_agency_list Array of workspace_agency_list objects 仅用于视图场景，列出了该视图纳管的空间列表 表6 workspace_agency_list 参数 参数类型 描述 project_id String 委托空间所属项目id id String 空间委托id name String 空间委托名称 region_id String 委托空间所属region id workspace_attribution String THIS_ACCOUNT:本账号空间,CROSS_ACCOUNT:跨账号空间 agency_version String 用户创建托管空间时使用的 IAM 委托版本，V3或者V5 domain_id String 委托租户id domain_name String 委托租户名称 iam_agency_id String iam委托id iam_agency_name String iam委托名称 resource_spec_code Array of strings 委托空间购买版本 selected Boolean 是否被视图选中 状态码： 400 表7 响应Body参数 参数 参数类型 描述 code String 错误码 message String 错误消息 状态码： 500 表8 响应Body参数 参数 参数类型 描述 code String 错误码 message String 错误消息

请求方法 HTTP请求方法（也称为操作或动词），它告诉服务你正在请求什么类型的操作。 GET：请求服务器返回指定资源。 PUT：请求服务器更新指定资源。 POST：请求服务器新增资源或执行特殊操作。 DELETE：请求服务器删除指定资源，如删除对象等。 HEAD：请求服务器资源头部。 PATCH：请求服务器更新资源的部分内容。当资源不存在的时候，PATCH可能会去创建一个新的资源。 在获取用户Token的URI部分，您可以看到其请求方法为“POST”，则其请求为： POST https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens

请求消息头 附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。 如下公共消息头需要添加到请求中。 Content-Type：消息体的类型（格式），必选，默认取值为“application/json”，有其他取值时会在具体接口中专门说明。 X-Auth-Token：用户Token，可选，当使用Token方式认证时，必须填充该字段。用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 API同时支持使用AK/SK认证，AK/SK认证是使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。 AK/SK认证的详细说明请参见AK/SK认证。 对于获取用户Token接口，由于不需要认证，所以只添加“Content-Type”即可，添加消息头后的请求如下所示。 POST https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokensContent-Type: application/json

请求URI 请求URI由如下部分组成。 {URI-scheme} :// {Endpoint} / {resource-path} ? {query-string} 尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。 URI-scheme： 表示用于传输请求的协议，当前所有API均采用HTTPS协议。 Endpoint： 指定承载REST服务端点的服务器 域名 或IP，不同服务不同区域的Endpoint不同，您可以从地区和终端节点获取。 例如IAM服务在“华北-北京四”区域的Endpoint为“iam.cn-north-4.myhuaweicloud.com”。 resource-path： 资源路径，也即API访问路径。从具体API的URI模块获取，例如“获取用户Token”API的resource-path为“/v3/auth/tokens”。 query-string： 查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“？”，形式为“参数名=参数取值”，例如“limit=10”，表示查询不超过10条数据。 例如您需要获取IAM在“华北-北京四”区域的Token，则需使用“华北-北京四”区域的Endpoint（iam.cn-north-4.myhuaweicloud.com），并在获取用户Token的URI部分找到resource-path（/v3/auth/tokens），拼接起来如下所示。 https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens 图1 URI示意图 为查看方便，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，同一个服务的Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

请求消息体 请求消息体通常以结构化格式发出，与请求消息头中Content-type对应，传递除请求消息头之外的内容。若请求消息体中参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于获取用户Token接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中username为用户名，domainname为用户所属的账号名称，********为用户登录密码，xxxxxxxxxxxxxxxxxx为project的名称，如“cn-north-4”，您可以从地区和终端节点获取，对应地区和终端节点页面的“区域”字段的值。 scope参数定义了Token的作用域，下面示例中获取的Token仅能访问project下的资源。您还可以设置Token作用域为某个账号下所有资源或账号的某个project下的资源，详细定义请参见获取用户Token。 POST https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokensContent-Type: application/json{ "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxxxxxxxxxxxx" } } }} 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口，返回的响应消息头中“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

请求示例 更新一个剧本版本，剧本版本所属工作空间ID为string，剧本ID为909494e3-558e-46b6-a9eb-07a8e18ca62f，数据类ID为909494e3-558e-46b6-a9eb-07a8e18ca62f，剧本状态为已启用。 { "description" : "This my XXXX", "workspace_id" : "string", "playbook_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "dataclass_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "rule_enable" : true, "enabled" : true, "status" : "UNPASSED", "rule_id" : "4185bbd2-9d18-4362-92cb-46df0b24fe4e", "trigger_type" : "event", "dataobject_create" : true, "dataobject_update" : true, "dataobject_delete" : true, "action_strategy" : "sync"}

响应示例 状态码： 200 请求成功响应信息 { "code" : 0, "message" : "Error message", "data" : { "id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "description" : "This my XXXX", "create_time" : "2021-01-30T23:00:00Z+0800", "update_time" : "2021-01-30T23:00:00Z+0800", "project_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "creator_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "modifier_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "playbook_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "version" : "v1.1.1", "enabled" : true, "status" : "editing", "action_strategy" : "sync", "actions" : [ { "id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "name" : "MyXXX", "description" : "This my XXXX", "action_type" : "Workflow", "action_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "playbook_id" : "string", "playbook_version_id" : "string", "project_id" : "string" } ], "rule_enable" : true, "rules" : { "id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "project_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "rule" : "909494e3-558e-46b6-a9eb-07a8e18ca62f" }, "dataclass_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "trigger_type" : "event", "dataobject_create" : true, "dataobject_update" : true, "dataobject_delete" : true, "version_type" : 1, "rule_id" : "string", "dataclass_name" : "string", "approve_name" : "string" }}

响应参数 状态码： 200 表4 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID,格式为：request_uuid-timestamp-hostname 表5 响应Body参数 参数 参数类型 描述 code String 错误码 message String Error message data PlaybookVersionInfo object 剧本版本详情信息 表6 PlaybookVersionInfo 参数 参数类型 描述 id String 剧本版本ID description String 描述 create_time String 创建时间 update_time String 更新时间 project_id String 项目ID creator_id String 创建者ID modifier_id String 修改者ID playbook_id String 剧本ID version String 版本号 enabled Boolean 是否启用。（true--已启用，false-未启用） status String 剧本版本状态，编辑中：EDITING 审核中：APPROVING 不通过：UNPASSED 已发布：PUBLISHED action_strategy String 执行策略. 目前仅支持异步并发执行，对应值为ASYNC actions Array of ActionInfo objects 剧本关联流程列表信息 rule_enable Boolean 是否启用触发条件过滤器 rules RuleInfo object 剧本触发规格信息 dataclass_id String 数据类ID trigger_type String 剧本触发方式(EVENT--事件触发，TIMER--定时触发) dataobject_create Boolean 标识数据对象是否创建时触发剧本 dataobject_update Boolean 标识数据对象是否更新时触发剧本 dataobject_delete Boolean 标识数据对象是否删除时触发剧本 version_type Integer 版本类型（0--草稿版本，1--正式版本) rule_id String 过滤规则ID dataclass_name String 数据类名称 approve_name String 审核者 表7 ActionInfo 参数 参数类型 描述 id String 剧本流程动作ID name String 流程动作名称 description String 描述 action_type String 流程动作类型 action_id String 流程ID playbook_id String 剧本ID playbook_version_id String 剧本版本ID project_id String 项目ID 表8 RuleInfo 参数 参数类型 描述 id String 规则ID project_id String 项目ID rule String 触发规则 状态码： 400 表9 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID,格式为：request_uuid-timestamp-hostname 表10 响应Body参数 参数 参数类型 描述 code String 错误码 message String 错误描述

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 content-type 是 String application/json;charset=UTF-8 表3 请求Body参数 参数 是否必选 参数类型 描述 description 否 String 描述 workspace_id 否 String 工作空间ID playbook_id 否 String 剧本ID dataclass_id 否 String 数据类ID rule_enable 否 Boolean 是否启用触发条件过滤器 enabled 否 Boolean 是否激活。(false:未激活, true:已激活) status 否 String 状态(APPROVING:审核中，EDITING-编辑中，UNPASSED-审核未通过，PUBLISHED-已发布) rule_id 否 String 规则ID trigger_type 否 String 触发方式. EVENT--事件触发, TIMER--定时触发 dataobject_create 否 Boolean 数据对象是否创建时触发剧本 dataobject_update 否 Boolean 数据对象是否更新时触发剧本 dataobject_delete 否 Boolean 数据对象是否删除时触发剧本 action_strategy 否 String 执行策略. 目前仅支持异步并发执行，对应值为ASYNC

调用API获取项目ID 项目ID可以通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects”，其中{Endpoint}为IAM的终端节点，可以从地区和终端节点获取。接口的认证鉴权请参见认证鉴权。 响应示例如下，其中projects下的“id”即为项目ID。 { "projects": [ { "domain_id": "65382450e8f64ac0870cd180d14e684b", "is_domain": false, "parent_id": "65382450e8f64ac0870cd180d14e684b", "name": "xxxxxxxx", "description": "", "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99" }, "id": "a4a5d4098fb4474fa22cd05f897d6b99", "enabled": true } ], "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects" }}

请求示例 更新一条告警规则，告警规则名称为Alert rule，查询类型为SQL，状态为启用，严重程度为提示。 { "rule_name" : "Alert rule", "query" : "* | select status, count(*) as count group by status", "query_type" : "SQL", "status" : "ENABLED", "severity" : "TIPS", "custom_properties" : { "references" : "https://localhost/references", "maintainer" : "isap" }, "event_grouping" : true, "schedule" : { "frequency_interval" : 5, "frequency_unit" : "MINUTE", "period_interval" : 5, "period_unit" : "MINUTE", "delay_interval" : 2, "overtime_interval" : 10 }, "triggers" : [ { "mode" : "COUNT", "operator" : "GT", "expression" : 10, "severity" : "TIPS" } ]}

响应示例 状态码： 200 请求成功 { "rule_id" : "443a0117-1aa4-4595-ad4a-796fad4d4950", "pipe_id" : "772fb35b-83bc-46c9-a0b1-ebe31070a889", "create_by" : "582dd19dd99d4505a1d7929dc943b169", "create_time" : 1665221214, "update_by" : "582dd19dd99d4505a1d7929dc943b169", "update_time" : 1665221214, "delete_time" : 0, "rule_name" : "Alert rule", "query" : "* | select status, count(*) as count group by status", "query_type" : "SQL", "status" : "ENABLED", "severity" : "TIPS", "custom_properties" : { "references" : "https://localhost/references", "maintainer" : "isap" }, "event_grouping" : true, "schedule" : { "frequency_interval" : 5, "frequency_unit" : "MINUTE", "period_interval" : 5, "period_unit" : "MINUTE", "delay_interval" : 2, "overtime_interval" : 10 }, "triggers" : [ { "mode" : "COUNT", "operator" : "GT", "expression" : 10, "severity" : "TIPS" } ]}

URI PUT /v1/{project_id}/workspaces/{workspace_id}/siem/alert-rules/{rule_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目 ID。Project ID. workspace_id 是 String 工作空间 ID。Workspace ID. rule_id 是 String 告警规则 ID。Alert rule ID.

响应示例 状态码： 200 获取事件详情返回body体 { "code" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "message" : "Error message", "data" : { "data_object" : { "version" : "1.0", "environment" : { "vendor_type" : "MyXXX", "domain_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "region_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "project_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f" }, "data_source" : { "source_type" : 3, "domain_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "project_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "region_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f" }, "first_observed_time" : "2021-01-30T23:00:00Z+0800", "last_observed_time" : "2021-01-30T23:00:00Z+0800", "create_time" : "2021-01-30T23:00:00Z+0800", "arrive_time" : "2021-01-30T23:00:00Z+0800", "title" : "MyXXX", "description" : "This my XXXX", "source_url" : "http://xxx", "count" : "4", "confidence" : 4, "severity" : "TIPS", "criticality" : 4, "incident_type" : { }, "network_list" : [ { "direction" : { "IN" : null }, "protocol" : "TCP", "src_ip" : "192.168.0.1", "src_port" : "1", "src_domain" : "xxx", "dest_ip" : "192.168.0.1", "dest_port" : "1", "dest_domain" : "xxx", "src_geo" : { "latitude" : 90, "longitude" : 180 }, "dest_geo" : { "latitude" : 90, "longitude" : 180 } } ], "resource_list" : [ { "id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "name" : "MyXXX", "type" : "MyXXX", "domain_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "project_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "region_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "ep_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "ep_name" : "MyXXX", "tags" : "909494e3-558e-46b6-a9eb-07a8e18ca62f" } ], "remediation" : { "recommendation" : "MyXXX", "url" : "MyXXX" }, "verification_state" : "Unknown – 未知，True_Positive – 确认，False_Positive – 误报。默认填写Unknown", "handle_status" : "Open – 打开，Block – 阻塞，Closed – 关闭。默认填写Open", "sla" : 60000, "update_time" : "2021-01-30T23:00:00Z+0800", "close_time" : "2021-01-30T23:00:00Z+0800", "ipdrr_phase" : "Prepartion|Detection and Analysis|Containm，Eradication& Recovery| Post-Incident-Activity", "simulation" : "false", "actor" : "刘一博", "owner" : "MyXXX", "creator" : "MyXXX", "close_reason" : "误检;已解决;重复;其他", "close_comment" : "误检;已解决;重复;其他", "malware" : { "malware_family" : "family", "malware_class" : "恶意占用内存" }, "system_info" : { }, "process" : [ { "process_name" : "MyXXX", "process_path" : "MyXXX", "process_pid" : 123, "process_uid" : 123, "process_cmdline" : "MyXXX" } ], "user_info" : [ { "user_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "user_name" : "MyXXX" } ], "file_info" : [ { "file_path" : "MyXXX", "file_content" : "MyXXX", "file_new_path" : "MyXXX", "file_hash" : "MyXXX", "file_md5" : "MyXXX", "file_sha256" : "MyXXX", "file_attr" : "MyXXX" } ], "id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "workspace_id" : "909494e3-558e-46b6-a9eb-07a8e18ca620" }, "create_time" : "2021-01-30T23:00:00Z+0800", "update_time" : "2021-01-30T23:00:00Z+0800", "project_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "workspace_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f" }}

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 code String 错误码 message String 错误信息 data IncidentDetail object 事件详情对象 表4 IncidentDetail 参数 参数类型 描述 create_time String 记录时间，格式ISO8601：YYYY-MM-DDTHH:mm:ss.ms+timezone。时区信息为事件发生时区，无法解析时区的时间，默认时区填东八区 data_object Incident object 事件实体信息 dataclass_ref dataclass_ref object 数据类对象 format_version Integer 格式版本 id String 事件唯一标识，UUID格式，最大36个字符 project_id String 当前项目的id update_time String 更新时间，格式ISO8601：YYYY-MM-DDTHH:mm:ss.ms+timezone。时区信息为告警发生时区，无法解析时区的时间，默认时区填东八区 version Integer 版本 workspace_id String 当前的工作空间id 表5 Incident 参数 参数类型 描述 version String 事件对象的版本，该字段的值必须为云SSA服务确定的官方发布版本之一 id String 事件唯一标识，UUID格式，最大36个字符 domain_id String 数据投递后，被委托用户的domain_id region_id String 数据投递后，被委托用户的region_id workspace_id String 当前的工作空间id labels String 标签，仅展示 environment environment object 事件产生的环境坐标信息 data_source data_source object 首次上报数据源 first_observed_time String 首次发现时间，格式ISO8601：YYYY-MM-DDTHH:mm:ss.ms+timezone。时区信息为事件发生时区，无法解析时区的时间，默认时区填东八区 last_observed_time String 最近发现时间，格式ISO8601：YYYY-MM-DDTHH:mm:ss.ms+timezone。时区信息为事件发生时区，无法解析时区的时间，默认时区填东八区 create_time String 记录时间，格式ISO8601：YYYY-MM-DDTHH:mm:ss.ms+timezone。时区信息为事件发生时区，无法解析时区的时间，默认时区填东八区 arrive_time String 接收时间，格式ISO8601：YYYY-MM-DDTHH:mm:ss.ms+timezone。时区信息为事件发生时区，无法解析时区的时间，默认时区填东八区 title String 事件标题 description String 事件描述信息 source_url String 事件URL链接，指向数据源产品中有关当前事件说明的页面 count Integer 事件发生次数 confidence Integer 事件的置信度。置信度的定义旨在说明识别的行为或问题的可能性。 取值范围：0-100，0表示置信度为0%，100表示置信度为100% severity String 严重性等级，取值范围：Tips | Low | Medium | High | Fatal 说明： 0: Tips – 未发现任何问题。 1: Low – 无需针对问题执行任何操作。 2: Medium – 问题需要处理，但不紧急。 3: High – 问题必须优先处理。 4: Fatal – 问题必须立即处理，以防止产生进一步的损害 criticality Integer 关键性，是指事件涉及的资源的重要性级别。 取值范围：0-100，0表示资源不关键，100表示最关键资源 incident_type incident_type object 事件分类，详细定义参考《告警事件类型定义》 network_list Array of network_list objects 网络信息 resource_list Array of resource_list objects 受影响资源 remediation remediation object 补救措施 verification_state String 验证状态，标识事件的准确性。可选类型如下： Unknown – 未知 True_Positive – 确认 False_Positive – 误报 默认填写Unknown handle_status String 事件处理状态，可选类型如下： Open – 打开，默认 Block – 阻塞 Closed – 关闭 默认填写Open sla Integer 约束闭环时间：设置风险接受持续时间。单位：小时 update_time String 更新时间，格式ISO8601：YYYY-MM-DDTHH:mm:ss.ms+timezone。时区信息为事件发生时区，无法解析时区的时间，默认时区填东八区 close_time String 关闭时间，格式ISO8601：YYYY-MM-DDTHH:mm:ss.ms+timezone。时区信息为事件发生时区，无法解析时区的时间，默认时区填东八区 ipdrr_phase String 周期/处置阶段编号 Prepartion|Detection and Analysis|Containm，Eradication& Recovery|Post-Incident-Activity simulation String 调试字段 actor String 事件调查员 owner String 责任人、服务责任人 creator String 创建人 close_reason String 关闭原因: 误检 - False detection 已解决 - Resolved 重复 - Repeated 其他 - Other close_comment String 关闭评论 malware malware object 恶意软件 system_info Object 系统信息 process Array of process objects 进程信息 user_info Array of user_info objects 用户信息 file_info Array of file_info objects 文件信息 system_alert_table Object 事件管理列表的布局字段 表6 environment 参数 参数类型 描述 vendor_type String 环境供应商 domain_id String 租户id region_id String 区域id，全局服务global cross_workspace_id String 数据投递前的源工作空间id，在源空间下值为null，投递后为被委托用户的id project_id String 项目id， 全局服务默认null 表7 data_source 参数 参数类型 描述 source_type Integer 数据源类型，取值范围如下： 1 - 云上产品 2 - 第三方产品 3 - 租户私有产品 domain_id String 数据源产品所属账号的id project_id String 数据源产品所属项目的id region_id String 数据源产品所在区域，具体取值范围查看云地区和终端节点定义，例如cn-north-1 company_name String 数据源产品所属公司的名称 product_name String 数据源产品的名称 product_feature String 产品功能特性名称，用来指明检测到当前事件的产品的功能特性 product_module String 检测模块列表 表8 incident_type 参数 参数类型 描述 category String 类别 incident_type String 事件类型 表9 network_list 参数 参数类型 描述 direction String 方向，取值范围：IN | OUT protocol String 协议，包含7层和4层的协议 参考：IANA registered name https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml src_ip String 源IP地址 src_port Integer 源端口，0–65535 src_domain String 源域名 src_geo src_geo object 源IP的地理位置信息 dest_ip String 目的IP地址 dest_port String 目的端口，0–65535 dest_domain String 目的域名 dest_geo dest_geo object 目标IP的地理位置信息 表10 src_geo 参数 参数类型 描述 latitude Number 纬度 longitude Number 经度 city_code String 城市编码，Beijing | Shanghai country_code String 国家简码，参考ISO 3166-1 alpha-2，例如：CN | US | DE | IT | SG 表11 dest_geo 参数 参数类型 描述 latitude Number 纬度 longitude Number 经度 city_code String 城市编码，Beijing | Shanghai country_code String 国家简码，参考ISO 3166-1 alpha-2，例如：CN | US | DE | IT | SG 表12 resource_list 参数 参数类型 描述 id String 云服务资源id name String 资源名称 type String 资源类型；引用云 RMS type字段 provider String 云服务名称；引用云RMS provider字段 region_id String 区域；按照云regionId填写，如cn-north-1等 domain_id String 资源所属账号ID，UUID格式 project_id String 资源所属项目ID，UUID格式 ep_id String 企业项目id ep_name String 企业项目名称 tags String 资源标签 1、最多50个key/values对 2、values：最大255字符，取值范围：字母数字,空格,+, -, =, ., _, :, /,@ 表13 remediation 参数 参数类型 描述 recommendation String 推荐处理方法 url String 链接，指向该事件的一般修复信息。该URL必须可以从公网访问，不需要提供凭证 表14 malware 参数 参数类型 描述 malware_family String 恶意家族 malware_class String 恶意软件分类 表15 process 参数 参数类型 描述 process_name String 进程名 process_path String 进程执行文件路径 process_pid Integer 进程id process_uid Integer 进程用户id process_cmdline String 进程命令行 process_parent_name String 父进程名称 process_parent_path String 父进程执行文件路径 process_parent_pid Integer 父进程id process_parent_uid Integer 父进程用户id process_parent_cmdline String 父进程命令行 process_child_name String 子进程名称 process_child_path String 子进程执行文件路径 process_child_pid Integer 子进程id process_child_uid Integer 子进程用户id process_child_cmdline String 子进程命令行 process_launche_time String 进程启动时间，格式ISO8601：YYYY-MM-DDTHH:mm:ss.ms+timezone。时区信息为事件发生时区，无法解析时区的时间，默认时区填东八区 process_terminate_time String 进程结束时间，格式ISO8601：YYYY-MM-DDTHH:mm:ss.ms+timezone。时区信息为事件发生时区，无法解析时区的时间，默认时区填东八区 表16 user_info 参数 参数类型 描述 user_id String 用户uid user_name String 用户名称 表17 file_info 参数 参数类型 描述 file_path String 文件路径/名称 file_content String 文件内容 file_new_path String 文件新路径/名称 file_hash String 文件hash file_md5 String 文件md5 file_sha256 String 文件sha256 file_attr String 文件属性 表18 dataclass_ref 参数 参数类型 描述 id String 数据类唯一标识，UUID格式，最大36个字符 name String 数据类名称 状态码： 400 表19 响应Body参数 参数 参数类型 描述 code String 错误码 message String 错误描述

响应参数 状态码： 200 表5 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID,格式为：request_uuid-timestamp-hostname 表6 响应Body参数 参数 参数类型 描述 count Integer 总条数 audit_logs Array of AuditLogInfo objects 审计日志列表信息 表7 AuditLogInfo 参数 参数类型 描述 instance_type String 实例类型（AOP_WORKFLOW--流程, SCRIPT--脚本, PLAYBOOK--剧本） action_id String 流程ID action_name String 流程名称 instance_id String 实例ID parent_instance_id String 父节点实例ID log_level String 日志级别 input String 输入 output String 输出 error_msg String 错误信息 start_time String 开始时间 end_time String 结束时间 status String 状态。(RUNNING--运行中、FINISHED--成功、FAILED--失败、RETRYING--重试中、TERMINATING--终止中、TERMINATED--已终止) trigger_type String 触发类型. TIMER--定时触发, EVENT--事件触发 状态码： 400 表8 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID,格式为：request_uuid-timestamp-hostname 表9 响应Body参数 参数 参数类型 描述 code String 错误码 message String 错误描述

响应示例 状态码： 200 请求成功响应信息 { "count" : 41, "audit_logs" : [ { "instance_type" : "APP, AOP_WORKFLOW, SCRIPT, PLAYBOOK, TASK, DEBUG", "action_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "action_name" : "DisabledIp", "instance_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "parent_instance_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "log_level" : "DEBUG INFO WARN", "input" : "input", "output" : "output", "error_msg" : "error_msg", "start_time" : "2021-01-30T23:00:00Z", "end_time" : "2021-01-31T23:00:00Z", "status" : "CREATED, RUNNING, FINISHED, RETRYING, TERMINATING, TERMINATED, FAILED", "trigger_type" : "DEBUG, TIMER, EVENT, MANUAL" } ]}

请求示例 查询实例类型为APP, AOP_WORKFLOW, SCRIPT, PLAYBOOK, TASK, DEBUG，动作id为909494e3-558e-46b6-a9eb-07a8e18ca62f，动作名称为DisabledIp，实例id为909494e3-558e-46b6-a9eb-07a8e18ca62f，父实例id为909494e3-558e-46b6-a9eb-07a8e18ca62f，日志等级为DEBUG INFO WARN，输入为input，输出为output，错误信息为error_msg，开始时间2021-01-30 23：00：00，结束时间2021-01-31 23：00：00，状态为CREATED, RUNNING, FINISHED, RETRYING, TERMINATING, TERMINATED, FAILED，触发类型为DEBUG, TIMER, EVENT, MANUAL的剧本实例审计日志 { "instance_type" : "APP, AOP_WORKFLOW, SCRIPT, PLAYBOOK, TASK, DEBUG", "action_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "action_name" : "DisabledIp", "instance_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "parent_instance_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "log_level" : "DEBUG INFO WARN", "input" : "input", "output" : "output", "error_msg" : "error_msg", "start_time" : "2021-01-30T23:00:00Z", "end_time" : "2021-01-31T23:00:00Z", "status" : "CREATED, RUNNING, FINISHED, RETRYING, TERMINATING, TERMINATED, FAILED", "trigger_type" : "DEBUG, TIMER, EVENT, MANUAL"}

URI POST /v1/{project_id}/workspaces/{workspace_id}/soc/playbooks/instances/auditlogs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID workspace_id 是 String 工作空间ID 表2 Query参数 参数 是否必选 参数类型 描述 offset 是 Long offset limit 是 Long limit sort_key 否 String sort_key sort_dir 否 String sort_dir. asc, desc

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 content-type 是 String application/json;charset=UTF-8 表4 请求Body参数 参数 是否必选 参数类型 描述 instance_type 否 String 实例类型（AOP_WORKFLOW--流程, SCRIPT--脚本, PLAYBOOK--剧本） action_id 否 String 流程ID action_name 否 String 流程名称 instance_id 否 String 实例ID parent_instance_id 否 String 父节点实例ID log_level 否 String 日志级别 input 否 String 输入 output 否 String 输出 error_msg 否 String 错误信息 start_time 否 String 开始时间 end_time 否 String 结束时间 status 否 String 状态。(RUNNING--运行中、FINISHED--成功、FAILED--失败、RETRYING--重试中、TERMINATING--终止中、TERMINATED--已终止) trigger_type 否 String 触发类型. TIMER--定时触发, EVENT--事件触发

响应示例 状态码： 200 请求成功 { "total" : 41, "field_details" : [ { "id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "cloud_pack_version" : "订阅包版本", "business_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "business_type" : "业务类型", "dataclass_name" : "业务id", "business_code" : "My Field", "field_key" : "字段key", "name" : "字段名称", "description" : "字段描述", "default_value" : "默认值", "display_type" : "显示类型", "field_type" : "shorttext", "extra_json" : "{}", "field_tooltip" : "工具提示", "iu_type" : "输入输出类型", "used_by" : "使用业务", "json_schema" : "{}", "is_built_in" : false, "case_sensitive" : false, "read_only" : false, "required" : false, "searchable" : false, "visible" : false, "maintainable" : false, "editable" : false, "creatable" : false, "mapping" : true, "target_api" : "目标api", "creator_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "creator_name" : "张三", "modifier_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "modifier_name" : "李四", "create_time" : "2021-01-30T23:00:00Z+0800", "update_time" : "2021-01-30T23:00:00Z+0800" } ]}

响应参数 状态码： 200 表4 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID,格式为：request_uuid-timestamp-hostname 表5 响应Body参数 参数 参数类型 描述 field_details Array of FieldResponseBody objects list of informations of field total Number 数据总量 表6 FieldResponseBody 参数 参数类型 描述 id String Id value cloud_pack_version String 订阅包版本 business_id String 关联业务id business_type String 关联业务 dataclass_name String 数据类名称 business_code String 字段业务编码 field_key String 字段key name String 字段名称 description String 字段描述 default_value String 默认值 display_type String 显示类型 field_type String 字段类型，如shorttext,radio,grid等 extra_json String 附加json field_tooltip String 工具提示 iu_type String 输入输出类型 used_by String 使用业务 json_schema String json模式 is_built_in Boolean 是否内置，true内置，false非内置 case_sensitive Boolean 大小写敏感，true敏感，false不敏感 read_only Boolean 只读模式，true只读，false非只读 required Boolean 是否必填，true必填，false非必填 searchable Boolean 可搜索，true可搜索，false非可搜索 visible Boolean 可见，true可见，false非可见 maintainable Boolean 可维护，true可维护，false非可维护 editable Boolean 可编辑，true可编辑，false非可编辑 creatable Boolean 可创建，true可创建，false非可创建 mapping Boolean 是否展示在分类映射外的其他地方 target_api String 目标api creator_id String Creator id value creator_name String Creator name value modifier_id String Modifier id value modifier_name String Modifier name value create_time String Create time update_time String Update time 状态码： 400 表7 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID,格式为：request_uuid-timestamp-hostname 表8 响应Body参数 参数 参数类型 描述 code String 错误码 message String 错误描述

URI GET /v1/{project_id}/workspaces/{workspace_id}/soc/dataclasses/{dataclass_id}/fields 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id workspace_id 是 String 工作空间id dataclass_id 是 String 数据类id 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量 limit 否 Integer 数据量 name 否 String 名称查询 is_built_in 否 Boolean 是否内置 field_category 否 String 字段分类 mapping 否 Boolean 是否展示在分类映射外的其他地方

请求示例 查询事件列表请求样例，查询2024年1月20号到2024年1月26号，事件等级为中危且处理状态为打开的事件，按照创建时间降序排序，返回第一页，每页10条数据 { "limit" : 10, "offset" : 0, "sort_by" : "create_time", "order" : "DESC", "condition" : { "conditions" : [ { "name" : "severity", "data" : [ "severity", "=", "Medium" ] }, { "name" : "handle_status", "data" : [ "handle_status", "=", "Open" ] } ], "logics" : [ "severity", "and", "handle_status" ] }, "from_date" : "2024-01-20T00:00:00.000Z+0800", "to_date" : "2024-01-26T23:59:59.999Z+0800"}

响应示例 状态码： 200 搜索事件列表返回body体 { "code" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "message" : "Error message", "total" : 41, "limit" : 2, "offset" : 1, "success" : true, "data" : [ { "data_object" : { "version" : "1.0", "environment" : { "vendor_type" : "MyXXX", "domain_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "region_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "project_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f" }, "data_source" : { "source_type" : 3, "domain_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "project_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "region_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f" }, "first_observed_time" : "2021-01-30T23:00:00Z+0800", "last_observed_time" : "2021-01-30T23:00:00Z+0800", "create_time" : "2021-01-30T23:00:00Z+0800", "arrive_time" : "2021-01-30T23:00:00Z+0800", "title" : "MyXXX", "description" : "This my XXXX", "source_url" : "http://xxx", "count" : 4, "confidence" : 4, "severity" : "TIPS", "criticality" : 4, "incident_type" : { }, "network_list" : [ { "direction" : { "IN" : null }, "protocol" : "TCP", "src_ip" : "192.168.0.1", "src_port" : "1", "src_domain" : "xxx", "dest_ip" : "192.168.0.1", "dest_port" : "1", "dest_domain" : "xxx", "src_geo" : { "latitude" : 90, "longitude" : 180 }, "dest_geo" : { "latitude" : 90, "longitude" : 180 } } ], "resource_list" : [ { "id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "name" : "MyXXX", "type" : "MyXXX", "domain_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "project_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "region_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "ep_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "ep_name" : "MyXXX", "tags" : "909494e3-558e-46b6-a9eb-07a8e18ca62f" } ], "remediation" : { "recommendation" : "MyXXX", "url" : "MyXXX" }, "verification_state" : "Unknown – 未知，True_Positive – 确认，False_Positive – 误报。默认填写Unknown", "handle_status" : "Open – 打开，Block – 阻塞，Closed – 关闭。默认填写Open", "sla" : 60000, "update_time" : "2021-01-30T23:00:00Z+0800", "close_time" : "2021-01-30T23:00:00Z+0800", "ipdrr_phase" : "Prepartion|Detection and Analysis|Containm，Eradication& Recovery| Post-Incident-Activity", "simulation" : "false", "actor" : "刘一博", "owner" : "MyXXX", "creator" : "MyXXX", "close_reason" : "误检;已解决;重复;其他", "close_comment" : "误检;已解决;重复;其他", "malware" : { "malware_family" : "family", "malware_class" : "恶意占用内存" }, "system_info" : { }, "process" : [ { "process_name" : "MyXXX", "process_path" : "MyXXX", "process_pid" : 123, "process_uid" : 123, "process_cmdline" : "MyXXX" } ], "user_info" : [ { "user_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "user_name" : "MyXXX" } ], "file_info" : [ { "file_path" : "MyXXX", "file_content" : "MyXXX", "file_new_path" : "MyXXX", "file_hash" : "MyXXX", "file_md5" : "MyXXX", "file_sha256" : "MyXXX", "file_attr" : "MyXXX" } ], "id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "workspace_id" : "909494e3-558e-46b6-a9eb-07a8e18ca620" }, "create_time" : "2021-01-30T23:00:00Z+0800", "update_time" : "2021-01-30T23:00:00Z+0800", "project_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "workspace_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f" } ]}

响应参数 状态码： 200 表6 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID,格式为：request_uuid-timestamp-hostname 表7 响应Body参数 参数 参数类型 描述 code String 错误码 message String 错误信息 total Integer 事件总数 limit Integer 分页大小 offset Integer 偏移量 success Boolean 是否成功 data Array of IncidentDetail objects 事件列表 表8 IncidentDetail 参数 参数类型 描述 create_time String 记录时间，格式ISO8601：YYYY-MM-DDTHH:mm:ss.ms+timezone。时区信息为事件发生时区，无法解析时区的时间，默认时区填东八区 data_object Incident object 事件实体信息 dataclass_ref dataclass_ref object 数据类对象 format_version Integer 格式版本 id String 事件唯一标识，UUID格式，最大36个字符 project_id String 当前项目的id update_time String 更新时间，格式ISO8601：YYYY-MM-DDTHH:mm:ss.ms+timezone。时区信息为告警发生时区，无法解析时区的时间，默认时区填东八区 version Integer 版本 workspace_id String 当前的工作空间id 表9 Incident 参数 参数类型 描述 version String 事件对象的版本，该字段的值必须为云SSA服务确定的官方发布版本之一 id String 事件唯一标识，UUID格式，最大36个字符 domain_id String 数据投递后，被委托用户的domain_id region_id String 数据投递后，被委托用户的region_id workspace_id String 当前的工作空间id labels String 标签，仅展示 environment environment object 事件产生的环境坐标信息 data_source data_source object 首次上报数据源 first_observed_time String 首次发现时间，格式ISO8601：YYYY-MM-DDTHH:mm:ss.ms+timezone。时区信息为事件发生时区，无法解析时区的时间，默认时区填东八区 last_observed_time String 最近发现时间，格式ISO8601：YYYY-MM-DDTHH:mm:ss.ms+timezone。时区信息为事件发生时区，无法解析时区的时间，默认时区填东八区 create_time String 记录时间，格式ISO8601：YYYY-MM-DDTHH:mm:ss.ms+timezone。时区信息为事件发生时区，无法解析时区的时间，默认时区填东八区 arrive_time String 接收时间，格式ISO8601：YYYY-MM-DDTHH:mm:ss.ms+timezone。时区信息为事件发生时区，无法解析时区的时间，默认时区填东八区 title String 事件标题 description String 事件描述信息 source_url String 事件URL链接，指向数据源产品中有关当前事件说明的页面 count Integer 事件发生次数 confidence Integer 事件的置信度。置信度的定义旨在说明识别的行为或问题的可能性。 取值范围：0-100，0表示置信度为0%，100表示置信度为100% severity String 严重性等级，取值范围：Tips | Low | Medium | High | Fatal 说明： 0: Tips – 未发现任何问题。 1: Low – 无需针对问题执行任何操作。 2: Medium – 问题需要处理，但不紧急。 3: High – 问题必须优先处理。 4: Fatal – 问题必须立即处理，以防止产生进一步的损害 criticality Integer 关键性，是指事件涉及的资源的重要性级别。 取值范围：0-100，0表示资源不关键，100表示最关键资源 incident_type incident_type object 事件分类，详细定义参考《告警事件类型定义》 network_list Array of network_list objects 网络信息 resource_list Array of resource_list objects 受影响资源 remediation remediation object 补救措施 verification_state String 验证状态，标识事件的准确性。可选类型如下： Unknown – 未知 True_Positive – 确认 False_Positive – 误报 默认填写Unknown handle_status String 事件处理状态，可选类型如下： Open – 打开，默认 Block – 阻塞 Closed – 关闭 默认填写Open sla Integer 约束闭环时间：设置风险接受持续时间。单位：小时 update_time String 更新时间，格式ISO8601：YYYY-MM-DDTHH:mm:ss.ms+timezone。时区信息为事件发生时区，无法解析时区的时间，默认时区填东八区 close_time String 关闭时间，格式ISO8601：YYYY-MM-DDTHH:mm:ss.ms+timezone。时区信息为事件发生时区，无法解析时区的时间，默认时区填东八区 ipdrr_phase String 周期/处置阶段编号 Prepartion|Detection and Analysis|Containm，Eradication& Recovery|Post-Incident-Activity simulation String 调试字段 actor String 事件调查员 owner String 责任人、服务责任人 creator String 创建人 close_reason String 关闭原因: 误检 - False detection 已解决 - Resolved 重复 - Repeated 其他 - Other close_comment String 关闭评论 malware malware object 恶意软件 system_info Object 系统信息 process Array of process objects 进程信息 user_info Array of user_info objects 用户信息 file_info Array of file_info objects 文件信息 system_alert_table Object 事件管理列表的布局字段 表10 environment 参数 参数类型 描述 vendor_type String 环境供应商 domain_id String 租户id region_id String 区域id，全局服务global cross_workspace_id String 数据投递前的源工作空间id，在源空间下值为null，投递后为被委托用户的id project_id String 项目id， 全局服务默认null 表11 data_source 参数 参数类型 描述 source_type Integer 数据源类型，取值范围如下： 1 - 云上产品 2 - 第三方产品 3 - 租户私有产品 domain_id String 数据源产品所属账号的id project_id String 数据源产品所属项目的id region_id String 数据源产品所在区域，具体取值范围查看云地区和终端节点定义，例如cn-north-1 company_name String 数据源产品所属公司的名称 product_name String 数据源产品的名称 product_feature String 产品功能特性名称，用来指明检测到当前事件的产品的功能特性 product_module String 检测模块列表 表12 incident_type 参数 参数类型 描述 category String 类别 incident_type String 事件类型 表13 network_list 参数 参数类型 描述 direction String 方向，取值范围：IN | OUT protocol String 协议，包含7层和4层的协议 参考：IANA registered name https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml src_ip String 源IP地址 src_port Integer 源端口，0–65535 src_domain String 源域名 src_geo src_geo object 源IP的地理位置信息 dest_ip String 目的IP地址 dest_port String 目的端口，0–65535 dest_domain String 目的域名 dest_geo dest_geo object 目标IP的地理位置信息 表14 src_geo 参数 参数类型 描述 latitude Number 纬度 longitude Number 经度 city_code String 城市编码，Beijing | Shanghai country_code String 国家简码，参考ISO 3166-1 alpha-2，例如：CN | US | DE | IT | SG 表15 dest_geo 参数 参数类型 描述 latitude Number 纬度 longitude Number 经度 city_code String 城市编码，Beijing | Shanghai country_code String 国家简码，参考ISO 3166-1 alpha-2，例如：CN | US | DE | IT | SG 表16 resource_list 参数 参数类型 描述 id String 云服务资源id name String 资源名称 type String 资源类型；引用云RMS type字段 provider String 云服务名称；引用云RMS provider字段 region_id String 区域；按照云regionId填写，如cn-north-1等 domain_id String 资源所属账号ID，UUID格式 project_id String 资源所属项目ID，UUID格式 ep_id String 企业项目id ep_name String 企业项目名称 tags String 资源标签 1、最多50个key/values对 2、values：最大255字符，取值范围：字母数字,空格,+, -, =, ., _, :, /,@ 表17 remediation 参数 参数类型 描述 recommendation String 推荐处理方法 url String 链接，指向该事件的一般修复信息。该URL必须可以从公网访问，不需要提供凭证 表18 malware 参数 参数类型 描述 malware_family String 恶意家族 malware_class String 恶意软件分类 表19 process 参数 参数类型 描述 process_name String 进程名 process_path String 进程执行文件路径 process_pid Integer 进程id process_uid Integer 进程用户id process_cmdline String 进程命令行 process_parent_name String 父进程名称 process_parent_path String 父进程执行文件路径 process_parent_pid Integer 父进程id process_parent_uid Integer 父进程用户id process_parent_cmdline String 父进程命令行 process_child_name String 子进程名称 process_child_path String 子进程执行文件路径 process_child_pid Integer 子进程id process_child_uid Integer 子进程用户id process_child_cmdline String 子进程命令行 process_launche_time String 进程启动时间，格式ISO8601：YYYY-MM-DDTHH:mm:ss.ms+timezone。时区信息为事件发生时区，无法解析时区的时间，默认时区填东八区 process_terminate_time String 进程结束时间，格式ISO8601：YYYY-MM-DDTHH:mm:ss.ms+timezone。时区信息为事件发生时区，无法解析时区的时间，默认时区填东八区 表20 user_info 参数 参数类型 描述 user_id String 用户uid user_name String 用户名称 表21 file_info 参数 参数类型 描述 file_path String 文件路径/名称 file_content String 文件内容 file_new_path String 文件新路径/名称 file_hash String 文件hash file_md5 String 文件md5 file_sha256 String 文件sha256 file_attr String 文件属性 表22 dataclass_ref 参数 参数类型 描述 id String 数据类唯一标识，UUID格式，最大36个字符 name String 数据类名称 状态码： 400 表23 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID,格式为：request_uuid-timestamp-hostname 表24 响应Body参数 参数 参数类型 描述 code String 错误码 message String 错误描述

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） content-type 是 String 内容类型 表3 请求Body参数 参数 是否必选 参数类型 描述 limit 否 Integer 分页大小 offset 否 Integer 偏移量 sort_by 否 String 排序字段：create_time | update_time order 否 String 排序方式：DESC | ASC from_date 否 String 搜索开始时间，例如：2023-02-20T00:00:00.000Z to_date 否 String 搜索结束时间，例如：2023-02-27T23:59:59.999Z condition 否 condition object 搜索条件表达式 表4 condition 参数 是否必选 参数类型 描述 conditions 否 Array of conditions objects 表达式列表 logics 否 Array of strings 表达式名称列表 表5 conditions 参数 是否必选 参数类型 描述 name 否 String 表达式名称 data 否 Array of strings 表达式内容列表

响应示例 状态码： 200 请求成功响应信息 { "count" : 41, "instances" : [ { "id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "name" : "MyXXX", "project_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "playbook" : { "id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "version_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "name" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "version" : "v1.1.1" }, "dataclass" : { "id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "name" : "909494e3-558e-46b6-a9eb-07a8e18ca62f" }, "dataobject" : { "id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "name" : "909494e3-558e-46b6-a9eb-07a8e18ca62f" }, "status" : "TERMINATED", "trigger_type" : "string", "start_time" : "2021-01-30T23:00:00Z+0800", "end_time" : "2021-01-30T23:00:00Z+0800" } ]}

URI GET /v1/{project_id}/workspaces/{workspace_id}/soc/playbooks/instances 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID workspace_id 是 String 工作空间ID 表2 Query参数 参数 是否必选 参数类型 描述 status 否 String 剧本实例状态. (RUNNING--运行中、FINISHED--成功、FAILED--失败、RETRYING--重试中、TERMINATING--终止中、TERMINATED--已终止) name 否 String 实例名称 playbook_name 否 String 剧本名称 dataclass_name 否 String 数据类名称 dataobject_name 否 String 数据对象名称 trigger_type 否 String 触发类型. TIMER--定时触发, EVENT--事件触发 from_date 否 String 查询起始时间 to_date 否 String 查询结束时间 limit 是 Integer 分页查询参数，用于指定一次查询最多的结果数，从1开始 offset 是 Integer 分页查询参数。用于指定查询结果的起始位置，从0开始