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

创建组织合规规则包

功能介绍

创建新的组织合规规则包。

调用方法

请参见如何调用API

URI

POST /v1/resource-manager/organizations/{organization_id}/conformance-packs

表1 路径参数

参数

是否必选

参数类型

描述

organization_id

String

组织ID。

最大长度:34

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Language

String

组织合规包信息语言,默认为"en-us"英文,可选值:zh-cn和en-us。

缺省值:en-us

表3 请求Body参数

参数

是否必选

参数类型

描述

name

String

组织合规规则包名称。

最小长度:1

最大长度:60

excluded_accounts

Array of strings

排除配置合规包的账号。

template_key

String

预定义合规规则包模板名称。

最大长度:128

template_body

String

自定义合规规则包内容。

最小长度:0

最大长度:51200

template_uri

String

合规规则包模板OBS地址。

最小长度:0

最大长度:1024

vars_structure

Array of VarsStructure objects

合规规则包参数。

数组长度:0 - 50

表4 VarsStructure

参数

是否必选

参数类型

描述

var_key

String

参数名称。

最小长度:1

最大长度:64

var_value

Object

参数的值。

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

org_conformance_pack_id

String

组织合规规则包ID。

org_conformance_pack_name

String

组织合规规则包名称。

owner_id

String

组织合规规则包创建者。

organization_id

String

组织ID

org_conformance_pack_urn

String

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

vars_structure

Array of VarsStructure objects

合规规则包参数。

created_at

String

组织合规规则包创建时间。

updated_at

String

组织合规规则包更新时间。

表6 VarsStructure

参数

参数类型

描述

var_key

String

参数名称。

最小长度:1

最大长度:64

var_value

Object

参数的值。

状态码: 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息内容。

状态码: 403

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息内容。

状态码: 500

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息内容。

请求示例

POST https://{endpoint}/v1/resource-manager/organizations/{organization_id}/conformance-packs

{
  "name" : "org_conformance_pack_name-e35r",
  "template_key" : "example-001.yaml",
  "template_body" : null,
  "template_uri" : null,
  "vars_structure" : null
}

响应示例

状态码: 200

操作成功。

{
  "org_conformance_pack_id" : "d02b7fa9d5a74e638c1402d0868f71fd",
  "org_conformance_pack_name" : "org_conformance_pack_name-e35r",
  "owner_id" : "a1b2c043fab784a45ad88f5ef6a4bdaas",
  "organization_id" : "o-doxbpkzqsdd51ti1k27w2y8fitakrknp",
  "org_conformance_pack_urn" : "rms::a1b2c043fab784a45ad88f5ef6a4bdaas:organizationConformancePack:o-doxbpkzqsdd51ti1k27w2y8fitakrknp/d02b7fa9d5a74e638c1402d0868f71fd",
  "created_at" : "2023-02-28T09:39:19Z",
  "updated_at" : "2023-02-28T09:39:19Z"
}

SDK代码示例

SDK代码示例如下。

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

    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();
        CreateOrganizationConformancePackRequest request = new CreateOrganizationConformancePackRequest();
        OrgConformancePackRequestBody body = new OrgConformancePackRequestBody();
        body.withTemplateKey("example-001.yaml");
        body.withName("org_conformance_pack_name-e35r");
        request.withBody(body);
        try {
            CreateOrganizationConformancePackResponse response = client.createOrganizationConformancePack(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());
        }
    }
}
 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
# 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 = CreateOrganizationConformancePackRequest()
        request.body = OrgConformancePackRequestBody(
            template_key="example-001.yaml",
            name="org_conformance_pack_name-e35r"
        )
        response = client.create_organization_conformance_pack(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 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
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.CreateOrganizationConformancePackRequest{}
	templateKeyOrgConformancePackRequestBody:= "example-001.yaml"
	request.Body = &model.OrgConformancePackRequestBody{
		TemplateKey: &templateKeyOrgConformancePackRequestBody,
		Name: "org_conformance_pack_name-e35r",
	}
	response, err := client.CreateOrganizationConformancePack(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

操作成功。

400

输入参数不合法。

403

用户身份认证失败。

500

服务器内部错误。

错误码

请参见错误码

相关文档