Help Center/ Config/ API Reference/ APIs/ Conformance Packages/ Updating Organization Conformance Packages
Updated on 2024-06-21 GMT+08:00

Updating Organization Conformance Packages

Function

This API is used to update organization conformance packages.

Calling Method

For details, see Calling APIs.

URI

PUT /v1/resource-manager/organizations/{organization_id}/conformance-packs/{conformance_pack_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

organization_id

Yes

String

Specifies the organization ID.

Maximum: 34

conformance_pack_id

Yes

String

Specifies the ID of a conformance package.

Maximum: 36

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

name

Yes

String

The name of an organization conformance package.

Minimum: 1

Maximum: 60

excluded_accounts

No

Array of strings

The accounts for which the conformance package will not be deployed.

vars_structure

No

Array of VarsStructure objects

Parameters of a conformance package.

Array Length: 0 - 50

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

Parameter

Type

Description

org_conformance_pack_id

String

Organization conformance package ID

org_conformance_pack_name

String

Organization conformance package name

owner_id

String

The creator of an organization conformance package

organization_id

String

Organization ID

org_conformance_pack_urn

String

The unique identifier of resources in an organization conformance package

vars_structure

Array of VarsStructure objects

Parameters of a conformance package

created_at

String

The creation time of an organization conformance package

updated_at

String

The update time of an organization conformance package

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

Parameter

Type

Description

error_code

String

Specifies the error code.

error_msg

String

Specifies the error message.

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Specifies the error code.

error_msg

String

Specifies the error message.

Status code: 404

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

Updating Organization Conformance Packages

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

{
  "name" : "org_conformance_pack_name-e35r",
  "vars_structure" : [ {
    "var_key" : "test",
    "var_value" : "test"
  } ]
}

Example Responses

Status code: 200

Update task created.

{
  "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 Sample Code

The SDK sample code is as follows.

Updating Organization Conformance Packages

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

    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();
        UpdateOrganizationConformancePackRequest request = new UpdateOrganizationConformancePackRequest();
        UpdateOrgConformancePackRequestBody body = new UpdateOrgConformancePackRequestBody();
        List<VarsStructure> listbodyVarsStructure = new ArrayList<>();
        listbodyVarsStructure.add(
            new VarsStructure()
                .withVarKey("test")
                .withVarValue("test")
        );
        body.withVarsStructure(listbodyVarsStructure);
        body.withName("org_conformance_pack_name-e35r");
        request.withBody(body);
        try {
            UpdateOrganizationConformancePackResponse response = client.updateOrganizationConformancePack(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());
        }
    }
}

Updating Organization Conformance Packages

 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
# 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 = UpdateOrganizationConformancePackRequest()
        listVarsStructurebody = [
            VarsStructure(
                var_key="test",
                var_value="test"
            )
        ]
        request.body = UpdateOrgConformancePackRequestBody(
            vars_structure=listVarsStructurebody,
            name="org_conformance_pack_name-e35r"
        )
        response = client.update_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)

Updating Organization Conformance Packages

 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 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.UpdateOrganizationConformancePackRequest{}
	varKeyVarsStructure:= "test"
	varValueVarsStructure:= "test"
	var varValueVarsStructureInterface interface{} = varValueVarsStructure
	var listVarsStructurebody = []model.VarsStructure{
        {
            VarKey: &varKeyVarsStructure,
            VarValue: &varValueVarsStructureInterface,
        },
    }
	request.Body = &model.UpdateOrgConformancePackRequestBody{
		VarsStructure: &listVarsStructurebody,
		Name: "org_conformance_pack_name-e35r",
	}
	response, err := client.UpdateOrganizationConformancePack(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

Update task created.

400

Invalid parameter.

403

Authentication failed.

404

Conformance package not found.

500

Internal server error.

Error Codes

See Error Codes.