文档首页/ 配置审计 Config/ API参考/ API/ 合规性/ 创建组织合规规则
更新时间:2024-08-13 GMT+08:00
分享

创建组织合规规则

功能介绍

创建组织合规规则,如果规则名称已存在,则为更新操作。

调用方法

请参见如何调用API

URI

PUT /v1/resource-manager/organizations/{organization_id}/policy-assignments

表1 路径参数

参数

是否必选

参数类型

描述

organization_id

String

组织ID。

最大长度:34

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Security-Token

String

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

表3 请求Body参数

参数

是否必选

参数类型

描述

excluded_accounts

Array of strings

需要排除配置规则的账号。

最大长度:32

organization_policy_assignment_name

String

组织合规规则名称。

最大长度:60

managed_policy_assignment_metadata

ManagedPolicyAssignmentMetadata object

托管规则元数据。

表4 ManagedPolicyAssignmentMetadata

参数

是否必选

参数类型

描述

description

String

规则描述。

最大长度:512

period

String

触发周期。

parameters

Map<String,PolicyParameterValue>

输入参数。

policy_filter

PolicyFilterDefinition object

规则过滤器。

policy_definition_id

String

预定义策略标识符。

最大长度:36

表5 PolicyParameterValue

参数

是否必选

参数类型

描述

value

Object

规则参数值。

表6 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

响应参数

状态码: 200

表7 响应Body参数

参数

参数类型

描述

owner_id

String

组织合规规则创建者。

organization_id

String

组织ID。

organization_policy_assignment_urn

String

组织合规规则资源唯一标识。

organization_policy_assignment_id

String

组织合规规则ID。

organization_policy_assignment_name

String

组织合规规则名称。

description

String

描述信息。

period

String

触发周期。

policy_filter

PolicyFilterDefinition object

规则过滤器。

parameters

Map<String,PolicyParameterValue>

规则参数。

policy_definition_id

String

策略ID。

created_at

String

创建时间。

updated_at

String

更新时间。

表8 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

表9 PolicyParameterValue

参数

参数类型

描述

value

Object

规则参数值。

状态码: 400

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息内容。

状态码: 403

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息内容。

状态码: 500

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息内容。

请求示例

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

PUT https://{endpoint}/v1/resource-manager/organizations/{organization_id}/policy-assignments

{
  "organization_policy_assignment_name" : "allowed-images-by-id",
  "managed_policy_assignment_metadata" : {
    "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" : "5fa265c0aa1e6afc05a0ff07"
  }
}

响应示例

状态码: 200

操作成功。

{
  "owner_id" : "e74e043fab784a45ad88f5ef6a4bcffc",
  "organization_id" : "o-doxbpkzqsdd51ti1k27w2y8fitakrknp",
  "organization_policy_assignment_urn" : "rms::e74e043fab784a45ad88f5ef6a4bcffc:organizationPolicyAssignment:o-doxbpkzqsdd51ti1k27w2y8fitakrknp/d02b7fa9d5a74e638c1402d0868f71fd",
  "organization_policy_assignment_id" : "d02b7fa9d5a74e638c1402d0868f71fd",
  "organization_policy_assignment_name" : "allowed-images-by-id",
  "description" : "The ECS resource is non-compliant if the image it used is not in the allowed list.",
  "period" : null,
  "policy_filter" : {
    "region_id" : null,
    "resource_provider" : "evs",
    "resource_type" : "volumes",
    "resource_id" : null,
    "tag_key" : null,
    "tag_value" : null
  },
  "policy_definition_id" : "5fa265c0aa1e6afc05a0ff07",
  "parameters" : { },
  "created_at" : "2022-01-18T06:37:54.432Z",
  "updated_at" : "2022-01-18T06:37:54.432Z"
}

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

