更新时间:2024-10-22 GMT+08:00
分享

创建合规规则

功能介绍

创建新的合规规则。

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

domain_id

String

账号ID。

最大长度:36

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

调用者token。

X-Security-Token

String

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

表3 请求Body参数

参数

是否必选

参数类型

描述

policy_assignment_type

String

规则类型,包括预定义合规规则(builtin)和用户自定义合规规则(custom),不填则默认为预定义合规规则(builtin)

name

String

规则名称。

最大长度:64

description

String

规则描述。

最大长度:512

period

String

触发周期

policy_filter

PolicyFilterDefinition object

规则过滤器。

policy_definition_id

String

策略定义ID

最大长度:36

custom_policy

CustomPolicy object

自定义合规规则

parameters

Map<String,PolicyParameterValue>

规则参数。

tags

Array of ResourceTag objects

标签列表

表4 PolicyFilterDefinition

参数

是否必选

参数类型

描述

region_id

String

区域ID。

最大长度:128

resource_provider

String

云服务名称。

最大长度:128

resource_type

String

资源类型。

最大长度:128

resource_id

String

资源ID。

最大长度:512

tag_key

String

标签键。

最大长度:128

tag_value

String

标签值。

最大长度:256

表5 CustomPolicy

参数

是否必选

参数类型

描述

function_urn

String

自定义函数的URN

最大长度:1024

auth_type

String

自定义合规规则调用function方式

auth_value

Map<String,Object>

自定义合规规则调用function方式的参数值

表6 PolicyParameterValue

参数

是否必选

参数类型

描述

value

Object

规则参数值。

表7 ResourceTag

参数

是否必选

参数类型

描述

key

String

键。最大长度128个unicode字符。 key符合3.1 KEY字符集规范。

最小长度:1

最大长度:128

value

String

值。每个值最大长度255个unicode字符。value符合3.2 VALUE字符集规范。

最小长度:0

最大长度:255

响应参数

状态码: 200

表8 响应Body参数

参数

参数类型

描述

policy_assignment_type

String

规则类型,包括预定义合规规则(builtin)和用户自定义合规规则(custom)

id

String

规则ID。

name

String

规则名称。

description

String

规则描述。

policy_filter

PolicyFilterDefinition object

规则过滤器。

period

String

周期值,可选值:One_Hour, Three_Hours, Six_Hours, Twelve_Hours, TwentyFour_Hours

state

String

规则状态。

created

String

规则创建时间。

updated

String

规则更新时间。

policy_definition_id

String

规则的策略ID。

custom_policy

CustomPolicy object

自定义合规规则

parameters

Map<String,PolicyParameterValue>

规则参数。

tags

Array of ResourceTag objects

标签列表

created_by

String

规则的创建者

target_type

String

合规规则修正方式。

target_id

String

修正执行的目标id。

表9 PolicyFilterDefinition

参数

参数类型

描述

region_id

String

区域ID。

最大长度:128

resource_provider

String

云服务名称。

最大长度:128

resource_type

String

资源类型。

最大长度:128

resource_id

String

资源ID。

最大长度:512

tag_key

String

标签键。

最大长度:128

tag_value

String

标签值。

最大长度:256

表10 CustomPolicy

参数

参数类型

描述

function_urn

String

自定义函数的URN

最大长度:1024

auth_type

String

自定义合规规则调用function方式

auth_value

Map<String,Object>

自定义合规规则调用function方式的参数值

表11 PolicyParameterValue

参数

参数类型

描述

value

Object

规则参数值。

表12 ResourceTag

参数

参数类型

描述

key

String

键。最大长度128个unicode字符。 key符合3.1 KEY字符集规范。

最小长度:1

最大长度:128

value

String

值。每个值最大长度255个unicode字符。value符合3.2 VALUE字符集规范。

最小长度:0

最大长度:255

状态码: 400

表13 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息内容。

状态码: 403

表14 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息内容。

状态码: 500

表15 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息内容。

请求示例

创建一个名为“allowed-images-by-id”的合规规则。

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

{
  "name" : "allowed-images-by-id",
  "description" : "The ECS resource is non-compliant if the image it used is not in the allowed list",
  "parameters" : {
    "listOfAllowedImages" : {
      "value" : [ "ea0d6e0e-99c3-406d-a873-3bb45462b624" ]
    }
  },
  "policy_filter" : {
    "resource_provider" : "ecs",
    "resource_type" : "cloudservers"
  },
  "policy_definition_id" : "5f3c8b9a9811a13739a32ed9",
  "tags" : [ {
    "key" : "tagkey",
    "value" : "tagValue"
  } ]
}

响应示例

状态码: 200

操作成功。

