文档首页/ 配置审计 Config/ API参考/ API/ 合规性/ 创建或更新修正配置 - CreateOrUpdateRemediationConfiguration
更新时间:2026-05-12 GMT+08:00
分享

创建或更新修正配置 - CreateOrUpdateRemediationConfiguration

功能介绍

创建或更新合规规则修正配置。

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    rms:policyAssignmentsRemediation:putRemediationConfiguration

    Write

    policyAssignmentsRemediation *

    -

    -

    • iam:agencies:pass
    • iam:agencies:createServiceLinkedAgencyV5

URI

PUT /v1/resource-manager/domains/{domain_id}/policy-assignments/{policy_assignment_id}/remediation-configuration

表1 路径参数

参数

是否必选

参数类型

描述

domain_id

String

参数解释

账号ID。

约束限制

不涉及

取值范围

只能由英文字母、数字及“_”、“-”组成,且长度为[1~36]个字符。

默认取值

不涉及

最大长度:36

policy_assignment_id

String

参数解释

规则ID。

约束限制

不涉及

取值范围

只能由英文字母、数字及“_”、“-”组成,且长度为[1~36]个字符

默认取值

不涉及

最大长度:36

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

automatic

Boolean

参数解释

是否为自动修正。

约束限制

不涉及

取值范围

  • false:非自动修正

  • true:自动修正

默认取值

false

缺省值:false

target_type

String

参数解释

合规规则修正执行的方式。

约束限制

不涉及

取值范围

  • fgs:函数工作流

  • rfs:资源编排服务

默认取值

不涉及

target_id

String

参数解释

修正执行的目标ID。

约束限制

如果修正方式为fgs,则该值为函数工作流的函数urn;如果修正方式为rfs,则该值为资源编排服务的模板name与版本号,两者以/分隔。

取值范围

长度为[1~512]个字符

默认取值

不涉及

最大长度:512

target_region_id

String

参数解释

修正执行的目标的regionId。

约束限制

如果修正方式为RFS,该字段为空则Config服务会默认配置北京四(中国站)或香港一(国际站)的regionId;如果修正方式为FGS,该字段为空则Config服务会根据实例urn自动配置。指定target_project_id字段则该字段必选。

取值范围

只能由英文字母、数字及“_”、“-”组成,且长度为[1~36]个字符

默认取值

不涉及

最小长度:1

最大长度:36

target_project_id

String

参数解释

修正执行的目标的projectId。

约束限制

如果修正方式为RFS,该字段为空则Config服务会默认配置北京四(中国站)或香港一(国际站)的主projectId;如果修正方式为FGS,该字段为空则Config服务会根据实例urn自动配置。指定target_region_id字段则该字段必选。

取值范围

只能由英文字母、数字及“_”、“-”组成,且长度为[1~36]个字符

默认取值

不涉及

最小长度:1

最大长度:36

static_parameter

Array of RemediationStaticParameter objects

参数解释

修正执行的静态参数。

约束限制

不涉及

数组长度:0 - 50

resource_parameter

RemediationResourceParameter object

参数解释

合规规则修正执行的动态参数。

约束限制

不涉及

maximum_attempts

Integer

参数解释

指定时间内修正的最大尝试次数。

约束限制

不涉及

取值范围

1-25

默认取值

5

最小值:1

最大值:25

缺省值:5

retry_attempt_seconds

Integer

参数解释

用于防止循环修正的时间窗口,如果在指定时间内进行了自动修正的最大尝试次数,则将资源添加至修正例外。

约束限制

不涉及

取值范围

60-43200

默认取值

3600

最小值:60

最大值:43200

缺省值:3600

auth_type

String

参数解释

合规规则修正配置的权限方式。

约束限制

如果为自动修正且修正方式为RFS,该字段必须配置

取值范围

  • agency:委托

  • trustAgency:信任委托

默认取值

不涉及

auth_value

String

参数解释

合规规则修正配置的权限信息。

约束限制

如果为自动修正且修正方式为RFS,该字段必须配置

取值范围

长度为[1~512]个字符

默认取值

不涉及

最大长度:512

表3 RemediationStaticParameter

参数

是否必选

参数类型

描述

var_key

String

参数解释

参数名称。

约束限制

不涉及

取值范围

只能由英文字母、数字及“_”、“-”组成,且长度为[1~64]个字符

默认取值

不涉及

最小长度:1

