华为云用户手册

故障转移 当主实例故障无法恢复时，通常是区域性故障导致，需要进行故障转移。RegionlessDB集群会从所有的从实例中选取数据最新的从实例进行故障转移。 故障转移会造成一定程度的数据丢失，取决于故障转移时主从实例间的数据复制延迟情况。 通常故障转移可以在几分钟内完成，但执行故障转移后原来的主实例需要重建为从实例才可以重新加入到整个集群中，重建可能需要数十分钟到几个小时，具体时长取决于数据量的大小和区域之间的网络情况。

响应示例 状态码： 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, "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" }, "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", "id" : "MyXXX", "version" : 11, "format_version" : 11, "dataclass_ref" : { "id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "name" : "MyXXX" } } }

响应参数 状态码： 200 表3 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID,格式为：request_uuid-timestamp-hostname 表4 响应Body参数 参数 参数类型 描述 code String 错误码 message String 错误信息 data AlertDetail object 告警详情对象 表5 AlertDetail 参数 参数类型 描述 create_time String 记录时间，格式ISO8601：YYYY-MM-DDTHH:mm:ss.ms+timezone。时区信息为事件发生时区，无法解析时区的时间，默认时区填东八区 data_object Alert object 告警实体信息 dataclass_ref dataclass_ref object 数据类对象 format_version Integer 格式版本 id String 事件唯一标识，UUID格式，最大36个字符 type String 数据类型 project_id String 当前项目的id update_time String 更新时间，格式ISO8601：YYYY-MM-DDTHH:mm:ss.ms+timezone。时区信息为事件发生时区，无法解析时区的时间，默认时区填东八区 version Integer 版本 workspace_id String 当前的工作空间id 表6 Alert 参数 参数类型 描述 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表示最关键资源 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 文件信息 system_alert_table Object 告警管理列表的布局字段 表7 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 表8 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 检测模块列表 表9 alert_type 参数 参数类型 描述 category String 类别 alert_type String 告警类型 表10 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的地理位置信息 表11 src_geo 参数 参数类型 描述 latitude Number 纬度 longitude Number 经度 city_code String 城市编码，Beijing | Shanghai country_code String 国家简码，参考ISO 3166-1 alpha-2，例如：CN | US | DE | IT | SG 表12 dest_geo 参数 参数类型 描述 latitude Number 纬度 longitude Number 经度 city_code String 城市编码，Beijing | Shanghai country_code String 国家简码，参考ISO 3166-1 alpha-2，例如：CN | US | DE | IT | SG 表13 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字符，取值范围：字母数字,空格,+, -, =, ., _, :, /,@ 表14 remediation 参数 参数类型 描述 recommendation String 推荐处理方法 url String 链接，指向该事件的一般修复信息。该URL必须可以从公网访问，不需要提供凭证 表15 malware 参数 参数类型 描述 malware_family String 恶意家族 malware_class String 恶意软件分类 表16 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。时区信息为事件发生时区，无法解析时区的时间，默认时区填东八区 表17 user_info 参数 参数类型 描述 user_id String 用户uid user_name String 用户名称 表18 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 文件属性 表19 dataclass_ref 参数 参数类型 描述 id String 数据类唯一标识，UUID格式，最大36个字符 name String 数据类名称 状态码： 400 表20 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID,格式为：request_uuid-timestamp-hostname 表21 响应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 错误描述

响应示例 状态码： 200 请求成功响应信息 { "code" : 0, "message" : "Error message", "size" : 3, "page" : 10, "total" : 41, "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", "rule_enable" : true, "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" } ] }

URI GET /v1/{project_id}/workspaces/{workspace_id}/soc/playbooks/{playbook_id}/versions 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID workspace_id 是 String 工作空间ID playbook_id 是 String 剧本ID 表2 Query参数 参数 是否必选 参数类型 描述 status 否 String 剧本版本状态，编辑中：EDITING 审核中：APPROVING 不通过：UNPASSED 已发布：PUBLISHED enabled 否 Integer 启用/禁用 version_type 否 Integer 版本类型， 草稿版本：0 正式版本：1 offset 否 Integer 分页查询参数。用于指定查询结果的起始位置，从0开始 limit 否 Integer 分页查询参数，用于指定一次查询最多的结果数，从1开始

