Help Center/ Config/ API Reference/ APIs/ Compliance/ Setting up or Updating Remediation Configurations
Updated on 2024-07-10 GMT+08:00

Setting up or Updating Remediation Configurations

Function

This API is used to set up or update remediation configurations.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

domain_id

Yes

String

Specifies tags.

Maximum: 36

policy_assignment_id

Yes

String

Specifies the rule ID.

Maximum: 36

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

automatic

No

Boolean

Whether remediation is automatic.

Default: false

target_type

Yes

String

Execution method of remediation.

target_id

Yes

String

The ID of a remediation object. If the execution method is fgs, the value is a function URN. If the execution method is rfs, the value is the name and version ID that separated by a slash (/). If the version is not specified, V1 is used by default.

Maximum: 512

static_parameter

No

Array of RemediationStaticParameter objects

Static parameter of remediation.

Array Length: 0 - 50

resource_parameter

Yes

RemediationResourceParameter object

Dynamic parameter of remediation.

maximum_attempts

No

Integer

Maximum number of retries allowed within a specified period.

Minimum: 1

Maximum: 25

Default: 5

retry_attempt_seconds

No

Integer

Used to avoid an infinite loop. If remediation retries exceed the limit, corresponding resources will be classified as exceptions of remediation.

Minimum: 60

Maximum: 43200

Default: 3600

auth_type

No

String

Authorization type for remediation configurations.

auth_value

No

String

Execution method of remediation.

Maximum: 512

Table 3 RemediationStaticParameter

Parameter

Mandatory

Type

Description

var_key

No

String

Parameter name.

Minimum: 1

Maximum: 64

var_value

No

Object

Parameter value.

Table 4 RemediationResourceParameter

Parameter

Mandatory

Type

Description

resource_id

Yes

String

The parameter name for passing the resource ID.

Minimum: 1

Maximum: 64

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

automatic

Boolean

Whether remediation is automatic.

target_type

String

Execution method of remediation.

target_id

String

The ID of a remediation object. If the execution method is fgs, the value is a function URN. If the execution method is rfs, the value is the name and version ID that separated by a slash (/). If the version is not specified, V1 is used by default.

Maximum: 512

static_parameter

Array of RemediationStaticParameter objects

Parameters for remediation execution.

Array Length: 0 - 50

resource_parameter

RemediationResourceParameter object

Dynamic parameter of remediation.

maximum_attempts

Integer

Maximum number of retries allowed within a specified period.

Minimum: 1

Maximum: 25

Default: 5

retry_attempt_seconds

Integer

Used to avoid an infinite loop. If remediation retries exceed the limit, corresponding resources will be classified as exceptions of remediation.

Minimum: 60

Maximum: 3600

Default: 60

auth_type

String

Authorization type for remediation configurations.

auth_value

String

Information of dependent service authorization.

Maximum: 512

created_at

String

The time when remediation configurations are set up.

updated_at

String

The time when remediation configurations are updated.

created_by

String

Creator of remediation.

Table 6 RemediationStaticParameter

Parameter

Type

Description

var_key

String

Parameter name.

Minimum: 1

Maximum: 64

var_value

Object

Parameter value.

Table 7 RemediationResourceParameter

Parameter

Type

Description

resource_id

String

The parameter name for passing the resource ID.

Minimum: 1

Maximum: 64

Status code: 400

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Specifies the error code.

error_msg

String

Specifies the error message.

Status code: 403

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Specifies the error code.

error_msg

String

Specifies the error message.

Status code: 404

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Specifies the error code.

error_msg

String

Specifies the error message.

Status code: 500

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Specifies the error code.

error_msg

String

Specifies the error message.

Example Requests

This API is used to set up or update remediation configurations.

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"
}

Example Responses

Status code: 200

Operation succeeded.

{
  "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 Sample Code

The SDK sample code is as follows.

This API is used to set up or update remediation configurations.

 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
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();
        RemediationConfigurationRequestBody body = new RemediationConfigurationRequestBody();
        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("[{\"resource_id\":\"file_prefix\"}]");
        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());
        }
    }
}

This API is used to set up or update remediation configurations.

 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
# 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()
        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="[{\"resource_id\":\"file_prefix\"}]",
            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)

This API is used to set up or update remediation configurations.

 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
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 := global.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := config.NewConfigClient(
        config.ConfigClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CreateOrUpdateRemediationConfigurationRequest{}
	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)
	var resourceParameterResourceParameter interface{} = "[{\"resource_id\":\"file_prefix\"}]"
	automaticRemediationConfigurationRequestBody:= false
	request.Body = &model.RemediationConfigurationRequestBody{
		AuthValue: &authValueRemediationConfigurationRequestBody,
		AuthType: &authTypeRemediationConfigurationRequestBody,
		RetryAttemptSeconds: &retryAttemptSecondsRemediationConfigurationRequestBody,
		MaximumAttempts: &maximumAttemptsRemediationConfigurationRequestBody,
		ResourceParameter: &resourceParameterResourceParameter,
		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)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Operation succeeded.

400

Invalid parameters.

403

Authentication failed.

404

Resources not found.

500

Internal server error.

Error Codes

See Error Codes.