Help Center/ Direct Connect/ API Reference/ API/ Virtual Interfaces/ Updating a Virtual Interface Peer
Updated on 2024-11-14 GMT+08:00

Updating a Virtual Interface Peer

Function

This API is used to update a virtual interface peer. 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 Path 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

Yes

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

Yes

Array of strings

Specifies the remote subnet list, which records the CIDR blocks used in the on-premises data center.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

vif_peer

VifPeer object

Specifies the virtual interface peer.

request_id

String

Specifies the request ID.

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 NQA is enabled. The value can be true or false.

enable_bfd

Boolean

Specifies whether BFD is enabled. 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

OK

{
  "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" ]
  },
  "request_id": "796a2b2d3ffbde1b76b8f854d5db7a81"
}

SDK Sample Code

The SDK sample code is as follows.

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

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

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

        DcClient client = DcClient.newBuilder()
                .withCredential(auth)
                .withRegion(DcRegion.valueOf("<YOUR REGION>"))
                .build();
        UpdateVifPeerRequest request = new UpdateVifPeerRequest();
        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());
        }
    }
}

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

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

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

    credentials = BasicCredentials(ak, sk) \

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

    try:
        request = UpdateVifPeerRequest()
        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)

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

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

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := dc.NewDcClient(
        dc.DcClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.UpdateVifPeerRequest{}
	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)
    }
}

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

OK

Error Codes

See Error Codes.