调用DescribeDirectConnectVirtualInterfaceAttributes查询指定虚拟接口的详细信息。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action String 必选示例值：DescribeDirectConnectVirtualInterfaceAttributes

接口名称。当前 API 的名称为 DescribeDirectConnectVirtualInterfaceAttributes。

Version String 必选示例值：2020-04-01

接口版本。当前 API 的版本为 2020-04-01。

VirtualInterfaceId String 必选示例值：dcv-7qthudw0ll6jmc****

要查询的虚拟接口的ID。您可调用DescribeDirectConnectVirtualInterfaces查询虚拟接口的ID。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

AccountId String 示例值：21000*****

当前的火山引擎账号的ID。

VirtualInterfaceId String 示例值：dcv-7qthudw0ll6jmc****

虚拟接口的ID。

VirtualInterfaceName String 示例值：test

虚拟接口的名称。

Description String 示例值：This is a sample description

虚拟接口的描述。

DirectConnectConnectionId String 示例值：dcc-3tehy13n2l4c6c0v****

虚拟接口关联的物理专线的ID。

DirectConnectGatewayId String 示例值：dcg-2fe3zsmkshs59g****

虚拟接口关联的专线网关的ID。

RouteType String 示例值：BGP

虚拟接口的路由类型。

VlanId Integer 示例值：2000

虚拟接口的VLAN ID。

LocalIp String 示例值：192.XX.XX.10/24

虚拟接口的本端网关互联IP地址。

PeerIp String 示例值：192.XX.XX.20/24

虚拟接口的对端网关互联IP地址。

CreationTime String 示例值：2021-04-09T08:36:47+08:00

创建虚拟接口的时间。

UpdateTime String 示例值：2021-04-10T09:18:28+08:00

更新虚拟接口的时间。

Status String 示例值：Available

虚拟接口的状态。

Creating: 创建中

Deleting: 删除中

Pending：配置中

Available：可用

BfdDetectInterval Integer 示例值：1000

BFD检测时间间隔，单位：ms。

BfdDetectMultiplier Integer 示例值：3

BFD检测次数。

Bandwidth Integer 示例值：100

虚拟接口的限速带宽，单位：Mbps。

Tags Object[] 示例值：-

虚拟接口已添加的全部标签信息。

Key String 示例值：k1

标签键。

Value String 示例值：v1

标签值。

EnableNqa Boolean 示例值：false

是否开启了NQA检测功能。

true：已开启

false：未开启

NqaDetectInterval Integer 示例值：3000

NQA检测发送连续探测报文的时间间隔。

NqaDetectMultiplier Integer 示例值：8

NQA检测的时间次数，若NQA检测连续失败次数达到设定的检测次数，则判定此线路故障。

LocalIpv6Ip String 示例值：fe80:XX::1/120

虚拟接口本端网关互联IP的IPv6地址。

PeerIpv6Ip String 示例值：fe80:XX::2/120

虚拟接口对端网关互联IP的IPv6地址。

OwnerAccountId String 示例值：21000522****

虚拟接口所属火山引擎账号。

EnableBfd Boolean 示例值：false

是否开启BFD检测。

true：已开启

false：未开启

EnableBfdEcho Boolean 示例值：false

是否开启BFD检测echo报文模式。

true：已开启

false：未开启

DirectExchangeGatewayId String 示例值：dxg-273w1ti8gr***

虚拟接口关联的全域网关ID。

DxgwOwnerId String 示例值：2108892****

全域网关资源所属的账号。

DxgwStatus String 示例值：Available

全域网关的状态。

Creating：创建中

Deleting：删除中

Pending：配置中

Available：可用

GatewayType String 示例值：DCGW

虚拟接口关联的网关类型。

DCGW：专线网关

DXGW：全域网关

请求示例

返回示例

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
404	InvalidDirectConnectVirtualInterface.NotFound	The specified direct connect virtual interface does not exist.	指定的虚拟接口不存在。

专线连接