Help Center/ Config/ API Reference/ APIs/ Compliance/ Collect Remediation Results
Updated on 2024-09-05 GMT+08:00

Collect Remediation Results

Function

This API is used to collect remediation results.

Calling Method

For details, see Calling APIs.

URI

POST /v1/resource-manager/domains/{domain_id}/policy-assignments/{policy_assignment_id}/remediation-execution-statuses/summary

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

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

Specifies the maximum number of records to return.

Minimum: 1

Maximum: 200

Default: 200

marker

No

String

Specifies the pagination parameter.

Minimum: 4

Maximum: 400

Request Parameters

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

resource_keys

Yes

Array of RemediationResourceKey objects

A list of query criteria required to collect remediation results.

Array Length: 0 - 100

Table 4 RemediationResourceKey

Parameter

Mandatory

Type

Description

resource_id

Yes

String

Resource ID.

Minimum: 1

Maximum: 512

resource_provider

Yes

String

Cloud service name, to be compatible with some policyState where the cloud service name is empty in the compliance result, the value can be an empty string.

Minimum: 0

Maximum: 128

resource_type

Yes

String

Resource type, to be compatible with some policyState where the resource type is empty in the compliance result, the value can be an empty string.

Minimum: 0

Maximum: 128

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

value

Array of RemediationExecutionStatus objects

Detailed correction result list.

page_info

PageInfo object

Specifies the pagination object.

Table 6 RemediationExecutionStatus

Parameter

Type

Description

resource_key

RemediationResourceKey object

Details about the query criteria for remediation results.

invocation_time

String

The start time of remediation.

state

String

Execution result of remediation.

message

String

Information of remediation execution.

Table 7 RemediationResourceKey

Parameter

Type

Description

resource_id

String

Resource ID.

Minimum: 1

Maximum: 512

resource_provider

String

Cloud service name, to be compatible with some policyState where the cloud service name is empty in the compliance result, the value can be an empty string.

Minimum: 0

Maximum: 128

resource_type

String

Resource type, to be compatible with some policyState where the resource type is empty in the compliance result, the value can be an empty string.

Minimum: 0

Maximum: 128

Table 8 PageInfo

Parameter

Type

Description

current_count

Integer

Specifies the resource quantity on the current page.

Minimum: 0

Maximum: 200

next_marker

String

Specifies the marker value of the next page.

Minimum: 4

Maximum: 400

Status code: 400

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Specifies the error code.

error_msg

String

Specifies the error message.

Status code: 403

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Specifies the error code.

error_msg

String

Specifies the error message.

Status code: 404

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Specifies the error code.

error_msg

String

Specifies the error message.

Status code: 500

Table 12 Response body parameters

Parameter

Type

Description

error_code

String

Specifies the error code.

error_msg

String

Specifies the error message.

Example Requests

Collects remediation results for the specified resource.

POST https://{endpoint}/v1/resource-manager/domains/{domain_id}/policy-assignments/{policy_assignment_id}/remediation-execution-statuses/summary

{
  "resource_keys" : [ {
    "resource_id" : "resource_id_1",
    "resource_provider" : "resource_provider_1",
    "resource_type" : "resource_type_1"
  }, {
    "resource_id" : "resource_id_2",
    "resource_provider" : "resource_provider_2",
    "resource_type" : "resource_type_2"
  } ]
}

Example Responses

Status code: 200

Operation succeeded.

{
  "value" : [ {
    "resource_key" : {
      "resource_id" : "resource_id1",
      "resource_provider" : "resource_provider1",
      "resource_type" : "resource_type1"
    },
    "invocation_time" : "2024-01-17T09:39:19Z",
    "state" : "SUCCEEDED",
    "message" : "Execution success."
  }, {
    "resource_key" : {
      "resource_id" : "resource_id1",
      "resource_provider" : "resource_provider2",
      "resource_type" : "resource_type2"
    },
    "invocation_time" : "2024-01-17T09:41:20Z",
    "state" : "FAILED",
    "message" : "You do not have the permission to invoke functionGraph."
  } ],
  "page_info" : {
    "current_count" : 2,
    "next_marker" : null
  }
}

SDK Sample Code

The SDK sample code is as follows.

Collects remediation results for the specified resource.

 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
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 CollectRemediationExecutionStatusesSummarySolution {

    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();
        CollectRemediationExecutionStatusesSummaryRequest request = new CollectRemediationExecutionStatusesSummaryRequest();
        request.withLimit(<limit>);
        request.withMarker("<marker>");
        RemediationExecutionStatusesSummaryRequestBody body = new RemediationExecutionStatusesSummaryRequestBody();
        List<RemediationResourceKey> listbodyResourceKeys = new ArrayList<>();
        listbodyResourceKeys.add(
            new RemediationResourceKey()
                .withResourceId("resource_id_1")
                .withResourceProvider("resource_provider_1")
                .withResourceType("resource_type_1")
        );
        listbodyResourceKeys.add(
            new RemediationResourceKey()
                .withResourceId("resource_id_2")
                .withResourceProvider("resource_provider_2")
                .withResourceType("resource_type_2")
        );
        body.withResourceKeys(listbodyResourceKeys);
        request.withBody(body);
        try {
            CollectRemediationExecutionStatusesSummaryResponse response = client.collectRemediationExecutionStatusesSummary(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());
        }
    }
}

Collects remediation results for the specified resource.

 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 = CollectRemediationExecutionStatusesSummaryRequest()
        request.limit = <limit>
        request.marker = "<marker>"
        listResourceKeysbody = [
            RemediationResourceKey(
                resource_id="resource_id_1",
                resource_provider="resource_provider_1",
                resource_type="resource_type_1"
            ),
            RemediationResourceKey(
                resource_id="resource_id_2",
                resource_provider="resource_provider_2",
                resource_type="resource_type_2"
            )
        ]
        request.body = RemediationExecutionStatusesSummaryRequestBody(
            resource_keys=listResourceKeysbody
        )
        response = client.collect_remediation_execution_statuses_summary(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Collects remediation results for the specified resource.

 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
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.CollectRemediationExecutionStatusesSummaryRequest{}
	limitRequest:= int32(<limit>)
	request.Limit = &limitRequest
	markerRequest:= "<marker>"
	request.Marker = &markerRequest
	var listResourceKeysbody = []model.RemediationResourceKey{
        {
            ResourceId: "resource_id_1",
            ResourceProvider: "resource_provider_1",
            ResourceType: "resource_type_1",
        },
        {
            ResourceId: "resource_id_2",
            ResourceProvider: "resource_provider_2",
            ResourceType: "resource_type_2",
        },
    }
	request.Body = &model.RemediationExecutionStatusesSummaryRequestBody{
		ResourceKeys: listResourceKeysbody,
	}
	response, err := client.CollectRemediationExecutionStatusesSummary(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

Forbidden

404

Resources not found.

500

Internal server error.

Error Codes

See Error Codes.