Help Center/ Cloud Connect/ API Reference/ API/ Network Instances/ Creating a Network Instance
Updated on 2024-11-25 GMT+08:00

Creating a Network Instance

Function

This API is used to create a network instance.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

POST /v3/{domain_id}/ccaas/network-instances

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

domain_id

Yes

String

Account ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

network_instance

Yes

CreateNetworkInstance object

Details of the network instance to be created.

Table 4 CreateNetworkInstance

Parameter

Mandatory

Type

Description

name

No

String

Instance name.

description

No

String

Resource description. Angle brackets (<>) are not allowed.

instance_id

Yes

String

ID of the network instance (VPC or virtual gateway).

instance_domain_id

No

String

ID of the account that the network instance (VPC or virtual gateway) belongs to.

project_id

Yes

String

Project ID.

region_id

Yes

String

Region ID.

cloud_connection_id

Yes

String

Cloud connection ID.

type

Yes

String

Type of the network instance to be added to the cloud connection.

  • vpc: a VPC

  • vgw: a virtual gateway

cidrs

Yes

Array of strings

CIDR block routes advertised by the network instance.

Response Parameters

Status code: 201

Table 5 Response body parameters

Parameter

Type

Description

request_id

String

Request ID.

network_instance

NetworkInstance object

Network instance.

Table 6 NetworkInstance

Parameter

Type

Description

id

String

Instance ID.

name

String

Instance name.

description

String

Resource description. Angle brackets (<>) are not allowed.

domain_id

String

ID of the account that the instance belongs to.

created_at

String

Time when the resource was created. The time is in the yyyy-MM-ddTHH:mm:ss format.

updated_at

String

Time when the resource was updated. The time must be in the yyyy-MM-ddTHH:mm:ss format.

cloud_connection_id

String

Cloud connection ID.

instance_id

String

ID of the network instance (VPC or virtual gateway).

instance_domain_id

String

ID of the account that the network instance (VPC or virtual gateway) belongs to.

region_id

String

Region ID.

project_id

String

Project ID.

status

String

Status of the network instance.

  • ACTIVE: The processing is successful.

  • PENDING: The network instance is being processed.

  • ERROR: The processing failed.

type

String

Type of the network instance.

  • vpc: a VPC

  • vgw: a virtual gateway

cidrs

Array of strings

CIDR block routes advertised by the network instance.

Example Requests

Creating a VPC with its subnet CIDR blocks specified

POST https://{cc_endpoint}/v3/{domain_id}/ccaas/network-instances

{
  "network_instance" : {
    "type" : "vpc",
    "region_id" : "region-abc",
    "project_id" : "XXX",
    "cloud_connection_id" : "XXX",
    "instance_id" : "XXX",
    "cidrs" : [ "192.168.1.0/24" ]
  }
}

Example Responses

Status code: 201

The network instance has been created.

{
  "request_id" : "c8fe3d71352e273915bfbd74ce58368a",
  "network_instance" : {
    "id" : "XXX",
    "name" : "",
    "description" : "",
    "domain_id" : "XXX",
    "created_at" : "2023-09-20T09:33:15Z",
    "updated_at" : "2023-09-20T09:33:16Z",
    "project_id" : "XXX",
    "instance_domain_id" : "",
    "cloud_connection_id" : "XXX",
    "region_id" : "region-abc",
    "type" : "vpc",
    "instance_id" : "XXX",
    "cidrs" : [ "192.168.1.0/24" ],
    "status" : "ACTIVE"
  }
}

SDK Sample Code

The SDK sample code is as follows.

Creating a VPC with its subnet CIDR blocks specified

 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
58
59
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.cc.v3.region.CcRegion;
import com.huaweicloud.sdk.cc.v3.*;
import com.huaweicloud.sdk.cc.v3.model.*;

import java.util.List;
import java.util.ArrayList;

public class CreateNetworkInstanceSolution {

    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);

        CcClient client = CcClient.newBuilder()
                .withCredential(auth)
                .withRegion(CcRegion.valueOf("<YOUR REGION>"))
                .build();
        CreateNetworkInstanceRequest request = new CreateNetworkInstanceRequest();
        CreateNetworkInstanceRequestBody body = new CreateNetworkInstanceRequestBody();
        List<String> listNetworkInstanceCidrs = new ArrayList<>();
        listNetworkInstanceCidrs.add("192.168.1.0/24");
        CreateNetworkInstance networkInstancebody = new CreateNetworkInstance();
        networkInstancebody.withInstanceId("XXX")
            .withProjectId("XXX")
            .withRegionId("region-abc")
            .withCidrs(listNetworkInstanceCidrs)
            .withType(CreateNetworkInstance.TypeEnum.fromValue("vpc"))
            .withCloudConnectionId("XXX");
        body.withNetworkInstance(networkInstancebody);
        request.withBody(body);
        try {
            CreateNetworkInstanceResponse response = client.createNetworkInstance(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());
        }
    }
}

Creating a VPC with its subnet CIDR blocks specified

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

import os
from huaweicloudsdkcore.auth.credentials import GlobalCredentials
from huaweicloudsdkcc.v3.region.cc_region import CcRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcc.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 = GlobalCredentials(ak, sk)

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

    try:
        request = CreateNetworkInstanceRequest()
        listCidrsNetworkInstance = [
            "192.168.1.0/24"
        ]
        networkInstancebody = CreateNetworkInstance(
            instance_id="XXX",
            project_id="XXX",
            region_id="region-abc",
            cidrs=listCidrsNetworkInstance,
            type="vpc",
            cloud_connection_id="XXX"
        )
        request.body = CreateNetworkInstanceRequestBody(
            network_instance=networkInstancebody
        )
        response = client.create_network_instance(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Creating a VPC with its subnet CIDR blocks specified

 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 main

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

    client := cc.NewCcClient(
        cc.CcClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.CreateNetworkInstanceRequest{}
	var listCidrsNetworkInstance = []string{
        "192.168.1.0/24",
    }
	networkInstancebody := &model.CreateNetworkInstance{
		InstanceId: "XXX",
		ProjectId: "XXX",
		RegionId: "region-abc",
		Cidrs: listCidrsNetworkInstance,
		Type: model.GetCreateNetworkInstanceTypeEnum().VPC,
		CloudConnectionId: "XXX",
	}
	request.Body = &model.CreateNetworkInstanceRequestBody{
		NetworkInstance: networkInstancebody,
	}
	response, err := client.CreateNetworkInstance(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

201

The network instance has been created.

Error Codes

See Error Codes.