Help Center> Cloud Connect> API Reference> API> Network Instances> Updating a Network Instance
Updated on 2024-03-29 GMT+08:00

Updating a Network Instance

Function

This API is used to update a network instance.

Calling Method

For details, see Calling APIs.

URI

PUT /v3/{domain_id}/ccaas/network-instances/{id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

domain_id

Yes

String

Account ID.

Minimum: 10

Maximum: 32

id

Yes

String

Resource ID.

Minimum: 32

Maximum: 36

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token.

Minimum: 0

Maximum: 2000000

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

network_instance

Yes

UpdateNetworkInstance object

Details of the network instance to be updated.

Table 4 UpdateNetworkInstance

Parameter

Mandatory

Type

Description

name

No

String

Resource name.

description

No

String

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

Minimum: 0

Maximum: 255

cidrs

No

Array of strings

CIDR block routes advertised by the network instance.

Minimum: 0

Maximum: 64

Array Length: 0 - 1000

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

request_id

String

Resource ID.

Minimum: 32

Maximum: 36

network_instance

NetworkInstance object

Network instance.

Table 6 NetworkInstance

Parameter

Type

Description

id

String

Resource ID.

name

String

Resource name.

description

String

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

Minimum: 0

Maximum: 255

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

Resource ID.

instance_id

String

Resource ID.

instance_domain_id

String

ID of the account that the instance 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.

Minimum: 0

Maximum: 36

type

String

Type of the network instance.

  • vpc: a VPC

  • vgw: a virtual gateway

Minimum: 0

Maximum: 36

cidrs

Array of strings

CIDR block routes advertised by the network instance.

Minimum: 0

Maximum: 64

Array Length: 0 - 1000

Example Requests

Updating the description of a network instance

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

{
  "network_instance" : {
    "description" : "new description"
  }
}

Example Responses

Status code: 200

The network instance has been updated.

{
  "request_id" : "1e3cd137d7c27ad139886f23ade736b0",
  "network_instance" : {
    "id" : "XXX",
    "name" : "",
    "description" : "new description",
    "domain_id" : "XXX",
    "created_at" : "2023-09-20T09:33:15Z",
    "updated_at" : "2023-09-21T03:28:08Z",
    "project_id" : "XXX",
    "instance_domain_id" : "",
    "cloud_connection_id" : "XXX",
    "region_id" : "cn-north-4",
    "type" : "vpc",
    "instance_id" : "0a6904ae-04d2-42ff-91d5-7d421c60a04c",
    "cidrs" : [ "192.168.1.0/24" ],
    "status" : "ACTIVE"
  }
}

SDK Sample Code

The SDK sample code is as follows.

Updating the description of a network instance

 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
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.*;


public class UpdateNetworkInstanceSolution {

    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();
        UpdateNetworkInstanceRequest request = new UpdateNetworkInstanceRequest();
        UpdateNetworkInstanceRequestBody body = new UpdateNetworkInstanceRequestBody();
        UpdateNetworkInstance networkInstancebody = new UpdateNetworkInstance();
        networkInstancebody.withDescription("new description");
        body.withNetworkInstance(networkInstancebody);
        request.withBody(body);
        try {
            UpdateNetworkInstanceResponse response = client.updateNetworkInstance(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 the description of a network instance

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

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 = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("CLOUD_SDK_SK")

    credentials = GlobalCredentials(ak, sk) \

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

    try:
        request = UpdateNetworkInstanceRequest()
        networkInstancebody = UpdateNetworkInstance(
            description="new description"
        )
        request.body = UpdateNetworkInstanceRequestBody(
            network_instance=networkInstancebody
        )
        response = client.update_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)

Updating the description of a network instance

 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
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.UpdateNetworkInstanceRequest{}
	descriptionNetworkInstance:= "new description"
	networkInstancebody := &model.UpdateNetworkInstance{
		Description: &descriptionNetworkInstance,
	}
	request.Body = &model.UpdateNetworkInstanceRequestBody{
		NetworkInstance: networkInstancebody,
	}
	response, err := client.UpdateNetworkInstance(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

The network instance has been updated.

Error Codes

See Error Codes.