文档首页/ 云专线 DC/ API参考/ API/ 虚拟接口/ 修改虚拟接口可靠性检测的扩展参数 - UpdateExtendAttribute
更新时间:2026-07-22 GMT+08:00
分享

修改虚拟接口可靠性检测的扩展参数 - UpdateExtendAttribute

功能介绍

虚拟接口有bfd与nqa两种可靠性检测方式,您可以通过调用此接口修改可靠性检测的参数。例如检测报文最小发送间隔、检测报文最大发送间隔、检测周期等信息。

调用方法

请参见如何调用API

授权信息

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

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

PUT /v3/{project_id}/dcaas/virtual-interfaces/{virtual_interface_id}/extend-attributes

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户项目ID

最小长度:0

最大长度:36

virtual_interface_id

String

虚拟接口ID

最小长度:0

最大长度:36

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

最小长度:0

最大长度:10240

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

request_id

String

请求ID

extend_attribute

VifExtendAttribute object

虚拟接口BFD/NQA等可靠性检测的扩展信息

表4 VifExtendAttribute

参数

参数类型

描述

ha_type

String

虚拟接口的可用性检测类型。取值范围:

  • nqa:网络质量分析

  • bfd:双向转发检测

ha_mode

String

虚拟接口可用性检测的配置模式。取值范围:

  • auto_single:自动单跳bfd

  • auto_multi:自动多跳bfd

  • static_single:静态单跳bfd

  • static_multi:静态多跳bfd

  • enhance_nqa:增强型nqa

detect_multiplier

Integer

检测的重试次数

min_rx_interval

Integer

检测的接收时长间隔,单位为毫秒。

  • 当ha_type为nqa时,实际生效的时间间隔为按秒为单位将输入的数值向上取整,例如输入1500毫秒,实际时间间隔为2秒;

  • 当ha_type为bfd时,实际生效的时间间隔为按毫秒为单位的输入数值。最小值为200毫秒,最大值为1000毫秒。

min_tx_interval

Integer

检测的发送时长间隔,单位为毫秒。

  • 当ha_type为nqa时,实际生效的时间间隔为按秒为单位将输入的数值向上取整,例如输入1500毫秒,实际时间间隔为2秒;

  • 当ha_type为bfd时,实际生效的时间间隔为按毫秒为单位的输入数值。最小值为200毫秒,最大值为1000毫秒。

remote_disclaim

Integer

检测的远端的标识,用于静态BFD

local_disclaim

Integer

检测的本端的标识,用于静态BFD

ipv6_remote_disclaim

Integer

检测的远端的标识,用于静态ipv6 BFD

ipv6_local_disclaim

Integer

检测的本端的标识,用于静态ipv6 BFD

请求示例

修改虚拟接口可靠性检测方式为自动单跳bfd,最小发送间隔为500ms,最小接收间隔为500ms,探测周期为3次。

PUT https://{dc_endpoinent}/v3/4bd6efdb0fb747b39aa2c0162c112226/dcaas/virtual-interfaces/96201035-6a29-49f2-bd2c-a6bb641dd500/extend-attributes

{
  "extend_attribute" : {
    "ha_type" : "bfd",
    "ha_mode" : "auto_single",
    "min_rx_interval" : 500,
    "min_tx_interval" : 500,
    "detect_multiplier" : 3
  }
}

响应示例

状态码:200

OK

更新虚拟接口可靠性检测扩展参数的返回体

{
  "request_id" : "c31651e323414fa89c5cfba267a3035b",
  "extend_attribute" : {
    "ha_type" : "bfd",
    "ha_mode" : "auto_single",
    "min_rx_interval" : 500,
    "min_tx_interval" : 500,
    "detect_multiplier" : 3
  }
}

SDK代码示例

SDK代码示例如下。

修改虚拟接口可靠性检测方式为自动单跳bfd,最小发送间隔为500ms,最小接收间隔为500ms,探测周期为3次。

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


public class UpdateExtendAttributeSolution {

    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();
        UpdateExtendAttributeRequest request = new UpdateExtendAttributeRequest();
        request.withVirtualInterfaceId("{virtual_interface_id}");
        UpdateExtendAttributeRequestBody body = new UpdateExtendAttributeRequestBody();
        VifExtendAttribute extendAttributebody = new VifExtendAttribute();
        extendAttributebody.withHaType(VifExtendAttribute.HaTypeEnum.fromValue("bfd"))
            .withHaMode(VifExtendAttribute.HaModeEnum.fromValue("auto_single"))
            .withDetectMultiplier(3)
            .withMinRxInterval(500)
            .withMinTxInterval(500);
        body.withExtendAttribute(extendAttributebody);
        request.withBody(body);
        try {
            UpdateExtendAttributeResponse response = client.updateExtendAttribute(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());
        }
    }
}

修改虚拟接口可靠性检测方式为自动单跳bfd,最小发送间隔为500ms,最小接收间隔为500ms,探测周期为3次。

 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
# 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 = UpdateExtendAttributeRequest()
        request.virtual_interface_id = "{virtual_interface_id}"
        extendAttributebody = VifExtendAttribute(
            ha_type="bfd",
            ha_mode="auto_single",
            detect_multiplier=3,
            min_rx_interval=500,
            min_tx_interval=500
        )
        request.body = UpdateExtendAttributeRequestBody(
            extend_attribute=extendAttributebody
        )
        response = client.update_extend_attribute(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

修改虚拟接口可靠性检测方式为自动单跳bfd,最小发送间隔为500ms,最小接收间隔为500ms,探测周期为3次。

 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
64
65
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.UpdateExtendAttributeRequest{}
	request.VirtualInterfaceId = "{virtual_interface_id}"
	haTypeExtendAttribute:= model.GetVifExtendAttributeHaTypeEnum().BFD
	haModeExtendAttribute:= model.GetVifExtendAttributeHaModeEnum().AUTO_SINGLE
	detectMultiplierExtendAttribute:= int32(3)
	minRxIntervalExtendAttribute:= int32(500)
	minTxIntervalExtendAttribute:= int32(500)
	extendAttributebody := &model.VifExtendAttribute{
		HaType: &haTypeExtendAttribute,
		HaMode: &haModeExtendAttribute,
		DetectMultiplier: &detectMultiplierExtendAttribute,
		MinRxInterval: &minRxIntervalExtendAttribute,
		MinTxInterval: &minTxIntervalExtendAttribute,
	}
	request.Body = &model.UpdateExtendAttributeRequestBody{
		ExtendAttribute: extendAttributebody,
	}
	response, err := client.UpdateExtendAttribute(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

OK

错误码

请参见错误码

相关文档