更新时间:2024-11-25 GMT+08:00
分享

更新网络实例

功能介绍

更新网络实例。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

domain_id

String

账号ID。

id

String

实例ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

表3 请求Body参数

参数

是否必选

参数类型

描述

network_instance

UpdateNetworkInstance object

更新网络实例的详细信息。

表4 UpdateNetworkInstance

参数

是否必选

参数类型

描述

name

String

实例名称。

description

String

实例描述。不支持 <>。

cidrs

Array of strings

网络实例发布的网段路由列表。

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

request_id

String

请求ID。

network_instance

NetworkInstance object

网络实例。

表6 NetworkInstance

参数

参数类型

描述

id

String

实例ID。

name

String

实例名称。

description

String

实例描述。不支持 <>。

domain_id

String

实例所属账号ID。

created_at

String

实例创建时间。UTC时间格式,yyyy-MM-ddTHH:mm:ss。

updated_at

String

实例更新时间。UTC时间格式,yyyy-MM-ddTHH:mm:ss。

cloud_connection_id

String

云连接实例ID。

instance_id

String

网络实例(VPC,VGW)的ID。

instance_domain_id

String

网络实例(VPC,VGW)所属账号ID。

region_id

String

RegionID。

project_id

String

实例所属项目ID。

status

String

网络实例的状态。

  • ACTIVE:处理成功。

  • PENDING:处理中。

  • ERROR:处理失败。

type

String

网络实例的类型。

  • vpc:虚拟私有云。

  • vgw:虚拟网关。

cidrs

Array of strings

网络实例发布的网段路由列表。

请求示例

更新网络实例的描述

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

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

响应示例

状态码: 200

更新网络实例成功。

{
  "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" : "region-abc",
    "type" : "vpc",
    "instance_id" : "0a6904ae-04d2-42ff-91d5-7d421c60a04c",
    "cidrs" : [ "192.168.1.0/24" ],
    "status" : "ACTIVE"
  }
}

SDK代码示例

SDK代码示例如下。

更新网络实例的描述

 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
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();
        request.withId("{id}");
        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());
        }
    }
}

更新网络实例的描述

 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
# 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 = UpdateNetworkInstanceRequest()
        request.id = "{id}"
        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)

更新网络实例的描述

 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
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{}
	request.Id = "{id}"
	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)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

更新网络实例成功。

错误码

请参见错误码

相关文档