更新应急策略 - UpdatePolicy
功能介绍
更新单个应急策略,根据实际修改的属性更新,未修改的列不更新
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
PUT /v1/{project_id}/workspaces/{workspace_id}/soc/policys/{policy_id}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取项目ID 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
workspace_id |
是 |
String |
参数解释: 工作空间id。 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
policy_id |
是 |
String |
参数解释: 策略id 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。获取用户Token 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
content-type |
是 |
String |
参数解释: 内容类型
约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
x-secmaster-version |
是 |
String |
服务版本,例如25.5.0 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
batch_ids |
是 |
Array of strings |
应急策略的id集合 |
|
data_object |
否 |
Policy object |
策略实体信息(其他字段待数据类字段确定后补充) |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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 |
与操作连接对应的策略列表 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
错误码 |
|
data |
String |
任务id |
|
message |
String |
错误信息 |
|
request_id |
String |
请求id |
|
success |
Boolean |
请求状态 |
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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体 |
错误码
请参见错误码。