创建或更新修正配置
功能介绍
创建或更新合规规则修正配置。
调用方法
请参见如何调用API。
URI
PUT /v1/resource-manager/domains/{domain_id}/policy-assignments/{policy_assignment_id}/remediation-configuration
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
domain_id |
是 |
String |
账号ID。 最大长度：36 |
policy_assignment_id |
是 |
String |
规则ID。 最大长度：36 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
automatic |
否 |
Boolean |
是否为自动修正。 缺省值：false |
target_type |
是 |
String |
合规规则修正执行的方式。 |
target_id |
是 |
String |
修正执行的目标ID。如果修正方式为fgs，则该值为函数工作流的函数urn；如果修正方式为rfs，则该值为资源编排服务的模板name与版本号，两者以/分割，如果没有指定默认V1。 最大长度：512 |
static_parameter |
否 |
Array of RemediationStaticParameter objects |
修正执行的静态参数。 数组长度：0 - 50 |
resource_parameter |
是 |
RemediationResourceParameter object |
合规规则修正执行的动态参数。 |
maximum_attempts |
否 |
Integer |
指定时间内自动修正的最大尝试次数。 最小值：1 最大值：25 缺省值：5 |
retry_attempt_seconds |
否 |
Integer |
用于防止循环修正的时间窗口，如果在指定时间内进行了自动修正的最大尝试次数，则将资源添加至修正例外。 最小值：60 最大值：43200 缺省值：3600 |
auth_type |
否 |
String |
合规规则修正配置的权限方式。 |
auth_value |
否 |
String |
合规规则修正配置的权限信息。 最大长度：512 |
响应参数
状态码： 200
参数 |
参数类型 |
描述 |
|---|---|---|
automatic |
Boolean |
是否为自动修正。 |
target_type |
String |
合规规则修正执行的方式。 |
target_id |
String |
修正执行的目标ID。如果修正方式为fgs，则该值为函数工作流的函数urn；如果修正方式为rfs，则该值为资源编排服务的模板name与版本号，两者以/分割，如果没有指定默认V1。 最大长度：512 |
static_parameter |
Array of RemediationStaticParameter objects |
修正执行的参数。 数组长度：0 - 50 |
resource_parameter |
RemediationResourceParameter object |
合规规则修正执行的动态参数。 |
maximum_attempts |
Integer |
指定时间内自动修正的最大尝试次数。 最小值：1 最大值：25 缺省值：5 |
retry_attempt_seconds |
Integer |
用于防止循环修正的时间窗口，如果在指定时间内进行了自动修正的最大尝试次数，则将资源添加至修正例外。 最小值：60 最大值：3600 缺省值：60 |
auth_type |
String |
合规规则修正配置的权限方式。 |
auth_value |
String |
合规规则修正配置的权限信息。 最大长度：512 |
created_at |
String |
修正配置的创建时间。 |
updated_at |
String |
修正配置的更新时间。 |
created_by |
String |
创建者。 |
状态码： 400
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误消息内容。 |
状态码： 403
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误消息内容。 |
状态码： 404
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误消息内容。 |
状态码： 500
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误消息内容。 |
请求示例
创建合规规则修正配置
PUT https://{endpoint}/v1/resource-manager/domains/{domain_id}/policy-assignments/{policy_assignment_id}/remediation-configuration
{
"automatic" : false,
"target_type" : "fgs",
"target_id" : "urn:fss:region_id:project_id:function:default:function_name:latest",
"static_parameter" : [ {
"var_key" : "kms_id",
"var_value" : "kms12345678"
} ],
"resource_parameter" : [ {
"resourceId" : "file_prefix"
} ],
"maximum_attempts" : 5,
"retry_attempt_seconds" : 60,
"auth_type" : "agency",
"auth_value" : "agency_for_remediation"
}
响应示例
状态码： 200
操作成功。
{
"automatic" : false,
"target_type" : "fgs",
"target_id" : "urn:fss:region_id:project_id:function:default:function_name:latest",
"static_parameter" : [ {
"var_key" : "kms_id",
"var_value" : "kms12345678"
} ],
"resource_parameter" : [ {
"resourceId" : "file_prefix"
} ],
"maximum_attempts" : 5,
"retry_attempt_seconds" : 60,
"auth_type" : "agency",
"auth_value" : "agency_for_remediation",
"created_at" : "2024-01-17T09:39:19Z",
"updated_at" : "2024-01-17T09:39:19Z",
"created_by" : "custom"
}
状态码
状态码 |
描述 |
|---|---|
200 |
操作成功。 |
400 |
输入参数不合法。 |
403 |
用户身份认证失败。 |
404 |
资源未找到 |
500 |
服务器内部错误。 |
错误码
请参见错误码。
