Help Center/ Direct Connect/ API Reference/ API/ Virtual Interfaces/ Updating a Virtual Interface Peer

Updated on 2025-09-09 GMT+08:00

View PDF

Updating a Virtual Interface Peer

Function

This API is used to update a virtual interface peer. The following parameters can be updated: name, description, and remote_ep_group.

Debugging

For details, see Calling APIs.

URI

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

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the project ID.
vif_peer_id	Yes	String	Specifies the virtual interface peer ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Specifies the user token. To obtain the token, see section "Obtaining the User Token" in the Identity and Access Management API Reference. The token is the value of X-Subject-Token in the response header. Minimum: 0 Maximum: 10240

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
vif_peer	No	UpdateVifPeer object	Specifies the virtual interface peer to be updated.

**Table 4** UpdateVifPeer
Parameter	Mandatory	Type	Description
name	No	String	Specifies the name of the virtual interface peer. Minimum: 0 Maximum: 64
description	No	String	Provides supplementary information about the virtual interface peer. Minimum: 0 Maximum: 128
remote_ep_group	No	Array of strings	Specifies the remote subnet list, which records the CIDR blocks used in the on-premises data center.

When you update a virtual interface peer, at least one of the following parameters needs to be specified: name, description, and remote_ep_group.

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
vif_peer	VifPeer object	Specifies the virtual interface peer.

**Table 6** VifPeer
Parameter	Type	Description
id	String	Specifies the resource ID. Minimum: 36 Maximum: 36
tenant_id	String	Specifies the ID of the project that the virtual interface peer belongs to. Minimum: 36 Maximum: 36
name	String	Specifies the name of the virtual interface peer. Minimum: 0 Maximum: 64
description	String	Provides supplementary information about the virtual interface peer. Minimum: 0 Maximum: 128
address_family	String	Specifies the address family of the virtual interface. The value can be IPv4 or IPv6.
local_gateway_ip	String	Specifies the gateway of the virtual interface peer used on the cloud.
remote_gateway_ip	String	Specifies the gateway of the virtual interface peer used in the on-premises data center.
route_mode	String	Specifies the routing mode. The value can be static or bgp. Maximum: 255 Enumeration values: bgp static
bgp_asn	Integer	Specifies the ASN of the BGP peer. Minimum: 1 Maximum: 4294967295
bgp_md5	String	Specifies the MD5 password of the BGP peer.
remote_ep_group	Array of strings	Specifies the remote subnet list, which records the CIDR blocks used in the on-premises data center.
service_ep_group	Array of strings	Specifies the list of public network addresses that can be accessed by the on-premises data center. This field is required in the APIs of public network connections.
device_id	String	Specifies the ID of the device that the virtual interface peer belongs to.
bgp_route_limit	Integer	Specifies the BGP route configuration.
bgp_status	String	Specifies the BGP protocol status of the virtual interface peer. If the virtual interface peer uses static routing, the status is null. Maximum: 10
status	String	Specifies the status of the virtual interface peer.
vif_id	String	Specifies the ID of the virtual interface corresponding to the virtual interface peer. Minimum: 36 Maximum: 36
receive_route_num	Integer	Specifies the number of received BGP routes if BGP routing is used. If static routing is used, this parameter is meaningless and the value is -1. If this parameter cannot be obtained, contact customer service to migrate your ports.
enable_nqa	Boolean	Specifies whether to enable NQA (Network Quality Analysis). The value can be true or false.
enable_bfd	Boolean	Specifies whether to enable BFD (Bidirectional Forwarding Detection). The value can be true or false.

Example Requests

Updating the name, description, and remote subnet of a virtual interface peer

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" ]
  }
}

Example Responses

Status code: 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" ]
  }
}