文档首页/ 云专线 DC/ API参考/ API/ 虚拟接口/ 更新虚拟接口对等体 - UpdateVifPeer
更新时间:2026-10-21 GMT+08:00
分享

更新虚拟接口对等体 - UpdateVifPeer

功能介绍

更新虚拟接口对等体信息,包括远端子网、名称和描述等。 本接口只在支持IPv6的区域开放,如需使用请联系客服。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    dcaas:vifPeer:update

    Write

    vifPeer *

    -

    -

    -

URI

PUT /v3/{project_id}/dcaas/vif-peers/{vif_peer_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

租户项目ID。获取方法请参见《统一身份认证服务API参考》的『获取账号项目ID』章节,或通过查询项目列表接口获取

约束限制:

不涉及

取值范围:

32 位十六进制字符(0-9, a-f, A-F)

默认取值:

不涉及

vif_peer_id

是

String

参数解释:

虚拟接口对等体ID。获取方式:可通过创建虚拟接口对等体(CreateVifPeer)或查询虚拟接口对等体接口获取

约束限制:

不涉及

取值范围:

UUID 格式,以连字符(-)连接,长度为36个字符

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token。 获取Token,请参考《统一身份认证服务API参考》的「获取用户Token」章节。请求响应成功后在响应消息头中包含的「X-Subject-Token」的值即为Token值。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

vif_peer

否

UpdateVifPeer object

参数解释:

更新虚拟接口对等体参数

约束限制:

不涉及

表4 UpdateVifPeer

参数

是否必选

参数类型

描述

name

否

String

参数解释:

虚拟接口对等体名称。

约束限制:

不涉及。

取值范围:

中文字符、英文字母、数字、连字符(-)、下划线(_)、点(.)组成;长度不超过64个字符。

默认取值:

不涉及。

description

否

String

参数解释:

虚拟接口对等体描述信息。

约束限制:

不涉及。

取值范围:

不支持尖括号(<>)和反引号(`)的任意字符;长度不超过2048个字符。

默认取值:

不涉及。

remote_ep_group

否

Array of strings

参数解释:

远端子网列表,记录用户侧的cidrs。数组中每个字符串为 CIDR 格式,如 10.0.0.0/24。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

vif_peer

VifPeer object

参数解释:

虚拟接口对等体对象

表6 VifPeer

参数

参数类型

描述

id

String

参数解释:

虚拟接口对等体的ID

取值范围:

长度为36个字符

tenant_id

String

参数解释:

归属租户ID

取值范围:

不涉及

name

String

参数解释:

虚拟接口对等体名称

取值范围:

长度不超过64个字符

description

String

参数解释:

虚拟接口对等体描述信息。

取值范围:

长度不超过2048个字符。

address_family

String

参数解释:

接口的地址簇类型,ipv4,ipv6

取值范围:

不涉及

local_gateway_ip

String

参数解释:

虚拟接口对等体云侧接口地址

取值范围:

不涉及

remote_gateway_ip

String

参数解释:

虚拟接口对等体客户侧接口地址

取值范围:

不涉及

route_mode

String

参数解释:

路由模式

取值范围:

static:静态路由;bgp:BGP 路由

bgp_asn

Integer

参数解释:

BGP邻居的AS号

取值范围:

1~4294967295

bgp_md5

String

参数解释:

BGP邻居的MD5密码

取值范围:

不涉及

remote_ep_group

Array of strings

参数解释:

远端子网列表,记录租户侧的cidrs。数组中每个字符串为 CIDR 格式,如 10.0.0.0/24。

取值范围:

不涉及

service_ep_group

Array of strings

参数解释:

该字段用于公网专线接口,表示租户可以访问云上公网服务地址列表。数组中每个字符串为 CIDR 格式,如 10.0.0.0/24。

取值范围:

不涉及

device_id

String

参数解释:

归属的设备ID

取值范围:

不涉及

bgp_route_limit

Integer

参数解释:

BGP的路由配置规格

取值范围:

不涉及

bgp_status

String

参数解释:

接口BGP协议状态,如果是静态路由接口则状态为 null

取值范围:

不涉及

status

String

参数解释:

虚拟接口对等体状态。

取值范围:

  • ACTIVE:正常

  • ERROR:异常

vif_id

String

参数解释:

虚拟接口对等体对应的虚拟接口ID

取值范围:

长度为36个字符

receive_route_num

Integer

参数解释:

接收的BGP的路由数目。路由模式为static时,该字段无意义,值为-1。

早期接入云的部分用户可能无法获取该字段信息,如有需要请联系客服迁移专线端口。

取值范围:

不涉及

enable_nqa

Boolean

参数解释:

是否使能nqa功能

取值范围:

  • true:使能nqa功能

  • false:不使能nqa功能

enable_bfd

Boolean

参数解释:

是否使能bfd功能

取值范围:

  • true:使能bfd功能

  • false:不使能bfd功能

请求示例

更新虚拟接口对等体的名称,修改远端子网列表。

PUT https://{endpoint}/v3/cfa563efb77d4b6d9960781d82530fd8/dcaas/vif-peers/68250543-0a13-4ac7-aa36-d018856ac640

{
  "vif_peer" : {
    "name" : "vif-0819",
    "description" : "mytest",
    "remote_ep_group" : [ "20.1.1.0/24" ]
  }
}

响应示例

状态码:200

{
  "vif_peer" : {
    "name" : "vif-0819",
    "description" : "mytest",
    "id" : "4c95de3e-9f75-4357-9c79-b22498dd71c7",
    "tenant_id" : "ed28c294165741faaeccab26913122a1",
    "address_family" : "ipv4",
    "local_gateway_ip" : "12.3.4.1/30",
    "remote_gateway_ip" : "12.3.4.2/30",
    "route_mode" : "static",
    "bgp_asn" : null,
    "bgp_md5" : null,
    "bgp_route_limit" : 100,
    "bgp_status" : null,
    "status" : "ACTIVE",
    "vif_id" : "5d6c17bc-0ebe-420b-8734-21f519e9d7ad",
    "receive_route_num" : -1,
    "remote_ep_group" : [ "20.1.1.0/24" ],
    "service_ep_group" : null,
    "device_id" : "172.16.40.2",
    "enable_nqa" : false,
    "enable_bfd" : false
  }
}

SDK代码示例

SDK代码示例如下。

Java

更新虚拟接口对等体的名称,修改远端子网列表。

 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.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.dc.v3.region.DcRegion;
import com.huaweicloud.sdk.dc.v3.*;
import com.huaweicloud.sdk.dc.v3.model.*;

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

public class UpdateVifPeerSolution {

    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");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        DcClient client = DcClient.newBuilder()
                .withCredential(auth)
                .withRegion(DcRegion.valueOf("<YOUR REGION>"))
                .build();
        UpdateVifPeerRequest request = new UpdateVifPeerRequest();
        request.withVifPeerId("{vif_peer_id}");
        UpdateVifPeerRequestBody body = new UpdateVifPeerRequestBody();
        List<String> listVifPeerRemoteEpGroup = new ArrayList<>();
        listVifPeerRemoteEpGroup.add("20.1.1.0/24");
        UpdateVifPeer vifPeerbody = new UpdateVifPeer();
        vifPeerbody.withName("vif-0819")
            .withDescription("mytest")
            .withRemoteEpGroup(listVifPeerRemoteEpGroup);
        body.withVifPeer(vifPeerbody);
        request.withBody(body);
        try {
            UpdateVifPeerResponse response = client.updateVifPeer(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

更新虚拟接口对等体的名称,修改远端子网列表。

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

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdc.v3.region.dc_region import DcRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdc.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"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

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

    try:
        request = UpdateVifPeerRequest()
        request.vif_peer_id = "{vif_peer_id}"
        listRemoteEpGroupVifPeer = [
            "20.1.1.0/24"
        ]
        vifPeerbody = UpdateVifPeer(
            name="vif-0819",
            description="mytest",
            remote_ep_group=listRemoteEpGroupVifPeer
        )
        request.body = UpdateVifPeerRequestBody(
            vif_peer=vifPeerbody
        )
        response = client.update_vif_peer(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

更新虚拟接口对等体的名称,修改远端子网列表。

 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
60
61
62
63
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dc/v3"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dc/v3/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dc/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")
    projectId := "{project_id}"

    auth, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := dc.DcClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := dc.NewDcClient(hcClient)

    request := &model.UpdateVifPeerRequest{}
	request.VifPeerId = "{vif_peer_id}"
	var listRemoteEpGroupVifPeer = []string{
        "20.1.1.0/24",
    }
	nameVifPeer:= "vif-0819"
	descriptionVifPeer:= "mytest"
	vifPeerbody := &model.UpdateVifPeer{
		Name: &nameVifPeer,
		Description: &descriptionVifPeer,
		RemoteEpGroup: &listRemoteEpGroupVifPeer,
	}
	request.Body = &model.UpdateVifPeerRequestBody{
		VifPeer: vifPeerbody,
	}
	response, err := client.UpdateVifPeer(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多

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

状态码

状态码

描述

200

OK

错误码

请参见错误码。

相关文档