文档首页/ 云专线 DC/ API参考/ API/ 虚拟接口/ 修改虚拟接口可靠性检测的扩展参数 - UpdateExtendAttribute
更新时间：2025-12-05 GMT+08:00
在线调试
CLI示例
查看PDF
分享

修改虚拟接口可靠性检测的扩展参数 - 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

检测的重试次数

最小值：3

最大值：20

缺省值：5

min_rx_interval

Integer

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

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

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

最小值：200

最大值：5000

缺省值：1000

min_tx_interval

Integer

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

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

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

最小值：200

最大值：5000

缺省值：1000

remote_disclaim

Integer

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

最小值：1

最大值：16384

local_disclaim

Integer

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

最小值：1

最大值：16384

ipv6_remote_disclaim

Integer

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

最小值：1

最大值：16384

ipv6_local_disclaim

Integer

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

最小值：1

最大值：16384

请求示例

修改虚拟接口可靠性检测方式为自动单跳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_multipier" : 3
  }
}

响应示例

状态码：200

OK

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

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

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： 虚拟接口

相关文档