{
  "policy_assignment_type" : "builtin",
  "id" : "5fb76a240f2daf0b9662a04d",
  "name" : "volume-inuse-check",
  "description" : "云硬盘未挂载给任何云服务器,视为“不合规”。",
  "policy_filter" : {
    "region_id" : null,
    "resource_provider" : "evs",
    "resource_type" : "volumes",
    "resource_id" : null,
    "tag_key" : null,
    "tag_value" : null
  },
  "period" : null,
  "custom_policy" : null,
  "state" : "Enabled",
  "created" : "2020-11-20T07:03:00",
  "updated" : "2020-11-20T07:03:00",
  "policy_definition_id" : "5fa36558aa1e6afc05a3d0a7",
  "parameters" : { },
  "tags" : [ {
    "key" : "tagkey",
    "value" : "tagValue"
  } ],
  "created_by" : "custom",
  "target_type" : null,
  "target_id" : null
}

SDK代码示例

SDK代码示例如下。

创建一个名为“allowed-images-by-id”的合规规则。

 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
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;
import java.util.Map;
import java.util.HashMap;

public class CreatePolicyAssignmentsSolution {

    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();
        CreatePolicyAssignmentsRequest request = new CreatePolicyAssignmentsRequest();
        PolicyAssignmentRequestBody body = new PolicyAssignmentRequestBody();
        [](model.ResourceTag) listbodyTags = new ArrayList<>();
        listbodyTags.add(
            new ResourceTag()
                .withKey("tagkey")
                .withValue("tagValue")
        );
        PolicyParameterValue parametersParameters = new PolicyParameterValue();
        parametersParameters.withValue("[ea0d6e0e-99c3-406d-a873-3bb45462b624]");
        map[string](model.PolicyParameterValue) listbodyParameters = new HashMap<>();
        listbodyParameters.put("listOfAllowedImages", parametersParameters);
        PolicyFilterDefinition policyFilterbody = new PolicyFilterDefinition();
        policyFilterbody.withResourceProvider("ecs")
            .withResourceType("cloudservers");
        body.withTags(listbodyTags);
        body.withParameters(listbodyParameters);
        body.withPolicyDefinitionId("5f3c8b9a9811a13739a32ed9");
        body.withPolicyFilter(policyFilterbody);
        body.withDescription("The ECS resource is non-compliant if the image it used is not in the allowed list");
        body.withName("allowed-images-by-id");
        request.withBody(body);
        try {
            CreatePolicyAssignmentsResponse response = client.createPolicyAssignments(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());
        }
    }
}

创建一个名为“allowed-images-by-id”的合规规则。

 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
# 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 = CreatePolicyAssignmentsRequest()
        listTagsbody = [
            ResourceTag(
                key="tagkey",
                value="tagValue"
            )
        ]
        parametersParameters = PolicyParameterValue(
            value="[ea0d6e0e-99c3-406d-a873-3bb45462b624]"
        )
        listParametersbody = {
            "listOfAllowedImages": parametersParameters
        }
        policyFilterbody = PolicyFilterDefinition(
            resource_provider="ecs",
            resource_type="cloudservers"
        )
        request.body = PolicyAssignmentRequestBody(
            tags=listTagsbody,
            parameters=listParametersbody,
            policy_definition_id="5f3c8b9a9811a13739a32ed9",
            policy_filter=policyFilterbody,
            description="The ECS resource is non-compliant if the image it used is not in the allowed list",
            name="allowed-images-by-id"
        )
        response = client.create_policy_assignments(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

创建一个名为“allowed-images-by-id”的合规规则。

 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 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.CreatePolicyAssignmentsRequest{}
	var listTagsbody = []model.ResourceTag{
        {
            Key: "tagkey",
            Value: "tagValue",
        },
    }
	var valueParameters interface{} = "[ea0d6e0e-99c3-406d-a873-3bb45462b624]"
	parametersParameters := model.PolicyParameterValue{
		Value: &valueParameters,
	}
	var listParametersbody = map[string](model.PolicyParameterValue){
        "listOfAllowedImages": parametersParameters,
    }
	resourceProviderPolicyFilter:= "ecs"
	resourceTypePolicyFilter:= "cloudservers"
	policyFilterbody := &model.PolicyFilterDefinition{
		ResourceProvider: &resourceProviderPolicyFilter,
		ResourceType: &resourceTypePolicyFilter,
	}
	policyDefinitionIdPolicyAssignmentRequestBody:= "5f3c8b9a9811a13739a32ed9"
	descriptionPolicyAssignmentRequestBody:= "The ECS resource is non-compliant if the image it used is not in the allowed list"
	request.Body = &model.PolicyAssignmentRequestBody{
		Tags: &listTagsbody,
		Parameters: listParametersbody,
		PolicyDefinitionId: &policyDefinitionIdPolicyAssignmentRequestBody,
		PolicyFilter: policyFilterbody,
		Description: &descriptionPolicyAssignmentRequestBody,
		Name: "allowed-images-by-id",
	}
	response, err := client.CreatePolicyAssignments(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

操作成功。

400

输入参数不合法。

403

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

500

服务器内部错误。

错误码

请参见错误码

相关文档