Help Center/ Direct Connect/ API Reference/ API/ Virtual Interfaces/ Updating Extended Parameters for Reliability Detection on a Virtual Interface

Updated on 2025-12-15 GMT+08:00

Online Debugging

CLI Examples

View PDF

Updating Extended Parameters for Reliability Detection on a Virtual Interface

Function

This API is used to update extended parameters for reliability on a virtual interface, such as min_rx_interval, min_tx_interval, and detect_multiplier.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the project ID. Minimum: 0 Maximum: 36
virtual_interface_id	Yes	String	Specifies the virtual interface ID. Minimum: 0 Maximum: 36

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

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
request_id	String	Specifies the request ID.
extend_attribute	VifExtendAttribute object	Specifies extended parameters when BFD or NQA is used for reliability detection.

**Table 4** VifExtendAttribute
Parameter	Type	Description
ha_type	String	Specifies the availability detection type of the virtual interface. The value can be: nqa: network quality analysis bfd: bidirectional forwarding detection
ha_mode	String	Specifies the availability detection mode of the virtual interface. The value can be: auto_single: automatic single-hop BFD auto_multi: automatic multi-hop BFD static_single: static single-hop BFD static_multi: static multi-hop BFD enhance_nqa: enhanced NQA
detect_multiplier	Integer	Specifies the number of detection retries. Minimum: 3 Maximum: 20 Default: 5
min_rx_interval	Integer	Specifies how often the system receives detection packets, in milliseconds. If you set ha_type to nqa, the system rounds up your input time to the nearest full second. For instance, entering 1500 milliseconds sets the interval to 2 seconds. If you set ha_type to bfd, the system uses the input time (in milliseconds) as the interval. The value ranges from 200 ms to 1000 ms. Minimum: 200 Maximum: 5000 Default: 1000
min_tx_interval	Integer	Specifies how often the system sends detection packets, in milliseconds. If you set ha_type to nqa, the system rounds up your input time to the nearest full second. For instance, entering 1500 milliseconds sets the interval to 2 seconds. If you set ha_type to bfd, the system uses the input time (in milliseconds) as the interval. The value ranges from 200 ms to 1000 ms. Minimum: 200 Maximum: 5000 Default: 1000
remote_disclaim	Integer	Specifies the remote identifier of the static BFD session. Minimum: 1 Maximum: 16384
local_disclaim	Integer	Specifies the local identifier of the static BFD session. Minimum: 1 Maximum: 16384
ipv6_remote_disclaim	Integer	Specifies the remote identifier of the static IPv6 BFD session. Minimum: 1 Maximum: 16384
ipv6_local_disclaim	Integer	Specifies the local identifier of the static IPv6 BFD session. Minimum: 1 Maximum: 16384

Example Requests

Updating ha_type to bfd, ha_mode to auto_single, min_rx_interval to 500, min_tx_interval to 500, and detect_multiplier to 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
  }
}

Example Responses

Status code: 200

Specifies the response body for updating the extended parameters of the virtual interface reliability detection.

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