华为云用户手册

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

请求示例 创建工作空间请求体 { "name" : "我的工作空间", "region_id" : "cn-north-4", "project_name" : "cn-north-4", "enterprise_project_id" : "", "enterprise_project_name" : "", "tags" : [ { "key" : "tag1", "value" : "value1" } ], "description" : "我的工作空间" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 content-type 是 String application/json;charset=UTF-8 表3 请求Body参数 参数 是否必选 参数类型 描述 region_id 是 String 区域id enterprise_project_id 否 String 企业项目id enterprise_project_name 否 String 企业项目名称 view_bind_id 否 String 视图绑定的空间id is_view 否 Boolean 是否是视图 name 是 String 工作空间名称 description 否 String 工作空间描述 project_name 是 String 项目名称 tags 否 Array of TagsPojo objects 通过给账号下的资源添加标签，可以对资源进行自定义标记，实现资源的分类。可到标签管理服务使用可视化表格操作资源标签，并对标签进行批量编辑。 表4 TagsPojo 参数 是否必选 参数类型 描述 key 否 String 标签key value 否 String 标签value

响应参数 状态码： 200 表5 响应Header参数 参数 参数类型 描述 X-request-id String This field is the request ID number for task tracking. Format is request_uuid-timestamp-hostname. 表6 响应Body参数 参数 参数类型 描述 alert_count Integer 告警数量。Alert count. severity String 严重程度，提示、低危、中危、高危、致命。Severity. TIPS, LOW, MEDIUM, HIGH, FATAL 状态码： 400 表7 响应Header参数 参数 参数类型 描述 X-request-id String This field is the request ID number for task tracking. Format is request_uuid-timestamp-hostname.

请求示例 模拟一条告警规则，告警规则所属的管道ID为ead2769b-afb0-45dd-b9fa-a2953e6ac82f，查询类型为SQL，严重程度为提示。 { "pipe_id" : "ead2769b-afb0-45dd-b9fa-a2953e6ac82f", "query" : "* | select status, count(*) as count group by status", "query_type" : "SQL", "event_grouping" : true, "from" : 1665221214000, "to" : 1665546370000, "triggers" : [ { "mode" : "COUNT", "operator" : "GT", "expression" : 10, "severity" : "TIPS" } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token，通过调用IAM服务获取用户Token接口获取。 IAM user token, fetch from IAM api. 表3 请求Body参数 参数 是否必选 参数类型 描述 pipe_id 是 String 数据管道 ID。Pipe ID. query 是 String 查询语句。Query. query_type 否 String 查询语法，SQL。Query type. SQL. from 是 Long 开始时间。Start time. to 是 Long 结束时间。End time. event_grouping 否 Boolean 告警分组。Event grouping. triggers 是 Array of AlertRuleTrigger objects 告警触发规则。Alert triggers. 表4 AlertRuleTrigger 参数 是否必选 参数类型 描述 mode 否 String 模式，数量。Mode. COUNT. operator 否 String 操作符，等于、不等于、大于、小于。 operator. EQ equal, NE not equal, GT greater than, LT less than. expression 是 String expression severity 否 String 严重程度，提示、低危、中危、高危、致命。Severity. TIPS, LOW, MEDIUM, HIGH, FATAL accumulated_times 否 Integer accumulated_times

AK/SK认证 AK/SK签名认证方式仅支持消息体大小12MB以内，12MB以上的请求请使用Token认证。 AK/SK认证就是使用AK/SK对请求进行签名，在请求时将签名信息添加到消息头，从而通过身份认证。 AK(Access Key ID)：访问密钥ID。与私有访问密钥关联的唯一标识符；访问密钥ID和私有访问密钥一起使用，对请求进行加密签名。 SK(Secret Access Key)：与访问密钥ID结合使用的密钥，对请求进行加密签名，可标识发送方，并防止请求被修改。 使用AK/SK认证时，您可以基于签名算法使用AK/SK对请求进行签名，也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。 签名SDK只提供签名功能，与服务提供的SDK不同，使用时请注意。

Token认证 Token的有效期为24小时，需要使用一个Token鉴权时，可以先缓存起来，避免频繁调用。 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。 Token可通过调用获取用户Token接口获取，调用本服务API需要project级别的Token，即调用获取用户Token接口时，请求body中auth.scope的取值需要选择project，如下所示。 { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxx" } } } } 获取Token 后，再调用其他接口时，您需要在请求消息头中添加“X-Auth-Token”，其值即为Token。例如Token值为“ABCDEFJ....”，则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可，如下所示。 Content-Type: application/json X-Auth-Token: ABCDEFJ....

响应参数 状态码： 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 条件表达式数据

错误码 当您调用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 请求成功 { "count" : 9223372036854776000, "records" : [ { "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 表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。 severity 否 Array of strings 严重程度，提示、低危、中危、高危、致命。Severity. TIPS, LOW, MEDIUM, HIGH, FATAL

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

请求示例 创建一条威胁情报，威胁情报名称为“威胁情报名称”，威胁情报版本为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 表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 数据类名称

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

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

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

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

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

响应示例 状态码： 200 请求成功响应信息 { "code" : 0, "message" : "Error message", "data" : { "id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "project_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f", "rule" : "909494e3-558e-46b6-a9eb-07a8e18ca62f" } }

URI GET /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 version Id value rule_id 是 String version Id value

响应参数 状态码： 200 表3 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID,格式为：request_uuid-timestamp-hostname 表4 响应Body参数 参数 参数类型 描述 code String 错误码 message String 错误信息 data RuleInfo object 剧本触发规格信息 表5 RuleInfo 参数 参数类型 描述 id String 规则ID project_id String 项目ID rule String 触发规则 状态码： 400 表6 响应Header参数 参数 参数类型 描述 X-request-id String 请求ID,格式为：request_uuid-timestamp-hostname 表7 响应Body参数 参数 参数类型 描述 code String 错误码 message String 错误描述

响应消息体（可选） 响应消息体通常以结构化格式返回，与响应消息头中Content-type对应，传递除响应消息头之外的内容。 对于获取用户Token接口，返回如下消息体。为篇幅起见，这里只展示部分内容。 { "token": { "expires_at": "2019-02-13T06:52:13.855000Z", "methods": [ "password" ], "catalog": [ { "endpoints": [ { "region_id": "xxxxxxxx", ...... 当接口调用出错时，会返回错误码及错误信息说明，错误响应的Body体格式如下所示。 { "error_msg": "The format of message is error", "error_code": "AS.0001" } 其中，error_code表示错误码，error_msg表示错误描述信息。

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 错误描述