文档首页> 配置审计 Config> API参考> API> 合规性> 更新合规评估结果
更新时间:2024-03-18 GMT+08:00

更新合规评估结果

功能介绍

更新用户自定义合规规则的合规评估结果。

调用方法

请参见如何调用API

URI

PUT /v1/resource-manager/domains/{domain_id}/policy-states

表1 路径参数

参数

是否必选

参数类型

描述

domain_id

String

账号ID。

最大长度:36

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

调用者token。

X-Security-Token

String

如果正在使用临时安全凭据,则此header是必需的,该值是临时安全凭据的安全令牌(会话令牌)。

表3 请求Body参数

参数

是否必选

参数类型

描述

policy_resource

PolicyResource object

资源。

trigger_type

String

触发器类型。

compliance_state

String

合规结果。

policy_assignment_id

String

规则ID。

policy_assignment_name

String

规则名称。

evaluation_time

String

合规状态评估时间。

evaluation_hash

String

评估校验码。

表4 PolicyResource

参数

是否必选

参数类型

描述

resource_id

String

资源ID。

resource_name

String

资源名称。

resource_provider

String

云服务名称。

resource_type

String

资源类型。

region_id

String

区域ID。

domain_id

String

资源所属用户ID。

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

domain_id

String

用户ID。

region_id

String

资源区域ID。

resource_id

String

资源ID。

resource_name

String

资源名称。

resource_provider

String

云服务名称。

resource_type

String

资源类型。

trigger_type

String

触发器类型,可选值为"resource"和"period"。

compliance_state

String

合规结果。

policy_assignment_id

String

规则ID。

policy_assignment_name

String

规则名称。

policy_definition_id

String

策略ID。

evaluation_time

String

合规状态评估时间。

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息内容。

状态码: 403

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息内容。

状态码: 500

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息内容。

请求示例

functionGraph上报合规评估结果为“NonCompliant”。

PUT https://{endpoint}/v1/resource-manager/domains/{domain_id}/policy-states

{
  "policy_resource" : {
    "domain_id" : "d0123456789",
    "region_id" : "global",
    "resource_id" : "abc0123456789",
    "resource_name" : "test_user",
    "resource_provider" : "iam",
    "resource_type" : "users"
  },
  "trigger_type" : "resource",
  "compliance_state" : "NonCompliant",
  "policy_assignment_id" : "abc0123456789abc",
  "policy_assignment_name" : "custom_policy",
  "evaluation_time" : 1667374060248,
  "evaluation_hash" : "89342b8f338165651991afb8bd471396"
}

响应示例

状态码: 200

操作成功。

{
  "domain_id" : "d0123456789",
  "region_id" : "global",
  "resource_id" : "abc0123456789",
  "resource_name" : "test_user",
  "resource_provider" : "iam",
  "resource_type" : "users",
  "trigger_type" : "resource",
  "compliance_state" : "NonCompliant",
  "policy_assignment_id" : "abc0123456789abc",
  "policy_assignment_name" : "custom_policy",
  "policy_definition_id" : null,
  "evaluation_time" : 1667374060248
}

SDK代码示例

SDK代码示例如下。

functionGraph上报合规评估结果为“NonCompliant”。

 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 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.*;


public class UpdatePolicyStateSolution {

    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();
        UpdatePolicyStateRequest request = new UpdatePolicyStateRequest();
        PolicyStateRequestBody body = new PolicyStateRequestBody();
        PolicyResource policyResourcebody = new PolicyResource();
        policyResourcebody.withResourceId("abc0123456789")
            .withResourceName("test_user")
            .withResourceProvider("iam")
            .withResourceType("users")
            .withRegionId("global")
            .withDomainId("d0123456789");
        body.withEvaluationHash("89342b8f338165651991afb8bd471396");
        body.withEvaluationTime("1667374060248");
        body.withPolicyAssignmentName("custom_policy");
        body.withPolicyAssignmentId("abc0123456789abc");
        body.withComplianceState(PolicyStateRequestBody.ComplianceStateEnum.fromValue("NonCompliant"));
        body.withTriggerType(PolicyStateRequestBody.TriggerTypeEnum.fromValue("resource"));
        body.withPolicyResource(policyResourcebody);
        request.withBody(body);
        try {
            UpdatePolicyStateResponse response = client.updatePolicyState(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());
        }
    }
}

functionGraph上报合规评估结果为“NonCompliant”。

 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
# coding: utf-8

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 = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("CLOUD_SDK_SK")

    credentials = GlobalCredentials(ak, sk) \

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

    try:
        request = UpdatePolicyStateRequest()
        policyResourcebody = PolicyResource(
            resource_id="abc0123456789",
            resource_name="test_user",
            resource_provider="iam",
            resource_type="users",
            region_id="global",
            domain_id="d0123456789"
        )
        request.body = PolicyStateRequestBody(
            evaluation_hash="89342b8f338165651991afb8bd471396",
            evaluation_time="1667374060248",
            policy_assignment_name="custom_policy",
            policy_assignment_id="abc0123456789abc",
            compliance_state="NonCompliant",
            trigger_type="resource",
            policy_resource=policyResourcebody
        )
        response = client.update_policy_state(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

functionGraph上报合规评估结果为“NonCompliant”。

 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
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.UpdatePolicyStateRequest{}
	resourceIdPolicyResource:= "abc0123456789"
	resourceNamePolicyResource:= "test_user"
	resourceProviderPolicyResource:= "iam"
	resourceTypePolicyResource:= "users"
	regionIdPolicyResource:= "global"
	domainIdPolicyResource:= "d0123456789"
	policyResourcebody := &model.PolicyResource{
		ResourceId: &resourceIdPolicyResource,
		ResourceName: &resourceNamePolicyResource,
		ResourceProvider: &resourceProviderPolicyResource,
		ResourceType: &resourceTypePolicyResource,
		RegionId: &regionIdPolicyResource,
		DomainId: &domainIdPolicyResource,
	}
	policyAssignmentNamePolicyStateRequestBody:= "custom_policy"
	request.Body = &model.PolicyStateRequestBody{
		EvaluationHash: "89342b8f338165651991afb8bd471396",
		EvaluationTime: "1667374060248",
		PolicyAssignmentName: &policyAssignmentNamePolicyStateRequestBody,
		PolicyAssignmentId: "abc0123456789abc",
		ComplianceState: model.GetPolicyStateRequestBodyComplianceStateEnum().NON_COMPLIANT,
		TriggerType: model.GetPolicyStateRequestBodyTriggerTypeEnum().RESOURCE,
		PolicyResource: policyResourcebody,
	}
	response, err := client.UpdatePolicyState(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

操作成功。

400

输入参数不合法。

403

用户认证失败或无操作权限。

500

服务器内部错误。

错误码

请参见错误码