Help Center/ Config/ API Reference/ APIs/ Conformance Packages/ Querying Built-in Conformance Package Templates
Updated on 2024-06-21 GMT+08:00

Querying Built-in Conformance Package Templates

Function

This API is used to query built-in conformance package templates.

Calling Method

For details, see Calling APIs.

URI

GET /v1/resource-manager/conformance-packs/templates

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

Specifies the maximum number of records to return.

Minimum: 1

Maximum: 200

Default: 200

marker

No

String

Specifies the pagination parameter.

Minimum: 4

Maximum: 400

template_key

No

String

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

Minimum: 1

Maximum: 128

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Language

No

String

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

Default: zh-cn

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.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

value

Array of ConformancePackTemplate objects

Specifies built-in conformance package templates.

page_info

PageInfo object

Specifies the pagination object.

Table 4 ConformancePackTemplate

Parameter

Type

Description

id

String

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

template_key

String

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

description

String

Specifies the description for a built-in conformance package template.

template_body

String

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

parameters

Map<String,TemplateParameterDefinition>

Specifies the parameters for a built-in conformance package template.

Table 5 TemplateParameterDefinition

Parameter

Type

Description

name

String

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

description

String

Specifies the description of a parameter for a built-in conformance package template.

default_value

Object

Specifies the default value of a parameter for a built-in conformance package.

allowed_values

Array of objects

Specifies the list of allowed parameter values.

minimum

Float

Specifies the minimum value of the policy parameter.

maximum

Float

Specifies the maximum value of the policy parameter.

min_items

Integer

Specifies the minimum number of the policy parameter.

max_items

Integer

Specifies the maximum number of the policy parameter.

min_length

Integer

Specifies the minimum string length for policy parameters or for each item.

max_length

Integer

Specifies the maximum string length for policy parameters or for each item.

pattern

String

Specifies the pattern for policy parameters or for each item.

type

String

Specifies the type of a parameter for a built-in conformance package template.

Table 6 PageInfo

Parameter

Type

Description

current_count

Integer

Specifies the resource quantity on the current page.

Minimum: 0

Maximum: 200

next_marker

String

Specifies the marker value of the next page.

Minimum: 4

Maximum: 400

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

None

Example Responses

Status code: 200

Operation succeeded.

{
  "value" : [ {
    "id" : "k0123456789",
    "template_key" : "example-001.yaml",
    "description" : "Example of built-in conformance package templates",
    "template_body" : "Omit it.",
    "parameters" : {
      "listOfAllowedFlavors" : {
        "description" : "The list of allowed flavor types.",
        "type" : "Array",
        "default_value" : "STAT",
        "allowed_values" : [ "STAT" ]
      }
    }
  } ],
  "page_info" : {
    "current_count" : 1,
    "next_marker" : null
  }
}

SDK Sample Code

The SDK sample code is as follows.

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

    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();
        ListBuiltInConformancePackTemplatesRequest request = new ListBuiltInConformancePackTemplatesRequest();
        request.withLimit(<limit>);
        request.withMarker("<marker>");
        request.withTemplateKey("<template_key>");
        try {
            ListBuiltInConformancePackTemplatesResponse response = client.listBuiltInConformancePackTemplates(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
# 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 = ListBuiltInConformancePackTemplatesRequest()
        request.limit = <limit>
        request.marker = "<marker>"
        request.template_key = "<template_key>"
        response = client.list_built_in_conformance_pack_templates(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
41
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.ListBuiltInConformancePackTemplatesRequest{}
	limitRequest:= int32(<limit>)
	request.Limit = &limitRequest
	markerRequest:= "<marker>"
	request.Marker = &markerRequest
	templateKeyRequest:= "<template_key>"
	request.TemplateKey = &templateKeyRequest
	response, err := client.ListBuiltInConformancePackTemplates(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.