Updated on 2024-11-27 GMT+08:00

Creating an Environment

Function

This API is used to create an environment.

Calling Method

For details, see Calling APIs.

URI

POST /v1/environments

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token obtained from IAM.

Content-Type

Yes

String

Content type, which is application/json. This parameter is mandatory only when the body exists.

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

component_id

Yes

String

ID of the component associated with the environment, which can contain up to 36 characters. Only letters and digits are allowed. This parameter is mandatory for creating an environment and optional for modifying an environment.

description

No

String

Description.

env_name

Yes

String

Environment name.

env_type

Yes

String

Environment type. Options: DEV, TEST, PRE, and ONLINE. The value is case-insensitive.

os_type

Yes

String

OS type. Options: LINUX and WINDOWS. This parameter is mandatory for creating an environment and cannot be modified.

region

No

String

Region associated with the environment. This parameter is mandatory for creating an environment and cannot be modified.

register_type

No

String

Registration type. Options: API (default), SERVICE_DISCOVERY, and CONSOLE.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

id

String

Object ID.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

AOM.30005001

error_msg

String

Invalid parameters.

Status code: 403

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

AOM.30001005

error_msg

String

No permissions.

Example Requests

Create an environment.

https://{Endpoint}/v1/environments

{
  "component_id" : "28c600be47374b9697404b0f58263d1c",
  "description" : "Environment description.",
  "env_name" : "environment1",
  "env_type" : "DEV",
  "os_type" : "LINUX",
  "region" : "xxx",
  "register_type" : "API"
}

Example Responses

Status code: 200

Environment ID.

{
  "id" : "530312e8bd7c4674b0af6d4beb2e23c6"
}

SDK Sample Code

The SDK sample code is as follows.

Java

Create an environment.

 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
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
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.aom.v3.region.AomRegion;
import com.huaweicloud.sdk.aom.v3.*;
import com.huaweicloud.sdk.aom.v3.model.*;


public class CreateEnvSolution {

    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 BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        AomClient client = AomClient.newBuilder()
                .withCredential(auth)
                .withRegion(AomRegion.valueOf("<YOUR REGION>"))
                .build();
        CreateEnvRequest request = new CreateEnvRequest();
        EnvParam body = new EnvParam();
        body.withRegisterType("API");
        body.withRegion("xxx");
        body.withOsType("LINUX");
        body.withEnvType("DEV");
        body.withEnvName("environment1");
        body.withDescription("Environment description.");
        body.withComponentId("28c600be47374b9697404b0f58263d1c");
        request.withBody(body);
        try {
            CreateEnvResponse response = client.createEnv(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());
        }
    }
}

Python

Create an environment.

 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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkaom.v3.region.aom_region import AomRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkaom.v3 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 = BasicCredentials(ak, sk)

    client = AomClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(AomRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = CreateEnvRequest()
        request.body = EnvParam(
            register_type="API",
            region="xxx",
            os_type="LINUX",
            env_type="DEV",
            env_name="environment1",
            description="Environment description.",
            component_id="28c600be47374b9697404b0f58263d1c"
        )
        response = client.create_env(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Go

Create an environment.

 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
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    aom "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aom/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aom/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aom/v3/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 := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := aom.NewAomClient(
        aom.AomClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CreateEnvRequest{}
	registerTypeEnvParam:= "API"
	regionEnvParam:= "xxx"
	descriptionEnvParam:= "Environment description."
	request.Body = &model.EnvParam{
		RegisterType: &registerTypeEnvParam,
		Region: &regionEnvParam,
		OsType: "LINUX",
		EnvType: "DEV",
		EnvName: "environment1",
		Description: &descriptionEnvParam,
		ComponentId: "28c600be47374b9697404b0f58263d1c",
	}
	response, err := client.CreateEnv(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

More

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

Environment ID.

400

Invalid parameters.

403

No permissions.

Error Codes

See Error Codes.