最大长度:64

var_value

Object

参数解释

参数的值。

约束限制

不涉及

表4 RemediationResourceParameter

参数

是否必选

参数类型

描述

resource_id

String

参数解释

传入resourceID的参数名称。

约束限制

不涉及

取值范围

只能由英文字母、数字及“_”、“-”组成,且长度为[1~64]个字符

默认取值

不涉及

最小长度:1

最大长度:64

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

automatic

Boolean

参数解释

是否为自动修正。

取值范围

  • false:非自动修正

  • true:自动修正

target_type

String

参数解释

合规规则修正执行的方式。

取值范围

  • fgs:函数工作流

  • rfs:资源编排服务

target_id

String

参数解释

修正执行的目标ID。

取值范围

长度为[1~512]个字符

最大长度:512

target_region_id

String

参数解释

修正执行的目标的regionId。

取值范围

只能由英文字母、数字及“_”、“-”组成,且长度为[1~36]个字符

target_project_id

String

参数解释

修正执行的目标的projectId。

取值范围

只能由英文字母、数字及“_”、“-”组成,且长度为[1~36]个字符

static_parameter

Array of RemediationStaticParameter objects

参数解释

修正执行的参数。

数组长度:0 - 50

resource_parameter

RemediationResourceParameter object

参数解释

合规规则修正执行的动态参数。

约束限制

不涉及

maximum_attempts

Integer

参数解释

指定时间内修正的最大尝试次数。

取值范围

1-25

最小值:1

最大值:25

缺省值:5

retry_attempt_seconds

Integer

参数解释

用于防止循环修正的时间窗口,如果在指定时间内进行了自动修正的最大尝试次数,则将资源添加至修正例外。

取值范围

60-43200

最小值:60

最大值:43200

缺省值:3600

auth_type

String

参数解释

合规规则修正配置的权限方式。

取值范围

  • agency:委托

  • trustAgency:信任委托

auth_value

String

参数解释

合规规则修正配置的权限信息。

取值范围

长度为[1~512]个字符

最大长度:512

created_at

String

参数解释

修正配置的创建时间。

取值范围

不涉及

updated_at

String

参数解释

修正配置的更新时间。

取值范围

不涉及

created_by

String

参数解释

创建者。

取值范围

不涉及

表6 RemediationStaticParameter

参数

参数类型

描述

var_key

String

参数解释

参数名称。

约束限制

不涉及

取值范围

只能由英文字母、数字及“_”、“-”组成,且长度为[1~64]个字符

默认取值

不涉及

最小长度:1

最大长度:64

var_value

Object

参数解释

参数的值。

约束限制

不涉及

表7 RemediationResourceParameter

参数

参数类型

描述

resource_id

String

参数解释

传入resourceID的参数名称。

约束限制

不涉及

取值范围

只能由英文字母、数字及“_”、“-”组成,且长度为[1~64]个字符

默认取值

不涉及

最小长度:1

最大长度:64

状态码:400

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码。

取值范围

不涉及

error_msg

String

参数解释

错误消息内容。

取值范围

不涉及

状态码:403

表9 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码。

取值范围

不涉及

error_msg

String

参数解释

错误消息内容。

取值范围

不涉及

状态码:404

表10 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

错误码。

取值范围

不涉及

error_msg

String

参数解释

错误消息内容。

取值范围

不涉及

状态码:500

表11 响应Body参数

参数

参数类型

描述

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" : {
    "resource_id" : "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" : {
    "resource_id" : "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"
}

SDK代码示例

SDK代码示例如下。

创建合规规则修正配置

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.GlobalCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.config.v1.region.ConfigRegion;
import com.huaweicloud.sdk.config.v1.*;
import com.huaweicloud.sdk.config.v1.model.*;

import java.util.List;
import java.util.ArrayList;

public class CreateOrUpdateRemediationConfigurationSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new GlobalCredentials()
                .withAk(ak)
                .withSk(sk);

        ConfigClient client = ConfigClient.newBuilder()
                .withCredential(auth)
                .withRegion(ConfigRegion.valueOf("<YOUR REGION>"))
                .build();
        CreateOrUpdateRemediationConfigurationRequest request = new CreateOrUpdateRemediationConfigurationRequest();
        request.withPolicyAssignmentId("{policy_assignment_id}");
        RemediationConfigurationRequestBody body = new RemediationConfigurationRequestBody();
        RemediationResourceParameter resourceParameterbody = new RemediationResourceParameter();
        resourceParameterbody.withResourceId("file_prefix");
        List<RemediationStaticParameter> listbodyStaticParameter = new ArrayList<>();
        listbodyStaticParameter.add(
            new RemediationStaticParameter()
                .withVarKey("kms_id")
                .withVarValue("kms12345678")
        );
        body.withAuthValue("agency_for_remediation");
        body.withAuthType(RemediationConfigurationRequestBody.AuthTypeEnum.fromValue("agency"));
        body.withRetryAttemptSeconds(60);
        body.withMaximumAttempts(5);
        body.withResourceParameter(resourceParameterbody);
        body.withStaticParameter(listbodyStaticParameter);
        body.withTargetId("urn:fss:region_id:project_id:function:default:function_name:latest");
        body.withTargetType(RemediationConfigurationRequestBody.TargetTypeEnum.fromValue("fgs"));
        body.withAutomatic(false);
        request.withBody(body);
        try {
            CreateOrUpdateRemediationConfigurationResponse response = client.createOrUpdateRemediationConfiguration(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

创建合规规则修正配置

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import GlobalCredentials
from huaweicloudsdkconfig.v1.region.config_region import ConfigRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkconfig.v1 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]

    credentials = GlobalCredentials(ak, sk)

    client = ConfigClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(ConfigRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreateOrUpdateRemediationConfigurationRequest()
        request.policy_assignment_id = "{policy_assignment_id}"
        resourceParameterbody = RemediationResourceParameter(
            resource_id="file_prefix"
        )
        listStaticParameterbody = [
            RemediationStaticParameter(
                var_key="kms_id",
                var_value="kms12345678"
            )
        ]
        request.body = RemediationConfigurationRequestBody(
            auth_value="agency_for_remediation",
            auth_type="agency",
            retry_attempt_seconds=60,
            maximum_attempts=5,
            resource_parameter=resourceParameterbody,
            static_parameter=listStaticParameterbody,
            target_id="urn:fss:region_id:project_id:function:default:function_name:latest",
            target_type="fgs",
            automatic=False
        )
        response = client.create_or_update_remediation_configuration(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

创建合规规则修正配置

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global"
    config "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/config/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/config/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/config/v1/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth, err := global.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := config.ConfigClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := config.NewConfigClient(hcClient)

    request := &model.CreateOrUpdateRemediationConfigurationRequest{}
	request.PolicyAssignmentId = "{policy_assignment_id}"
	resourceParameterbody := &model.RemediationResourceParameter{
		ResourceId: "file_prefix",
	}
	varKeyStaticParameter:= "kms_id"
	varValueStaticParameter:= "kms12345678"
	var varValueStaticParameterInterface interface{} = varValueStaticParameter
	var listStaticParameterbody = []model.RemediationStaticParameter{
        {
            VarKey: &varKeyStaticParameter,
            VarValue: &varValueStaticParameterInterface,
        },
    }
	authValueRemediationConfigurationRequestBody:= "agency_for_remediation"
	authTypeRemediationConfigurationRequestBody:= model.GetRemediationConfigurationRequestBodyAuthTypeEnum().AGENCY
	retryAttemptSecondsRemediationConfigurationRequestBody:= int32(60)
	maximumAttemptsRemediationConfigurationRequestBody:= int32(5)
	automaticRemediationConfigurationRequestBody:= false
	request.Body = &model.RemediationConfigurationRequestBody{
		AuthValue: &authValueRemediationConfigurationRequestBody,
		AuthType: &authTypeRemediationConfigurationRequestBody,
		RetryAttemptSeconds: &retryAttemptSecondsRemediationConfigurationRequestBody,
		MaximumAttempts: &maximumAttemptsRemediationConfigurationRequestBody,
		ResourceParameter: resourceParameterbody,
		StaticParameter: &listStaticParameterbody,
		TargetId: "urn:fss:region_id:project_id:function:default:function_name:latest",
		TargetType: model.GetRemediationConfigurationRequestBodyTargetTypeEnum().FGS,
		Automatic: &automaticRemediationConfigurationRequestBody,
	}
	response, err := client.CreateOrUpdateRemediationConfiguration(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

操作成功。

400

输入参数不合法。

403

用户身份认证失败。

404

资源未找到

500

服务器内部错误。

错误码

请参见错误码

相关文档