Creating organization conformance packages.
Function
Create a new organization conformance package.
Calling Method
For details, see Calling APIs.
URI
POST /v1/resource-manager/organizations/{organization_id}/conformance-packs
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
organization_id |
Yes |
String |
Specifies the organization ID. Maximum: 34 |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Language |
No |
String |
Specifies the language of organization conformance package information. The default name is en-us, which can be zh-cn and en-us. Default: en-us |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
Yes |
String |
Organization conformance package name Minimum: 1 Maximum: 60 |
excluded_accounts |
No |
Array of strings |
The excluded accounts for conformance package deployment |
template_key |
No |
String |
The name of a predefined conformance package Maximum: 128 |
template_body |
No |
String |
The content of a custom conformance package Minimum: 0 Maximum: 51200 |
template_uri |
No |
String |
The OBS address of a conformance package Minimum: 0 Maximum: 1024 |
vars_structure |
No |
Array of VarsStructure objects |
Parameters of a conformance package Array Length: 0 - 50 |
Response Parameters
Status code: 200
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 |
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
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Specifies the error code. |
error_msg |
String |
Specifies the error message. |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Specifies the error code. |
error_msg |
String |
Specifies the error message. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Specifies the error code. |
error_msg |
String |
Specifies the error message. |
Example Requests
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 }
Example Responses
Status code: 200
Operation succeeded.
{ "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.
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) } } |
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 parameter. |
403 |
Authentication failed. |
500 |
Server error. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot