华为云用户手册

请求示例 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 } ]}

URI DELETE /v1/{project_id}/workspaces/{workspace_id}/soc/playbooks/versions/{version_id}/actions/{action_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID workspace_id 是 String 工作空间ID version_id 是 String 剧本版本ID action_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 表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 错误描述

请求示例 创建一条剧本规则，名称为condition_0，表达式类型为所有， { "rule" : { "expression_type" : "common", "conditions" : [ { "name" : "condition_0", "detail" : "123", "data" : [ "handle_status, ==, Open" ] } ], "logics" : [ "condition_0" ] }}

响应示例 状态码： 200 请求成功响应信息 { "code" : 0, "message" : "", "data" : { "id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "project_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "rule" : "{\"expression_type\":\"common\",\"conditions\":[{\"name\":\"condition_0\",\"data\":[\"ref_order_id\",\"==\",\"123\"],\"detail\":\"123\"}],\"logics\":[\"condition_0\"]}" }}

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 content-type 是 String application/json;charset=UTF-8 表3 请求Body参数 参数 是否必选 参数类型 描述 rule 是 ConditionInfo object 剧本触发规则详情 表4 ConditionInfo 参数 是否必选 参数类型 描述 expression_type 否 String 表达式类型。默认为common,事件触发剧本必填 conditions 否 Array of ConditionItem objects 触发条件。事件触发剧本必填 logics 否 Array of strings 条件逻辑组合。事件触发剧本必填 cron 否 String Cron 表达式（定时任务）。定时触发剧本必填 schedule_type 否 String 定时重复类型(second--秒, hour--小时,day--天，week-周)。定时触发剧本必填 start_type 否 String 剧本开始执行类型，IMMEDIATELY--创建完成立即执行, CUSTOM--自定义执行时间。定时触发剧本必填 end_type 否 String 剧本结束执行类型，FOREVER--一直执行, CUSTOM--自定义结束时间。定时触发剧本必填 end_time 否 String 定时结束时间。定时触发剧本必填 repeat_range 否 String 执行时间段 2021-01-30T23:00:00Z+0800。定时触发剧本必填 only_once 否 Boolean 是否只执行一次。定时触发剧本必填 execution_type 否 String 执行队列类型（PARALLEL-新任务与之前任务并行）。定时触发剧本必填 表5 ConditionItem 参数 是否必选 参数类型 描述 name 否 String 条件名称 detail 否 String 条件详情 data 否 Array of strings 条件表达式数据

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

请求参数 表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 审核意见

请求示例 创建一条威胁情报，威胁情报名称为“威胁情报名称”，威胁情报版本为1，威胁情报类型为DATA_SOURCE，触发标志为否。 { "data_object" : { "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" }, "verdict" : "BLACK", "confidence" : 4, "status" : "OPEN", "labels" : "OPEN", "value" : "123", "granular_marking" : "1", "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" }, "defanged" : false, "first_report_time" : "2021-01-30T23:00:00Z+0800", "last_report_time" : "2021-01-30T23:00:00Z+0800", "indicator_type" : { "id" : "909494e3-558e-xxxxxx-07a8e18ca6xxx", "indicator_type" : "ipv6" }, "name" : "威胁情报名称", "dataclass_id" : "28f61af50fc9452aa0ed5ea25c3cc3d3", "workspace_id" : "909494e3-558e-46b6-a9eb-07a8e18ca620", "project_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "dataclass" : { "id" : "28f61af50fc9452aa0ed5ea25c3cc3d3", "name" : "名称" }, "create_time" : "2021-01-30T23:00:00Z+0800", "update_time" : "2021-01-30T23:00:00Z+0800" }}

响应示例 状态码： 200 请求成功响应信息 { "code" : 0, "message" : "Error message", "data" : { "id" : "28f61af50fc9452aa0ed5ea25c3cc3d3", "name" : "威胁情报名称", "data_object" : { "indicator_type" : { "indicator_type" : "ipv6", "id" : "ac794b2dfab9fe8c0676587301a636d3" }, "value" : "ip", "data_source" : { "domain_id" : "ac7438b990ef4a37b741004eb45e8bf4", "project_id" : "5b8bb3c888db498f9eeaf1023f7ba597", "region_id" : "cn-xxx-7", "source_type" : 1 }, "workspace_id" : "909494e3-558e-46b6-a9eb-07a8e18ca620", "project_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "granular_marking" : 1, "first_report_time" : "2023-07-04T16:47:01Z+0800", "status" : "Open" }, "dataclass_ref" : { "id" : "28f61af50fc9452aa0ed5ea25c3cc3d3", "name" : "名称" }, "create_time" : "2021-01-30T23:00:00Z+0800", "update_time" : "2021-01-30T23:00:00Z+0800" }}

响应参数 状态码： 200 表9 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID,格式为：request_uuid-timestamp-hostname 表10 响应Body参数 参数 参数类型 描述 code String 错误码 message String 错误信息 data IndicatorDetail object 情报详情信息 表11 IndicatorDetail 参数 参数类型 描述 id String 威胁情报ID name String 威胁情报名称 data_object IndicatorDataObjectDetail object 情报详情 workspace_id String 工作空间ID project_id String 项目ID dataclass_ref DataClassRefPojo object 数据类对象信息 create_time String 创建时间 update_time String 更新时间 表12 IndicatorDataObjectDetail 参数 参数类型 描述 indicator_type indicator_type object 情报类型对象 value String 值，如：ip url domain等 update_time String 更新时间 create_time String 创建时间 environment environment object 环境信息 data_source data_source object 数据源信息 first_report_time String 首次发生时间 is_deleted Boolean 是否删除 last_report_time String 最近发生时间 granular_marking Integer 粒度（保密等级），由高到低：1（首次发现）、2（自产数据）、3（需购买）、4（外网直接查询） name String 名称 id String 威胁情报ID project_id String 项目ID revoked Boolean 是否作废 status String 状态， Open--打开，Closed--关闭, Revoked--作废 verdict String 威胁度， Black--黑,White--白，Gray--灰 workspace_id String 工作空间ID confidence Integer 置信度，取值范围是80-100 表13 indicator_type 参数 参数类型 描述 indicator_type String 情报类型 id String 情报类型ID 表14 environment 参数 参数类型 描述 vendor_type String 环境供应商 domain_id String 租户ID region_id String 区域ID project_id String 项目ID 表15 data_source 参数 参数类型 描述 source_type Integer 数据源类型，取值范围如下：1 - 云上产品 2 - 第三方产品 3 - 租户私有产品 domain_id String 租户ID project_id String 项目ID region_id String 区域ID 表16 DataClassRefPojo 参数 参数类型 描述 id String 数据类ID name String 数据类名称 状态码： 400 表17 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID,格式为：request_uuid-timestamp-hostname 表18 响应Body参数 参数 参数类型 描述 code String 错误码 message String 错误描述

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 租户的Token content-type 是 String application/json;charset=UTF-8 表3 请求Body参数 参数 是否必选 参数类型 描述 data_object 是 CreateIndicatorDetail object 情报详情信息 表4 CreateIndicatorDetail 参数 是否必选 参数类型 描述 data_source 是 data_source object 数据源信息 verdict 是 String 威胁度 confidence 否 Integer 置信度 status 否 String 状态 labels 否 String 标签 value 是 String 值 granular_marking 是 String 粒度（保密等级），由高到低：1（首次发现）、2（自产数据）、3（需购买）、4（外网直接查询） environment 是 environment object 环境信息 defanged 是 Boolean 是否失效 first_report_time 是 String 首次发生时间 last_report_time 否 String 最近发生时间 id 否 String 威胁情报ID indicator_type 是 indicator_type object 威胁情报类型 name 是 String 威胁情报名称 dataclass_id 否 String 数据类ID workspace_id 是 String workspace id project_id 否 String Project id value dataclass 否 DataClassRefPojo object 数据类对象信息 create_time 否 String Create time update_time 否 String Update time 表5 data_source 参数 是否必选 参数类型 描述 source_type 是 Integer current page count domain_id 是 String Id value project_id 是 String Id value region_id 是 String Id value product_name 是 String Id value product_feature 是 String Id value 表6 environment 参数 是否必选 参数类型 描述 vendor_type 是 String 环境供应商 domain_id 是 String 租户ID region_id 是 String 区域ID project_id 是 String 项目ID 表7 indicator_type 参数 是否必选 参数类型 描述 indicator_type 是 String 威胁情报类型 id 是 String 情报类型ID 表8 DataClassRefPojo 参数 是否必选 参数类型 描述 id 是 String 数据类ID name 否 String 数据类名称

错误码 当您调用API时，如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。 状态码 错误码 错误信息 400 SecMaster.11061001 进程状态有误 400 SecMaster.11061002 模型数量超出范围限制 400 SecMaster.11061003 schedule参数超出范围 400 SecMaster.11061004 告警名称已存在 400 SecMaster.20010001 无效的工作空间ID 400 SecMaster.20030001 无效的参数 400 SecMaster.20030002 无效的项目ID 400 SecMaster.20030003 无效的名称 400 SecMaster.20030004 创建数据对象失败 400 SecMaster.20030005 获取数据对象失败 400 SecMaster.20030009 无效的排序字段 400 SecMaster.20030010 无效的排序 400 SecMaster.20030011 更新数据对象错误 400 SecMaster.20030012 删除数据对象错误 400 SecMaster.20030013 搜索数据对象错误 400 SecMaster.20030022 查询特定数据类失败 400 SecMaster.20030025 验证数据对象失败 400 SecMaster.20039999 未知错误 400 SecMaster.20040000 未知错误 400 SecMaster.20040402 查询数据类失败 400 SecMaster.20040516 字段超过最大限制 400 SecMaster.20041001 无效的工作空间ID 400 SecMaster.20041002 无效的参数 400 SecMaster.20041003 无效的项目ID 400 SecMaster.20041031 获取数据对象失败 400 SecMaster.20041033 未选择关联数据对象 400 SecMaster.20041504 创建事件失败 400 SecMaster.20041507 更新事件失败 400 SecMaster.20041508 删除事件失败 400 SecMaster.20041509 单日事件创建个数超过最大限制 400 SecMaster.20041804 告警转事件请求内容错误 400 SecMaster.20041805 创建告警失败 400 SecMaster.20041808 更新告警失败 400 SecMaster.20041809 删除告警失败 400 SecMaster.20041810 单日告警创建个数超过最大限制 400 SecMaster.20041811 单日告警转事件个数超过最大限制 400 SecMaster.20041903 获取数据类失败 400 SecMaster.20041904 威胁情报数据不存在 400 SecMaster.20041905 创建威胁情报失败 400 SecMaster.20041906 更新威胁情报失败 400 SecMaster.20041907 删除威胁情报失败 400 SecMaster.20042501 单日指标创建个数超过最大限制 400 SecMaster.20048001 剧本存在正在运行的实例或存在激活版本不能删除 400 SecMaster.20048002 剧本不存在激活版本，不能启用 400 SecMaster.20048003 剧本状态错误，不能审核 400 SecMaster.20048004 资源不存在 400 SecMaster.20048005 剧本审核不通过，不能激活 400 SecMaster.20048006 剧本ID错误 400 SecMaster.20048007 剧本版本ID错误 400 SecMaster.20048008 剧本动作ID错误 400 SecMaster.20048009 剧本规则ID错误 400 SecMaster.20048013 剧本启用中，不能失活版本 400 SecMaster.20048014 剧本已经发布，不能编辑 400 SecMaster.20048015 剧本名称重复 400 SecMaster.20048016 剧本定时任务时间范围错误 400 SecMaster.20048017 剧本定时任务Corn表达式错误 400 SecMaster.20048018 版本数量已达到上限 400 SecMaster.20048019 剧本存在审核中版本，不能新建版本 400 SecMaster.20048020 数据对象ID错误 400 SecMaster.20048021 搜索内容无效 400 SecMaster.20048022 查询结束时间必须大于查询起始时间 400 SecMaster.20048023 注册剧本定时任务失败 400 SecMaster.20048024 禁用剧本定时任务失败 400 SecMaster.20048025 结束时间必须大于开始时间 400 SecMaster.20048026 无效的剧本结束时间 400 SecMaster.20048027 数据类ID不能为空 400 SecMaster.20048028 存在未启用的匹配流程，不能提交版本 400 SecMaster.20048029 剧本数据转换错误 400 SecMaster.20048030 剧本个数超过最大限制 400 SecMaster.20048031 剧本关联匹配流程个数超过限制 400 SecMaster.20048032 无效的剧本调度时间间隔 400 SecMaster.20048033 剧本关联的匹配流程不能为空 400 SecMaster.20048034 匹配流程与剧本数据类不一致 400 SecMaster.20048035 系统内置剧本不允许修改 400 SecMaster.20048036 系统内置剧本不允许删除 父主题： 附录

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

请求参数 表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 表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 错误信息 data IndicatorBatchOperateResponse object 情报响应参数 表6 IndicatorBatchOperateResponse 参数 参数类型 描述 success_ids Array of strings 成功ID列表 error_ids Array of strings 失败ID列表 状态码： 400 表7 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID,格式为：request_uuid-timestamp-hostname 表8 响应Body参数 参数 参数类型 描述 code String 错误码 message String 错误描述

响应示例 状态码： 200 请求成功响应 { "code" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "message" : "Error message", "data" : { "success_ids" : [ "909494e3-558e-46b6-a9eb-07a8e18ca62f" ], "error_ids" : [ "909494e3-558e-46b6-a9eb-07a8e18ca62f" ] }}

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

响应参数 状态码： 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 内容类型 表3 请求Body参数 参数 是否必选 参数类型 描述 batch_ids 否 Array of strings 删除告警的ID列表

响应参数 状态码： 200 表5 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID,格式为：request_uuid-timestamp-hostname 表6 响应Body参数 参数 参数类型 描述 code String Error code message String Error message data Array of ActionInfo objects list of informations of playbook action 表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 状态码： 400 表8 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID,格式为：request_uuid-timestamp-hostname 表9 响应Body参数 参数 参数类型 描述 code String 错误码 message String 错误描述

请求示例 创建一个剧本动作，剧本名称为MyXXX，描述为This my XXXX，剧本动作类型为aopworkflow，剧本动作ID为909494e3-558e-46b6-a9eb-07a8e18ca62f，排序顺序为string。 [ { "name" : "MyXXX", "description" : "This my XXXX", "action_type" : "aopworkflow", "action_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "sort_order" : "string"} ]

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

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 content-type 是 String application/json;charset=UTF-8 表3 请求Body参数 参数 是否必选 参数类型 描述 [数组元素] 是 Array of CreateAction objects Create actions 表4 CreateAction 参数 是否必选 参数类型 描述 name 否 String 名称 description 否 String 描述 action_type 是 String 类型，默认AOP_WORKFLOW. action_id 是 String 剧本动作ID sort_order 否 String 排序方式

URI GET /v1/{project_id}/workspaces/{workspace_id}/siem/alert-rules 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目 ID。Project ID. workspace_id 是 String 工作空间 ID。Workspace ID. 表2 Query参数 参数 是否必选 参数类型 描述 offset 是 Long 偏移量。Offset. limit 是 Long 条数。Limit. sort_key 否 String 排序字段。Sort key sort_dir 否 String 排序顺序，顺序、逆序。Sort direction, asc, desc。 pipe_id 否 String 数据管道 ID。Pipe ID. rule_name 否 String 告警规则名称。Alert rule name. rule_id 否 String 告警规则 ID。Alert rule ID. status 否 Array of strings 启用状态，启用、停用。Status, enabled, disabled. severity 否 Array of strings 严重程度，提示、低危、中危、高危、致命。Severity. TIPS, LOW, MEDIUM, HIGH, FATAL

响应示例 状态码： 200 成功 { "count" : 9223372036854776000, "records" : [ { "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" } ] } ]}