更新时间:2025-08-30 GMT+08:00
分享

更新应急策略

功能介绍

更新单个应急策略,根据实际修改的属性更新,未修改的列不更新

调用方法

请参见如何调用API

URI

PUT /v1/{project_id}/workspaces/{workspace_id}/soc/policys/{policy_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取项目ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

workspace_id

String

参数解释:

工作空间id。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

policy_id

String

参数解释:

策略id

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。获取用户Token

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

content-type

String

参数解释:

内容类型

  • application/json;charset=UTF-8 普通API请求的类型

约束限制:

不涉及

取值范围:

  • application/json;charset=UTF-8

默认取值:

不涉及

x-secmaster-version

String

服务版本,例如25.5.0

表3 请求Body参数

参数

是否必选

参数类型

描述

batch_ids

Array of strings

应急策略的id集合

data_object

Policy object

策略实体信息(其他字段待数据类字段确定后补充)

表4 Policy

参数

是否必选

参数类型

描述

version

String

策略对象的版本,该字段的值必须为华为云SSA服务确定的官方发布版本之一

id

String

策略唯一标识,UUID格式,最大36个字符

domain_id

String

数据投递后,被委托用户的domain_id

domain_name

String

数据投递后,被委托用户的domain_name

region_id

String

数据投递后,被委托用户的region_id

workspace_id

String

当前的工作空间id

create_time

String

记录时间,格式ISO8601:YYYY-MM-DDTHH:mm:ss.ms+timezone。时区信息为事件发生时区,无法解析时区的时间,默认时区填东八区

update_time

String

记录时间,格式ISO8601:YYYY-MM-DDTHH:mm:ss.ms+timezone。时区信息为事件发生时区,无法解析时区的时间,默认时区填东八区

creator

String

创建者ID

creator_name

String

创建者名称

modifier_id

String

修改者ID

modifier_name

String

修改者名称

block_target

String

阻断对象IP

policy_task_id

String

任务id

policy_task_name

String

任务名称

policy_category

String

类型,WHITE/BLOCK,WHITE代表加白(将ip等对象加入白名单),BLOCK代表阻断(将ip等对象加入黑名单)

type

String

阻断类型,当前只有源ip

block_age

block_age object

阻断老化

label

String

标签

description

String

应急策略描述信息

defense_policy_list

Array of ConnectionPolicy objects

与操作连接对应的策略列表

表5 block_age

参数

是否必选

参数类型

描述

is_block_ageing

Boolean

是否阻断老化

block_ageing

String

老化时间,毫秒级时间戳

表6 ConnectionPolicy

参数

是否必选

参数类型

描述

defense_id

String

策略唯一标识,UUID格式,最大36个字符

defense_update_time

String

记录时间,格式ISO8601:YYYY-MM-DDTHH:mm:ss.ms+timezone。时区信息为事件发生时区,无法解析时区的时间,默认时区填东八区

defense_modifier_id

String

修改者ID

defense_modifier_name

String

修改者名称

defense_block_status

String

阻断状态

defense_connection_id

String

操作连接ID

defense_connection_name

String

操作连接名称

target_enterprise_id

String

企业项目ID

target_enterprise_name

String

企业项目名称

defense_policy_name

String

策略名称

defense_type

String

防线服务

defense_policy_list

Array of strings

防线策略真实ids

defense_connection_region_id

String

防线策略归属区域

sync_status

String

防线同步状态

响应参数

状态码:200

表7 响应Body参数

参数

参数类型

描述

code

String

错误码

data

String

任务id

message

String

错误信息

request_id

String

请求id

success

Boolean

请求状态

状态码:400

表8 响应Body参数

参数

参数类型

描述

code

String

参数解释:

错误码

取值范围:

不涉及

message

String

参数解释:

错误描述

取值范围:

不涉及

请求示例

/v1/3bb27e024693436da46b5f5aaf499060/workspaces/42713b38-d753-4365-8b4a-50d179e15747/soc/policys/1f051624-d255-4cd1-a724-f7841f5d8ca1

{
  "batch_ids" : [ "50c5feca-a6e8-4f16-9e00-df11568ec17f" ],
  "data_object" : {
    "defense_policy_list" : [ {
      "defense_connection_id" : "1d62c549-c0b9-32b7-9eaf-fdd0c1c7fab5",
      "defense_connection_name" : "WAF云服务认证凭据",
      "defense_type" : "WAF",
      "target_enterprise_id" : "0",
      "target_enterprise_name" : "default",
      "target_project_id" : "3bb27e024693436da46b5f5aaf499060",
      "target_project_name" : "cn-north-7",
      "defense_connection_region_id" : "cn-north-7",
      "defense_connection_region_name" : "xxxx"
    } ],
    "block_age" : {
      "is_block_ageing" : false,
      "block_ageing" : null
    },
    "labels" : "",
    "description" : ""
  }
}

响应示例

状态码:200

应急策略更新返回body体

{
  "code" : "00000000",
  "data" : "1f051624-d255-4cd1-a724-f7841f5d8ca1",
  "message" : "",
  "request_id" : "",
  "success" : true
}

状态码

状态码

描述

200

应急策略更新返回body体

400

应急策略更新错误返回body体

错误码

请参见错误码

相关文档