Help Center/ Config/ API Reference/ APIs/ Conformance Packages/ Creating a Conformance Package
Updated on 2024-08-12 GMT+08:00

Creating a Conformance Package

Function

This API is used to create a conformance package.

Calling Method

For details, see Calling APIs.

URI

POST /v1/resource-manager/domains/{domain_id}/conformance-packs

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

domain_id

Yes

String

Specifies tags.

Maximum: 36

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Language

No

String

Specifies the language of conformance package information. The default name is en-us, which can be zh-cn and en-us.

Default: en-us

X-Security-Token

No

String

Security token (session token) for temporary security credentials. This parameter is mandatory when you make an API call using temporary security credentials.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

name

Yes

String

Specifies the conformance package name.

Minimum: 0

Maximum: 64

agency_name

No

String

Specifies the agency name. The agency needs to authorize RFS to invoke the APIs for creating, updating, deleting a rule.

Minimum: 0

Maximum: 64

template_key

No

String

Specifies the name of a built-in conformance package template.

Maximum: 128

template_body

No

String

Specifies the content of a custom conformance package.

Minimum: 1

Maximum: 51200

template_uri

No

String

Specifies the URL address of the OBS bucket where a conformance package template was stored.

Minimum: 0

Maximum: 1024

vars_structure

No

Array of VarsStructure objects

Specifies the parameters of a conformance package.

Array Length: 0 - 50

Table 4 VarsStructure

Parameter

Mandatory

Type

Description

var_key

No

String

Specifies the name of a parameter.

Minimum: 1

Maximum: 64

var_value

No

Object

Specifies the value of a parameter.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

id

String

Specifies the ID of a conformance package.

name

String

Specifies the conformance package name.

stack_id

String

Specifies the unique ID of a resource stack.

Minimum: 1

Maximum: 64

stack_name

String

Specifies the name of a resource stack.

Minimum: 1

Maximum: 64

deployment_id

String

Specifies the deployment ID.

created_at

String

Specifies the time when a conformance package was created.

updated_at

String

Specifies the time when a conformance package was updated.

template_key

String

The name of a predefined conformance package template.

template_uri

String

The OBS address of a conformance package template

agency_name

String

The name of an agency.

status

String

Specifies the deployment status of a conformance package.

error_message

String

Specifies the error message when you failed to deploy or delete a conformance package.

vars_structure

Array of VarsStructure objects

Specifies the parameters of a conformance package.

created_by

String

Creator

Table 6 VarsStructure

Parameter

Type

Description

var_key

String

Specifies the name of a parameter.

Minimum: 1

Maximum: 64

var_value

Object

Specifies the value of a parameter.

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Specifies the error code.

error_msg

String

Specifies the error message.

Status code: 403

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Specifies the error code.

error_msg

String

Specifies the error message.

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Specifies the error code.

error_msg

String

Specifies the error message.

Example Requests

Create a conformance package based on a template.

POST https://{endpoint}/v1/resource-manager/domains/{domain_id}/conformance-packs

{
  "name" : "conformance_pack_name",
  "agency_name" : "config_conformance_pack_template",
  "template_key" : "example-001.yaml",
  "template_body" : null,
  "template_uri" : null,
  "vars_structure" : [ {
    "var_key" : "test",
    "var_value" : "test"
  } ]
}

Example Responses

Status code: 200

Operation succeeded.

{
  "id" : "a0123456789",
  "name" : "conformance_pack_name-e35r",
  "stack_id" : "stack-id-1234",
  "stack_name" : "stack-name-1234",
  "deployment_id" : "deployment_id_1234",
  "created_at" : "2023-02-28T09:39:19Z",
  "updated_at" : "2023-02-28T09:39:19Z",
  "status" : "CREATE_FAILED",
  "error_message" : "policy assignments exceed quota",
  "vars_structure" : [ {
    "var_key" : "test",
    "var_value" : "test"
  } ],
  "created_by" : "custom"
}

SDK Sample Code

The SDK sample code is as follows.

Create a conformance package based on a template.

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

    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();
        CreateConformancePackRequest request = new CreateConformancePackRequest();
        ConformancePackRequestBody body = new ConformancePackRequestBody();
        List<VarsStructure> listbodyVarsStructure = new ArrayList<>();
        listbodyVarsStructure.add(
            new VarsStructure()
                .withVarKey("test")
                .withVarValue("test")
        );
        body.withVarsStructure(listbodyVarsStructure);
        body.withTemplateKey("example-001.yaml");
        body.withAgencyName("config_conformance_pack_template");
        body.withName("conformance_pack_name");
        request.withBody(body);
        try {
            CreateConformancePackResponse response = client.createConformancePack(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());
        }
    }
}

Create a conformance package based on a template.

 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
# 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 = CreateConformancePackRequest()
        listVarsStructurebody = [
            VarsStructure(
                var_key="test",
                var_value="test"
            )
        ]
        request.body = ConformancePackRequestBody(
            vars_structure=listVarsStructurebody,
            template_key="example-001.yaml",
            agency_name="config_conformance_pack_template",
            name="conformance_pack_name"
        )
        response = client.create_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)

Create a conformance package based on a template.

 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
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.CreateConformancePackRequest{}
	varKeyVarsStructure:= "test"
	varValueVarsStructure:= "test"
	var varValueVarsStructureInterface interface{} = varValueVarsStructure
	var listVarsStructurebody = []model.VarsStructure{
        {
            VarKey: &varKeyVarsStructure,
            VarValue: &varValueVarsStructureInterface,
        },
    }
	templateKeyConformancePackRequestBody:= "example-001.yaml"
	agencyNameConformancePackRequestBody:= "config_conformance_pack_template"
	request.Body = &model.ConformancePackRequestBody{
		VarsStructure: &listVarsStructurebody,
		TemplateKey: &templateKeyConformancePackRequestBody,
		AgencyName: &agencyNameConformancePackRequestBody,
		Name: "conformance_pack_name",
	}
	response, err := client.CreateConformancePack(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

User authentication failed.

500

Server error.

Error Codes

See Error Codes.