华为云用户手册

URI DELETE /v1/{project_id}/workspaces/{workspace_id}/soc/playbooks/versions/{version_id}/rules/{rule_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID workspace_id 是 String 工作空间ID version_id 是 String 剧本版本ID rule_id 是 String 规则ID

响应参数 状态码： 200 表3 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID,格式为：request_uuid-timestamp-hostname 表4 响应Body参数 参数 参数类型 描述 code String 错误码 message String 响应消息 状态码： 400 表5 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID,格式为：request_uuid-timestamp-hostname 表6 响应Body参数 参数 参数类型 描述 code String 错误码 message String 错误描述

响应参数 状态码： 200 表4 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID,格式为：request_uuid-timestamp-hostname 表5 响应Body参数 参数 参数类型 描述 code String 错误码 message String 响应消息信息 total Integer 总条数 size Integer 分页查询数据大小 page Integer 当前页码 data Array of PlaybookInfo objects 剧本列表信息 表6 PlaybookInfo 参数 参数类型 描述 id String 剧本ID name String 剧本名称 description String 描述信息 create_time String 剧本创建时间 update_time String 剧本更新时间 project_id String 项目ID version_id String 剧本版本ID enabled Boolean 是否启用 workspace_id String 工作空间ID approve_role String 审核用户角色 user_role String 用户角色 edit_role String 编辑用户角色 owner_id String 所有者ID version String 版本号 dataclass_name String 数据类名称 dataclass_id String 数据类ID unaudited_version_id String 待审核剧本版本ID reject_version_id String 已驳回剧本版本ID 状态码： 400 表7 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID,格式为：request_uuid-timestamp-hostname 表8 响应Body参数 参数 参数类型 描述 code String 错误码 message String 错误描述

响应示例 状态码： 200 剧本列表查询成功响应参数 { "code" : 0, "message" : null, "total" : 41, "page" : 10, "data" : [ { "id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "name" : "MyXXX", "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", "version_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "enabled" : true, "workspace_id" : "string", "approve_role" : "approve", "user_role" : "string", "edit_role" : "editor", "owner_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "version" : "v1.1.1", "dataclass_name" : "string", "dataclass_id" : "string", "unaudited_version_id" : "string", "reject_version_id" : "string" } ] }

URI GET /v1/{project_id}/workspaces/{workspace_id}/soc/playbooks 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID workspace_id 是 String 工作空间ID 表2 Query参数 参数 是否必选 参数类型 描述 search_txt 否 String 搜索关键字 enabled 否 Boolean 是否启用 offset 是 Integer 分页查询参数。用于指定查询结果的起始位置，从0开始 limit 是 Integer 分页查询参数，用于指定一次查询最多的结果数，从1开始 description 否 String 剧本描述 dataclass_name 否 String 数据类名称 name 否 String 剧本名称

响应参数 状态码： 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 DataObjectDetail objects 告警列表 表8 DataObjectDetail 参数 参数类型 描述 create_time String 记录时间，格式ISO8601：YYYY-MM-DDTHH:mm:ss.ms+timezone。时区信息为事件发生时区，无法解析时区的时间，默认时区填东八区 data_object DataObject 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 DataObject 参数 参数类型 描述 version String 告警对象的版本，该字段的值必须为云SSA服务确定的官方发布版本之一 id String 事件唯一标识，UUID格式，最大36个字符 domain_id String 数据投递后，被委托用户的domain_id region_id String 数据投递后，被委托用户的region_id workspace_id String 当前的工作空间id environment environment object 告警产生的环境坐标信息 datasource datasource 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表示最关键资源 alert_type alert_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 文件信息 表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 datasource 参数 参数类型 描述 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 alert_type 参数 参数类型 描述 category String 类别 alert_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 错误描述

URI POST /v1/{project_id}/workspaces/{workspace_id}/soc/{dataclass_type}/{data_object_id}/{related_dataclass_type}/search 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id workspace_id 是 String 工作空间id dataclass_type 是 String 关联主体dataobject所属数据类，小写复数，如告警为alerts，事件为incidents data_object_id 是 String 关联主体dataobject的id related_dataclass_type 是 String 被关联的dataobject所属数据类，小写复数，如告警为alerts，事件为incidents

请求参数 表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 表达式内容列表

请求消息体 请求消息体通常以结构化格式发出，与请求消息头中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/tokens Content-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。

请求消息头 附加请求头字段，如指定的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/tokens Content-Type: application/json

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

请求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在同一个区域也相同，所以简洁起见将这两部分省略。

请求示例 通过指标接口查询从6月25日至当前的告警等级分布 https://{endpoint}/v1/{project_id}/workspaces/{workspace_id}/sa/metrics/hits { "metric_ids" : [ "1f0f5e29-5a92-17a5-2c16-5f37c6dc109c" ], "params" : [ { "start_date" : "2024-06-25T00:00:00.000+08:00" } ] }

响应示例 状态码： 200 请求成功 [ { "metric_id" : "1f0f5e29-5a92-17a5-2c16-5f37c6dc109c", "result" : { "labels" : [ "label1" ], "datarows" : [ [ { } ] ], "effective_column" : "0:1" }, "status" : "SUC CES S" } ]

URI POST /v1/{project_id}/workspaces/{workspace_id}/sa/metrics/hits 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID workspace_id 是 String 工作空间ID 表2 Query参数 参数 是否必选 参数类型 描述 timespan 否 String 查询指标的时间范围，ISO8601格式，例如：2007-03-01T13:00:00Z/2008-05-11T15:30:00Z或2007-03-01T13:00:00Z/P1Y2M10DT2H30M或P1Y2M10DT2H30M/2008-05-11T15:30:00Z cache 否 Boolean 是否启用缓存，默认true, 禁用缓存 false

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token，通过调用IAM服务获取用户Token接口获取。 IAM user token, fetch from IAM api. 表3 请求Body参数 参数 是否必选 参数类型 描述 [数组元素] 是 Array of strings DisableAlertRuleRequestBody

响应参数 状态码： 200 表3 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID,格式为：request_uuid-timestamp-hostname 表4 响应Body参数 参数 参数类型 描述 code String 错误码 message String 错误信息 data PlaybookStatisticDetail object 剧本状态统计信息 表5 PlaybookStatisticDetail 参数 参数类型 描述 unapproved_num Integer 未审核剧本数量 disabled_num Integer 未启用剧本数量 enabled_num Integer 已启用剧本数量 状态码： 400 表6 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID,格式为：request_uuid-timestamp-hostname 表7 响应Body参数 参数 参数类型 描述 code String 错误码 message String 错误描述

指标信息说明 表1 指标信息说明 指标名称 指标ID 指标描述 指标参数说明 所有资产数量 6f8d4892-713c-4d12-8584-dc04f7847b32 工作空间内所有资产数量 无 高危资产数量 a5597747-8cef-4342-9855-3fdaf00ad460 工作空间内高危资产数量 无 其它风险资产数量 09ca4eb8-a4ca-4ef4-b75f-e9172f39393b 工作空间内除高危风险资产外资产数量 无 告警等级数量分布 1f0f5e29-5a92-17a5-2c16-5f37c6dc109c 从参数起始时间到当前时间范围内，工作空间内告警等级数量分布 “params”参数填写“start_date”表示统计起始时间，例如： "start_date": "2024-06-21T00:00:00.000+08:00" 漏洞等级数量分布 815c8a73-c855-fd29-63e2-b093d05a7ef0 工作空间内漏洞不同等级漏洞分布 无 基线检查不合格结果等级分布 fee4d416-25b4-46c6-aa1b-851c7251e04b 工作空间内30天内不同等级基线检查结果分布 无 安全评分趋势 39d386dc-5868-adb6-a8e9-d5e92bb75663 工作空间内近七天每天安全评分得分 无 威胁告警事件Top5 aaa6e851-601b-53c5-61ef-ffc95889ebf3 从参数起始时间到当前时间范围内，工作空间内威胁告警事件TOP5 “params”参数填写"start_date"表示统计起始时间，例如： "start_date": "2024-06-21T00:00:00.000+08:00" 工作空间安全评分 cf6cce38-bc32-fd89-c0b5-3ba2cdf98eda 工作空间内最新一次安全评分得分 无 父主题： 附录

响应示例 状态码： 200 请求成功响应信息 { "count" : 41, "action_instances" : [ { "action" : { "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" }, "instance_log" : { "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 GET /v1/{project_id}/workspaces/{workspace_id}/soc/playbooks/instances/{instance_id}/topology 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID workspace_id 是 String 工作空间ID instance_id 是 String 剧本实例ID

响应参数 状态码： 200 表3 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID,格式为：request_uuid-timestamp-hostname 表4 响应Body参数 参数 参数类型 描述 count Integer 总数 action_instances Array of ActionInstanceInfo objects 流程实例列表 表5 ActionInstanceInfo 参数 参数类型 描述 action ActionInfo object 剧本流程动作信息 instance_log AuditLogInfo object 剧本实例审计日志信息 表6 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 表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 错误描述

请求示例 { "dataspace_id" : "a00106ba-bede-453c-8488-b60c70bd6aed", "pipe_name" : "pipe-01", "description" : "test pipe", "storage_period" : 30, "shards" : 3, "mapping" : { "name" : { "type" : "text" }, "id" : { "type" : "text" }, "publish_time" : { "type" : "data" } } }

响应示例 状态码： 200 创建成功返回值 { "domain_id" : "0531ed520xxxxxxebedb6e57xxxxxxxx", "project_id" : "2b31ed520xxxxxxebedb6e57xxxxxxxx", "dataspace_id" : "a00106ba-bede-453c-8488-b60c70bd6aed", "dataspace_name" : "dataspace-01", "pipe_id" : "b22106ba-bede-453c-8488-b60c70bd6aed", "pipe_name" : "pipe-01", "pipe_type" : "system-defined", "description" : "test pipe", "storage_period" : 30, "shards" : 3, "create_by" : "0642ed520xxxxxxebedb6e57xxxxxxxx", "create_time" : 1584883694354, "update_by" : "0642ed520xxxxxxebedb6e57xxxxxxxx", "update_time" : 1584883694354 }

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 domain_id String 用户domainId project_id String 项目id dataspace_id String 数据空间id dataspace_name String 数据空间名称 pipe_id String 管道id pipe_name String 管道名称 pipe_type String 管道类型（system-defined，系统预定义)、1（user-defined，用户自定义) description String 描述信息 storage_period Integer 索引存储天数 shards Integer 索引分片数量 create_by String 创建者 create_time Integer 创建时间 update_by String 更新者 update_time Integer 更新时间 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_msg String 无效请求提示信息 error_code String 错误码 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error_msg String 权限错误 error_code String 错误码 状态码： 403 表8 响应Body参数 参数 参数类型 描述 - String 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_msg String 系统内部错误 error_code String 错误码

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 X-Language 是 String 用户当前语言环境 zh-cn or en-us. 表3 请求Body参数 参数 是否必选 参数类型 描述 region_id 是 String 区域ID，如cn-north-4 domain_id 是 String domainId tag_list 否 Array of TagInfo objects 计费标签 product_list 否 Array of ProductPostPaid objects 商品列表 operate_type 否 String 操作类型：create新购, addition增加配额 表4 TagInfo 参数 是否必选 参数类型 描述 key 是 String 标识 中文、字母、数字、_或者-，且长度范围[2, 36] value 是 String 内容 中文、字母、数字、_或者-，且长度范围[2, 36] 表5 ProductPostPaid 参数 是否必选 参数类型 描述 id 是 String ID标识，同一次询价中不能重复，用于标识返回询价结果和请求的映射关系 product_id 是 String 产品Id，通过向CBC询价获取该商品的标识 cloud_service_type 是 String 云服务类型，固定值为hws.service.type.sa resource_type 是 String 用户购买云服务产品的资源类型，例如SecMaster中的典型场景配置，资源类型为hws.resource.type.secmaster.typical resource_spec_code 是 String 用户购买云服务产品的资源规格，例如 安全云脑 中的的基础版，资源规格为secmaster.basic usage_measure_id 是 Integer 使用量单位标识，按需询价必填，例如按小时询价，使用量值为1，使用量单位为小时，枚举值如下： 4：小时 10：GB（带宽按流量询价使用） 11：MB（带宽按流量询价使用） usage_value 是 Number 使用量值，按需询价必填，例如按小时询价，使用量值为1，使用量单位为小时 resource_size 是 Integer 配额个数 usage_factor 是 String 使用量因子，按需计费必填，取值和话单中的使用量因子一致，云服务和使用量因子对应关系如下： 典型场景配置：Duration 态势管理：duration 安全编排：count 智能分析：flow resource_id 否 String 资源id，仅在增加配额的时候传入

请求示例 https://{endpoint}/v1/{projectId}/subscriptions/orders { "domain_id" : "abcdef8a41164a2280ec65f1f4c4mlnyz", "region_id" : "cn-north-4", "product_list" : [ { "product_id" : "OFFI908269345109094402", "cloud_service_type" : "hws.service.type.sa", "id" : "E52E1A22-9408-459A-9F67-7B5C11B1E71A", "resource_spec_code" : "secmaster.professional", "resource_type" : "hws.resource.type.secmaster.typical", "usage_factor" : "duration", "usage_value" : 1, "usage_measure_id" : 4, "resource_size" : 1 } ] }

响应示例 状态码： 200 请求成功响应信息 { "code" : "00000000", "message" : "", "data" : { "total_instance_run_num" : "Unknown Type: in", "schedule_instance_run_num" : 99999999, "event_instance_run_num" : 99999999, "average_run_time" : 9999999999, "min_run_time_instance" : { "playbook_instance_id" : "string", "playbook_instance_name" : "string", "playbook_instance_run_time" : 9999999999 }, "max_run_time_instance" : { "playbook_instance_id" : "string", "playbook_instance_name" : "string", "playbook_instance_run_time" : 9999999999 }, "total_instance_num" : 99999999, "success_instance_num" : 99999999, "fail_instance_num" : 99999999, "terminate_instance_num" : 99999999, "running_instance_num" : 99999999 } }

响应参数 状态码： 200 表4 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID,格式为：request_uuid-timestamp-hostname 表5 响应Body参数 参数 参数类型 描述 code String 错误码 message String 错误信息 data PlaybookInstanceMonitorDetail object 剧本运行监控详情 表6 PlaybookInstanceMonitorDetail 参数 参数类型 描述 total_instance_run_num Integer 运行总次数 schedule_instance_run_num Integer 定时触发执行次数 event_instance_run_num Integer 时间触发执行次数 average_run_time Number 平均运行时间 min_run_time_instance PlaybookInstanceRunStatistics object 最短运行时间流程实例信息 max_run_time_instance PlaybookInstanceRunStatistics object 最长运行时间流程实例信息 total_instance_num Integer 剧本实例总数 success_instance_num Integer 运行成功实例数量 fail_instance_num Integer 运行失败实例数量 terminate_instance_num Integer 运行终止实例数量 running_instance_num Integer 运行中实例数量 表7 PlaybookInstanceRunStatistics 参数 参数类型 描述 playbook_instance_id String 剧本实例ID playbook_instance_name String 剧本实例名称 playbook_instance_run_time Number 剧本实例运行时间 状态码： 400 表8 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID,格式为：request_uuid-timestamp-hostname 表9 响应Body参数 参数 参数类型 描述 code String 错误码 message String 错误描述

URI GET /v1/{project_id}/workspaces/{workspace_id}/soc/playbooks/{playbook_id}/monitor 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID workspace_id 是 String 工作空间ID playbook_id 是 String 剧本ID 表2 Query参数 参数 是否必选 参数类型 描述 start_time 是 String 开始时间。格式ISO8601：YYYY-MM-DDTHH:mm:ss.ms+timezone。例如：2021-01-30T23:00:00Z+0800。时区信息为剧本实例产生的时区，无法解析时区的时间，默认时区填东八区。 version_query_type 是 String 统计剧本版本类型（ALL:全部，VALID:有效的，DELETED:已删除） end_time 是 String 结束时间。格式ISO8601：YYYY-MM-DDTHH:mm:ss.ms+timezone。例如：2021-01-30T23:00:00Z+0800。时区信息为剧本实例产生的时区，无法解析时区的时间，默认时区填东八区。

请求示例 创建一条告警，告警名称为MyXXX，标签为MyXXX，URL为http://xxx，发生次数为4次，置信度为4，严重等级为tips。 { "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", "product_name" : "test", "product_feature" : "test" }, "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", "labels" : "MyXXX", "description" : "This my XXXX", "source_url" : "http://xxx", "count" : 4, "confidence" : 4, "severity" : "TIPS", "criticality" : 4, "alert_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" } ], "system_alert_table" : { }, "id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "workspace_id" : "909494e3-558e-46b6-a9eb-07a8e18ca620" } }