华为云用户手册

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） content-type 是 String 内容类型 表3 请求Body参数 参数 是否必选 参数类型 描述 data_object 否 Incident object 事件实体信息 表4 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 事件管理列表的布局字段 表5 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 表6 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 检测模块列表 表7 incident_type 参数 是否必选 参数类型 描述 category 否 String 类别 incident_type 否 String 事件类型 表8 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的地理位置信息 表9 src_geo 参数 是否必选 参数类型 描述 latitude 否 Number 纬度 longitude 否 Number 经度 city_code 否 String 城市编码，Beijing | Shanghai country_code 否 String 国家简码，参考ISO 3166-1 alpha-2，例如：CN | US | DE | IT | SG 表10 dest_geo 参数 是否必选 参数类型 描述 latitude 否 Number 纬度 longitude 否 Number 经度 city_code 否 String 城市编码，Beijing | Shanghai country_code 否 String 国家简码，参考ISO 3166-1 alpha-2，例如：CN | US | DE | IT | SG 表11 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字符，取值范围：字母数字,空格,+, -, =, ., _, :, /,@ 表12 remediation 参数 是否必选 参数类型 描述 recommendation 否 String 推荐处理方法 url 否 String 链接，指向该事件的一般修复信息。该URL必须可以从公网访问，不需要提供凭证 表13 malware 参数 是否必选 参数类型 描述 malware_family 否 String 恶意家族 malware_class 否 String 恶意软件分类 表14 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。时区信息为事件发生时区，无法解析时区的时间，默认时区填东八区 表15 user_info 参数 是否必选 参数类型 描述 user_id 否 String 用户uid user_name 否 String 用户名称 表16 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 文件属性

响应示例 状态码： 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" }}

请求示例 创建一个剧本版本，剧本版本所属工作空间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", "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" } ], "dataclass_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "rule_enable" : true, "rule_id" : "4185bbd2-9d18-4362-92cb-46df0b24fe4e", "trigger_type" : "event", "dataobject_create" : true, "dataobject_update" : true, "dataobject_delete" : true, "action_strategy" : "sync"}

响应参数 状态码： 200 表5 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID,格式为：request_uuid-timestamp-hostname 表6 响应Body参数 参数 参数类型 描述 code String 错误码 message String Error message data PlaybookVersionInfo object 剧本版本详情信息 表7 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 审核者 表8 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 表9 RuleInfo 参数 参数类型 描述 id String 规则ID project_id String 项目ID rule String 触发规则 状态码： 400 表10 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID,格式为：request_uuid-timestamp-hostname 表11 响应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 actions 否 Array of ActionInfo objects 关联流程列表 dataclass_id 否 String 数据类ID rule_enable 否 Boolean 过滤规则是否启用 rule_id 否 String 过滤规则ID trigger_type 否 String 触发方式. EVENT--事件触发, TIMER--定时触发 dataobject_create 否 Boolean 标识数据对象是否创建时触发剧本 dataobject_update 否 Boolean 标识数据对象是否更新时触发剧本 dataobject_delete 否 Boolean 标识数据对象是否删除时触发剧本 action_strategy 否 String 执行策略. 目前仅支持异步并发执行，对应值为ASYNC 表4 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