响应参数 状态码： 200 表4 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID,格式为：request_uuid-timestamp-hostname 表5 响应Body参数 参数 参数类型 描述 code String 错误码 message String 错误信息 size Integer 分页查询数据大小 page Integer 当前页码 total Integer 总数 data Array of PlaybookVersionListEntity objects 剧本版本列表信息 表6 PlaybookVersionListEntity 参数 参数类型 描述 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 是否激活 status String 状态. (EDITING--编辑中, APPROVING--审核中, UNPASSED--审核不通过, PUBLISHED--审核通过) action_strategy String 执行策略. 目前仅支持异步并发执行，对应值为ASYNC rule_enable Boolean 过滤规则是否启用 dataclass_id String 数据类ID trigger_type String 触发方式. EVENT--事件触发, TIMER--定时触发 dataobject_create Boolean 标识数据对象是否创建时触发剧本 dataobject_update Boolean 标识数据对象是否更新时触发剧本 dataobject_delete Boolean 标识数据对象是否删除时触发剧本 version_type Integer 版本类型 rule_id String 过滤规则ID dataclass_name String 数据类名称 approve_name String 审核者 状态码： 400 表7 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID,格式为：request_uuid-timestamp-hostname 表8 响应Body参数 参数 参数类型 描述 code String 错误码 message String 错误描述

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

响应示例 状态码： 200 请求成功 { "template_id" : "443a0117-1aa4-4595-ad4a-796fad4d4950", "update_time" : 1665221214, "template_name" : "Alert rule template", "data_source" : "sec_hss_vul", "version" : "1.0.0", "query" : "* | select status, count(*) as count group by status", "query_type" : "SQL", "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 GET /v1/{project_id}/workspaces/{workspace_id}/siem/alert-rules/templates/{template_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目 ID。Project ID. workspace_id 是 String 工作空间 ID。Workspace ID. template_id 是 String 告警规则模板 ID。Alert rule template 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 删除告警返回body体 { "code" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "message" : "Error message", "data" : { "success_ids" : [ "909494e3-558e-46b6-a9eb-07a8e18ca62f" ], "error_ids" : [ "909494e3-558e-46b6-a9eb-07a8e18ca62f" ] } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值） content-type 是 String 内容类型 表3 请求Body参数 参数 是否必选 参数类型 描述 batch_ids 否 Array of strings 删除告警的ID列表

响应参数 状态码： 200 表4 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID,格式为：request_uuid-timestamp-hostname 表5 响应Body参数 参数 参数类型 描述 code String 错误码 message String 错误信息 data BatchOperateAlertResult object 批量操作告警返回对象 表6 BatchOperateAlertResult 参数 参数类型 描述 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 错误描述

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 content-type 是 String application/json;charset=UTF-8 表3 请求Body参数 参数 是否必选 参数类型 描述 result 否 String 审核结果 通过：PASS 不通过：UN_PASS content 否 String 审核意见

响应参数 状态码： 200 表4 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID,格式为：request_uuid-timestamp-hostname 表5 响应Body参数 参数 参数类型 描述 code String 错误码 message String 响应消息 data ApproveOpinionDetail object 审核详情信息 表6 ApproveOpinionDetail 参数 参数类型 描述 result String 审核结果 content String 审核内容 状态码： 400 表7 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID,格式为：request_uuid-timestamp-hostname 表8 响应Body参数 参数 参数类型 描述 code String 错误码 message String 错误描述

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 content-type 是 String application/json;charset=UTF-8 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 剧本名称 description 否 String 描述 workspace_id 是 String 工作空间ID

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

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

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 是否展示在分类映射外的其他地方

响应示例 状态码： 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 表3 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID,格式为：request_uuid-timestamp-hostname 表4 响应Body参数 参数 参数类型 描述 code String 错误码 message String Error message data PlaybookVersionInfo object 剧本版本详情信息 表5 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 审核者 表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 RuleInfo 参数 参数类型 描述 id String 规则ID project_id String 项目ID rule String 触发规则 状态码： 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接口 基线的接口，包括搜索检查结果接口。

请求示例 查询基线检查结果的列表请求样例，查询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" : "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." }