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

Querying Conformance Packages

Function

This API is used to query conformance packages.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

domain_id

Yes

String

Specifies tags.

Maximum: 36

Table 2 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

conformance_pack_name

No

String

Specifies the conformance package name.

Minimum: 1

Maximum: 64

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

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 4 Response body parameters

Parameter

Type

Description

value

Array of ConformancePack objects

Specifies conformance packages queried.

page_info

PageInfo object

Specifies the pagination object.

Table 5 ConformancePack

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.

Table 7 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 8 Response body parameters

Parameter

Type

Description

error_code

String

Specifies the error code.

error_msg

String

Specifies the error message.

Status code: 403

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Specifies the error code.

error_msg

String

Specifies the error message.

Status code: 500

Table 10 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" : "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"
  } ],
  "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 ListConformancePacksSolution {

    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();
        ListConformancePacksRequest request = new ListConformancePacksRequest();
        request.withLimit(<limit>);
        request.withMarker("<marker>");
        request.withConformancePackName("<conformance_pack_name>");
        try {
            ListConformancePacksResponse response = client.listConformancePacks(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 = ListConformancePacksRequest()
        request.limit = <limit>
        request.marker = "<marker>"
        request.conformance_pack_name = "<conformance_pack_name>"
        response = client.list_conformance_packs(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.ListConformancePacksRequest{}
	limitRequest:= int32(<limit>)
	request.Limit = &limitRequest
	markerRequest:= "<marker>"
	request.Marker = &markerRequest
	conformancePackNameRequest:= "<conformance_pack_name>"
	request.ConformancePackName = &conformancePackNameRequest
	response, err := client.ListConformancePacks(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.