请求示例 { "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 表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 错误码

响应示例 状态码： 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 表4 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID,格式为：request_uuid-timestamp-hostname 表5 响应Body参数 参数 参数类型 描述 code String 错误码 message String 错误信息 request_id String 请求ID total Integer 总数 limit Integer 分页大小 offset Integer 偏移量 success Boolean 是否成功 data BatchOperateDataobjectResult object 批量操作告警返回对象 表6 BatchOperateDataobjectResult 参数 参数类型 描述 error_ids Array of strings 失败id success_ids Array of strings 成功id 状态码： 400 表7 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID,格式为：request_uuid-timestamp-hostname 表8 响应Body参数 参数 参数类型 描述 code String 错误码 message String 错误描述

URI POST /v1/{project_id}/workspaces/{workspace_id}/soc/{dataclass_type}/{data_object_id}/{related_dataclass_type} 表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参数 参数 是否必选 参数类型 描述 ids 否 Array of strings 关联dataobject的ID列表

响应示例 状态码： 200 关联Dataobject返回body体 { "code" : 0, "message" : "Error message", "request_id" : "Error message", "success" : false, "total" : 41, "limit" : 3, "offset" : 10, "data" : { "success_ids" : [ "909494e3-558e-46b6-a9eb-07a8e18ca62f" ], "error_ids" : [ "909494e3-558e-46b6-a9eb-07a8e18ca62f" ] }}

响应参数 状态码： 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 错误描述

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 Instance Informations { "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"}

响应参数 状态码： 200 表3 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID,格式为：request_uuid-timestamp-hostname 表4 响应Body参数 参数 参数类型 描述 id String 剧本实例ID name String 剧本实例名称 project_id String 项目ID playbook PlaybookInfoRef object 剧本信息 dataclass DataclassInfoRef object 数据类信息 dataobject DataobjectInfo object 数据对象详情 status String 剧本实例状态. (RUNNING--运行中、FINISHED--成功、FAILED--失败、RETRYING--重试中、TERMINATING--终止中、TERMINATED--已终止) trigger_type String 触发类型. TIMER--定时触发, EVENT--事件触发 start_time String 创建时间 end_time String 更新时间 表5 PlaybookInfoRef 参数 参数类型 描述 id String 剧本ID version_id String 剧本版本ID name String 名称 version String 版本 表6 DataclassInfoRef 参数 参数类型 描述 id String 数据类ID name String 数据类名称 表7 DataobjectInfo 参数 参数类型 描述 id String ID值 create_time String 创建时间 update_time String 更新时间 project_id String 项目ID dataclass_id String 数据类ID name String 名称 content String 数据内容 状态码： 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/instances/{instance_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID workspace_id 是 String 工作空间ID instance_id 是 String instance _id

响应示例 状态码： 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 错误描述

API概览 通过使用 安全云脑 提供的接口，您可以完整的使用安全云脑的所有功能。 类型 说明 告警API接口 告警的接口，包括创建、删除、转事件等接口。 事件API接口 事件的接口，包括创建、更新、获取等接口。 威胁情报API接口 威胁情报的接口，包括创建、更新、获取等接口。 剧本API接口 剧本的接口，包括查询、创建、修改等接口。 告警规则API接口 告警规则的接口，包括创建、删除、查看、启用等接口。 剧本版本API接口 剧本版本的接口，包括查询、创建、更新等接口。 剧本规则API接口 剧本规则的接口，包括创建、查询、删除等接口。 剧本实例API接口 剧本实例的接口，包括查询、操作等接口。 剧本审核API接口 剧本审核的接口，包括审核剧本、查询剧本审核结果的接口。 事件关系API接口 事件关系的接口，包括查询、关联、取消关联接口。 数据类API接口 数据类的接口，包括查询数据类列表和字段列表接口。 流程API接口 流程的接口，包括查询流程列表接口。 数据空间API接口 数据空间的接口，包括创建数据空间接口。 管道API接口 管道的接口，包括创建管道接口。 工作空间API接口 工作空间的接口，包括新增、查询列表接口。 计量计费API接口 计量计费的接口，包括计量计费的接口。 指标查询API接口 指标查询的接口，包括批量查询指标接口。 基线API接口 基线的接口，包括搜索检查结果接口。

响应示例 状态码： 200 请求成功 { "code" : "00000000", "data" : [ { "create_time" : "2024-01-03T01:16:21.666+08:00", "data_object" : { "arrive_time" : "2024-01-03T11:28:03.993Z+0800", "baseline_type" : { "baseline_type" : "合规检查", "baseline_type_en" : "Compliance Check", "baseline_type_zh" : "合规检查", "category" : "", "category_en" : "", "category_zh" : "", "id" : "23f48a58cXXX162846076cd0" }, "catalog_id" : "9378d1e8-XXX-4aae-XXX-c41cf6829ede", "checkitem_id" : "13fcc967-cb49-XXX-811a-9f72ce6ce8ac", "compliance_package_id" : "39488f96-XXX-4cc6-XXX-ad3c29b3a6c2", "create_time" : "2024-01-02T17:16:21.666Z+0800", "data_source" : { "company_name" : "xxx", "domain_id" : "ac7438b990efXXXb45e8bf4", "product_feature" : "SA", "product_module" : "Base-line", "product_name" : "SecMaster", "project_id" : "15645222e8XXX93dab6341da6", "region_id" : "cn-north-7", "source_type" : 1 }, "dataclass_id" : "f846c8e0-XXX-XXX-bcbf-f77190847f08", "domain_id" : "ac7438b990eXXX1004eb45e8bf4", "domain_name" : "ac7438b99XXX1004eb45e8bf4", "end_time" : "2024-01-03T11:28:51.564Z+0800", "execitem_id" : "ca2a1361-5738-479c-8c40-d078e775a23a", "execitem_version" : 1, "first_observed_time" : "2024-01-03T11:28:50.955Z+0800", "handle_status" : "qualified", "id" : "39c56d70a9c2492XXXd91934cb5cb_13fcc967-XXX-494b-XXX-9f72ce6ce8ac", "is_deleted" : false, "last_observed_time" : "2024-01-03T11:28:51.564Z+0800", "method" : 1, "origin_id" : "", "project_id" : "15645222e874XXX93dab6341da6", "region_id" : "cn-north-7", "region_name" : "cn-north-7", "resource" : { "domain_id" : "ac7438b990eXXX04eb45e8bf4", "id" : "39c56d70a9cXXX1934cb5cb", "name" : "adfasd", "project_id" : "15645222XXXc93dab6341da6", "provider" : "xxx", "region_id" : "cn-north-7", "type" : "agency" }, "severity" : "informational", "start_time" : "2024-01-03T11:28:50.955Z+0800", "task_id" : "10da8403-XXX-442d-XXX-fa2fdf42a3a1", "title" : "项目服务中的委托权限配置检查", "trigger_flag" : false, "update_time" : "2024-01-03T11:28:51.887Z+0800", "workspace_id" : "1350a050-XXX-45e2-XXX-9cbfef116de7" }, "dataclass_ref" : { "id" : "f846c8e0-XXX-3767-XXX-f77190847f08" }, "format_version" : 0, "id" : "39c56d7XXX278fXXX934cb5cb_13fcc967-cb49-XXX-811a-9f72ce6ce8ac", "update_time" : "2024-01-03T19:28:51.887+08:00", "version" : 0 }, { "create_time" : "2024-01-03T01:16:21.821+08:00", "data_object" : { "arrive_time" : "2024-01-03T11:28:03.993Z+0800", "baseline_type" : { "baseline_type" : "合规检查", "baseline_type_en" : "Compliance Check", "baseline_type_zh" : "合规检查", "category" : "", "category_en" : "", "category_zh" : "", "id" : "23f48a58c5b2fXXX162846076cd0" }, "catalog_id" : "9378d1e8-XXX-4aae-XXX-c41cf6829ede", "checkitem_id" : "13fcc967-cb49-XXX-811a-9f72ce6ce8ac", "compliance_package_id" : "39488f96-XXX-4cc6-XXX-ad3c29b3a6c2", "create_time" : "2024-01-02T17:16:21.821Z+0800", "data_source" : { "company_name" : "xxx", "domain_id" : "ac7438b990efXXX004eb45e8bf4", "product_feature" : "SA", "product_module" : "Base-line", "product_name" : "SecMaster", "project_id" : "15645222XXX5c93dab6341da6", "region_id" : "cn-north-7", "source_type" : 1 }, "dataclass_id" : "f846c8e0-XXX-3767-bcbf-f77190847f08", "domain_id" : "ac7438b990eXXXb741004eb45e8bf4", "domain_name" : "ac7438bXXX37b741004eb45e8bf4", "end_time" : "2024-01-03T11:28:51.701Z+0800", "execitem_id" : "ca2a1361-XXX-479c-XXX-d078e775a23a", "execitem_version" : 1, "first_observed_time" : "2024-01-03T11:28:51.565Z+0800", "handle_status" : "qualified", "id" : "f295575ab57XXX977d9be93ca9fe_13fcc967-XXX-494b-XXX-9f72ce6ce8ac", "is_deleted" : false, "last_observed_time" : "2024-01-03T11:28:51.701Z+0800", "method" : 1, "origin_id" : "", "project_id" : "15645222e8XXXa985c93dab6341da6", "region_id" : "cn-north-7", "region_name" : "cn-north-7", "resource" : { "domain_id" : "ac7438b99XXX1004eb45e8bf4", "id" : "f295575ab57bXXXd9be93ca9fe", "name" : "apigw_admin_trust_secmaster", "project_id" : "15645222e8XXX93dab6341da6", "provider" : "xxx", "region_id" : "cn-north-7", "type" : "agency" }, "severity" : "informational", "start_time" : "2024-01-03T11:28:51.565Z+0800", "task_id" : "10da8403-4955XXXd-a974-faXXX2a3a1", "title" : "项目服务中的委托权限配置检查", "trigger_flag" : false, "update_time" : "2024-01-03T11:28:52.023Z+0800", "workspace_id" : "1350a050-d09a-4XXX-9503-9cbfef116de7" }, "dataclass_ref" : { "id" : "f846c8e0-cf0e-XXX-bcbf-XXX7f08" }, "format_version" : 0, "id" : "f295575ab57b49XXXe93ca9fe_13fcc967-XXX-494b-XXX-9f72ce6ce8ac", "update_time" : "2024-01-03T19:28:52.023+08:00", "version" : 0 } ], "page" : 0, "size" : 10, "success" : true, "total" : 2} 状态码： 400 请求失败 { "error_code" : "SecMaster.00040006", "error_msg" : "Invalid request parameters"} 状态码： 401 权限不足 { "error_code" : "SecMaster.90010015", "error_msg" : "Unauthorized request"} 状态码： 500 请求失败 { "error_code" : "SecMaster.00040011", "error_msg" : "Internal system error."}

请求示例 查询基线检查结果的列表请求样例，查询2024年6月20号到2024年6月27号，遵从包ID为6add7d71-2261-4195-bab7-8ada0f0ed4d2，目录ID为0b78937f-4d9b-4223-9a46-2361e5090be0， 资源类型为iam_user， 按照最近更新时间降序排序，返回第一页，每页10条数据 { "limit" : 10, "offset" : 0, "sort_by" : "last_observed_time", "order" : "DESC", "from_date" : "2024-06-20T00:00:00.000Z", "to_date" : "2024-06-27T23:59:59.999Z", "condition" : { "conditions" : [ { "name" : "compliance_package_id", "data" : [ "compliance_package_id", "=", "6add7d71-2261-4195-bab7-8ada0f0ed4d2" ] }, { "name" : "catalog_id", "data" : [ "catalog_id", "=", "0b78937f-4d9b-4223-9a46-2361e5090be0" ] }, { "name" : "resource.type", "data" : [ "resource.type", "=", "iam_user" ] } ], "logics" : [ "compliance_package_id", "AND", "catalog_id", "AND", "resource.type" ] }}

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户token X-Language 是 String 语言，参考值：zh-CN、en-US content-type 是 String 内容类型 表3 请求Body参数 参数 是否必选 参数类型 描述 limit 否 Integer 分页大小 offset 否 Integer 偏移量，表示查询该偏移量后面的记录 sort_by 否 String 排序关键字 order 否 String 降序或升序, DESC|ESC from_date 否 String 起始时间，格式ISO8601：YYYY-MM-DDTHH:mm:ss.ms+timezone。时区信息为事件发生时区，无法解析时区的时间，默认时区填东八区 to_date 否 String 截止时间，格式ISO8601：YYYY-MM-DDTHH:mm:ss.ms+timezone。时区信息为事件发生时区，无法解析时区的时间，默认时区填东八区 condition 否 Object 搜索条件表达式

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 code String 错误码 total Integer 查询结果总数 size Integer 分页大小 page Integer 偏移量 success Boolean 是否成功 data Array of strings 查询结果列表 状态码： 400 表5 响应Body参数 参数 参数类型 描述 code String 错误码 message String 错误描述 状态码： 401 表6 响应Body参数 参数 参数类型 描述 code String 错误码 message String 错误描述 状态码： 500 表7 响应Body参数 参数 参数类型 描述 code String 错误码 message String 错误描述

响应示例 状态码： 200 请求成功响应信息 { "code" : 0, "message" : "Error message", "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" }}

响应参数 状态码： 200 表3 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID,格式为：request_uuid-timestamp-hostname 表4 响应Body参数 参数 参数类型 描述 code String 错误码 message String 错误信息 data PlaybookInfo object 剧本详情信息 表5 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 表6 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID,格式为：request_uuid-timestamp-hostname 表7 响应Body参数 参数 参数类型 描述 code String 错误码 message String 错误描述

URI GET /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 请求成功 { "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" } ]}

响应参数 状态码： 200 表6 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID,格式为：request_uuid-timestamp-hostname 表7 响应Body参数 参数 参数类型 描述 code String 错误码 message String 错误信息 data RuleInfo object 剧本触发规格信息 表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 错误描述