public class CreateOrganizationPolicyAssignmentSolution {

    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();
        CreateOrganizationPolicyAssignmentRequest request = new CreateOrganizationPolicyAssignmentRequest();
        OrganizationPolicyAssignmentRequest body = new OrganizationPolicyAssignmentRequest();
        PolicyFilterDefinition policyFilterManagedPolicyAssignmentMetadata = new PolicyFilterDefinition();
        policyFilterManagedPolicyAssignmentMetadata.withResourceProvider("ecs")
            .withResourceType("cloudservers");
        PolicyParameterValue parametersParameters = new PolicyParameterValue();
        parametersParameters.withValue("[ea0d6e0e-99c3-406d-a873-3bb45462b624]");
        Map<String, PolicyParameterValue> listManagedPolicyAssignmentMetadataParameters = new HashMap<>();
        listManagedPolicyAssignmentMetadataParameters.put("listOfAllowedImages", parametersParameters);
        ManagedPolicyAssignmentMetadata managedPolicyAssignmentMetadatabody = new ManagedPolicyAssignmentMetadata();
        managedPolicyAssignmentMetadatabody.withDescription("The ECS resource is non-compliant if the image it used is not in the allowed list.")
            .withParameters(listManagedPolicyAssignmentMetadataParameters)
            .withPolicyFilter(policyFilterManagedPolicyAssignmentMetadata)
            .withPolicyDefinitionId("5fa265c0aa1e6afc05a0ff07");
        body.withManagedPolicyAssignmentMetadata(managedPolicyAssignmentMetadatabody);
        body.withOrganizationPolicyAssignmentName("allowed-images-by-id");
        request.withBody(body);
        try {
            CreateOrganizationPolicyAssignmentResponse response = client.createOrganizationPolicyAssignment(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
# 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 = CreateOrganizationPolicyAssignmentRequest()
        policyFilterManagedPolicyAssignmentMetadata = PolicyFilterDefinition(
            resource_provider="ecs",
            resource_type="cloudservers"
        )
        parametersParameters = PolicyParameterValue(
            value="[ea0d6e0e-99c3-406d-a873-3bb45462b624]"
        )
        listParametersManagedPolicyAssignmentMetadata = {
            "listOfAllowedImages": parametersParameters
        }
        managedPolicyAssignmentMetadatabody = ManagedPolicyAssignmentMetadata(
            description="The ECS resource is non-compliant if the image it used is not in the allowed list.",
            parameters=listParametersManagedPolicyAssignmentMetadata,
            policy_filter=policyFilterManagedPolicyAssignmentMetadata,
            policy_definition_id="5fa265c0aa1e6afc05a0ff07"
        )
        request.body = OrganizationPolicyAssignmentRequest(
            managed_policy_assignment_metadata=managedPolicyAssignmentMetadatabody,
            organization_policy_assignment_name="allowed-images-by-id"
        )
        response = client.create_organization_policy_assignment(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
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.CreateOrganizationPolicyAssignmentRequest{}
	resourceProviderPolicyFilter:= "ecs"
	resourceTypePolicyFilter:= "cloudservers"
	policyFilterManagedPolicyAssignmentMetadata := &model.PolicyFilterDefinition{
		ResourceProvider: &resourceProviderPolicyFilter,
		ResourceType: &resourceTypePolicyFilter,
	}
	var valueParameters interface{} = "[ea0d6e0e-99c3-406d-a873-3bb45462b624]"
	parametersParameters := model.PolicyParameterValue{
		Value: &valueParameters,
	}
	var listParametersManagedPolicyAssignmentMetadata = map[string](model.PolicyParameterValue){
        "listOfAllowedImages": parametersParameters,
    }
	descriptionManagedPolicyAssignmentMetadata:= "The ECS resource is non-compliant if the image it used is not in the allowed list."
	managedPolicyAssignmentMetadatabody := &model.ManagedPolicyAssignmentMetadata{
		Description: &descriptionManagedPolicyAssignmentMetadata,
		Parameters: listParametersManagedPolicyAssignmentMetadata,
		PolicyFilter: policyFilterManagedPolicyAssignmentMetadata,
		PolicyDefinitionId: "5fa265c0aa1e6afc05a0ff07",
	}
	request.Body = &model.OrganizationPolicyAssignmentRequest{
		ManagedPolicyAssignmentMetadata: managedPolicyAssignmentMetadatabody,
		OrganizationPolicyAssignmentName: "allowed-images-by-id",
	}
	response, err := client.CreateOrganizationPolicyAssignment(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

操作成功。

400

输入参数不合法。

403

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

500

服务器内部错误。

错误码

请参见错误码

相关文档