新建集群防护策略 - CreateClusterProtectionPolicy
功能介绍
新建集群防护策略
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
URI
POST /v5/{project_id}/cluster-protect/policy
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
enterprise_project_id |
否 |
String |
参数解释: 企业项目ID，用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID。 如需查询所有企业项目下的资产请传参“all_granted_eps”。 约束限制: 开通企业项目功能后才需要配置企业项目ID参数。 取值范围: 字符长度1-256位 默认取值: 0，表示默认企业项目（default）。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token，包含了用户的身份、权限等信息，在调用API接口时，可通过Token进行身份认证。获取方式请参见获取用户Token。 约束限制: 不涉及 取值范围: 字符长度1-32768位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
policy_name |
是 |
String |
策略名称 |
|
policy_id |
是 |
String |
策略ID |
|
template_id |
是 |
String |
模板ID |
|
policy_description |
是 |
String |
策略描述 |
|
content |
是 |
PolicyContent object |
策略内容 |
|
white_image_list |
是 |
Array of WhiteImageInfo objects |
白名单镜像 |
|
resources |
是 |
Array of PolicyProtectScope objects |
防护的资源信息 |
|
parameters |
是 |
String |
策略参数值 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
enable_image_startup |
是 |
Boolean |
是否允许未扫描镜像启动 |
|
policy_type |
是 |
String |
告警策略:
|
|
severity |
是 |
Integer |
风险等级 |
|
risky_item |
是 |
Array of strings |
危险项 |
|
action |
是 |
Integer |
防护动作
|
响应参数
状态码：200
请求已成功
无
请求示例
新建集群防护策略
POST https://{endpoint}/v5/{project_id}/cluster-protect/policy?enterprise_project_id=all_granted_eps
{
"policy_name" : "string",
"policy_id" : "string",
"template_id" : "string",
"policy_description" : "string",
"content" : {
"enable_image_startup" : true,
"policy_type" : "string",
"severity" : 0,
"risky_item" : [ "string" ],
"action" : 0
},
"white_image_list" : [ {
"cluster_id" : "string",
"image_name" : "string",
"image_version" : "string"
} ],
"resources" : [ {
"cluster_name" : "string",
"cluster_id" : "string",
"images" : [ "string" ],
"namespaces" : [ "string" ],
"labels" : [ "string" ]
} ]
}
响应示例
无
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
错误码
请参见错误码。
