调用DescribeDirectConnectVirtualInterfaces查询符合要求的虚拟接口的详细信息。

使用说明

若请求参数不传入VirtualInterfaceIds，则会按照传入的其他参数查询，返回符合条件的虚拟接口。

若请求参数中的非必选参数都不传入，则会按照当前登录账户查询，返回当前账户下所有的虚拟接口。

调试

API Explorer

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

去调试

请求参数

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

Action String 必选示例值：DescribeDirectConnectVirtualInterfaces

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

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

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

VirtualInterfaceIds.N String 可选示例值：dcv-7qthudw0ll6jmc****

虚拟接口的ID。

参数 - N：表示虚拟接口 ID的序号，单次调用数量上限100个。

多个虚拟接口 ID之间用&分隔。

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

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

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

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

VirtualInterfaceName String 可选示例值：test

虚拟接口的名称。

RouteType String 可选示例值：BGP

虚拟接口的路由类型。

VlanId Integer 可选示例值：2000

虚拟接口的VLAN ID。

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

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

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

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

PageNumber Integer 可选示例值：1

列表的页码。

如需传入此参数，请传入非负整数。

不传或传入0，则均默认为1。

PageSize Integer 可选示例值：20

分页查询时每页的行数。最大值为100，默认值为20。

Status String 可选示例值：Available

虚拟接口的状态。

Creating: 创建中

Deleting: 删除中

Pending：配置中

Available：可用

TagFilters.N.Key String 可选示例值：key1

云资源实例的标签键（Key）。

参数 - N：表示标签键的序号，取值范围：1～10。

多个标签键之间用&分隔。

如果传入多个TagFilters.N.Key，多个TagFilters.N.Key之间的关系为逻辑“与（AND）”，不允许重复。

TagFilters.N.Values.M String 可选示例值：value1

云资源实例的标签值（Value）。

参数 - N：表示标签键的序号，取值范围：1～10。

参数 - M：表示标签值的序号，取值范围：1～3，即同一标签键最多支持同时查询3个标签值。

多个标签值之间用&分隔。

如果传入该参数，则必须先传入TagFilters.N.Key。

如果不传该参数仅传入TagFilters.N.Key，表示查询同一标签键下的所有标签值。

传入空字符串时，表示查询标签值为空的标签。

如果同一个TagFilters.N.Key传入多个TagFilters.N.Values.M，多个TagFilters.N.Values.M之间的关系为逻辑“或(OR)”。

GatewayType String 可选示例值：DXGW

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

DCGW：专线网关

DXGW：全域网关

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

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

返回参数

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

TotalCount Integer 示例值：10

满足指定条件的虚拟接口总数。

PageNumber Integer 示例值：1

当前页码。

PageSize Integer 示例值：20

当前分页的行数。

VirtualInterfaces Object[] 示例值：-

虚拟接口的详细信息。

Tags Object[] 示例值：-

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

Key String 示例值：k1

标签键。

Value String 示例值：v1

标签值。

PeerIp String 示例值：200.30.0.101/24

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

Status String 示例值：Available

虚拟接口的状态。

Creating: 创建中

Deleting: 删除中

Pending：配置中

Available：可用

VlanId Integer 示例值：325

虚拟接口的VLAN ID。

LocalIp String 示例值：200.30.0.100/24

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

AccountId String 示例值：20******57

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

Bandwidth Integer 示例值：10000

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

EnableBfd Boolean 示例值：false

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

true：开启

false：未开启

EnableNqa Boolean 示例值：false

是否开启了NQA检测功能。

true：已开启

false：未开启

仅RouteType为Static时，支持开启NQA检测功能。

RouteType String 示例值：BGP

虚拟接口的路由类型。

DxgwStatus String 示例值：Available

全域网关的状态。

Creating：创建中

Deleting：删除中

Pending：配置中

Available：可用

PeerIpv6Ip String 示例值：2001:2300:1328:0015:0000:0000:0000:2/126

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

UpdateTime String 示例值：2021-12-08T11:49:06+08:00

更新虚拟接口的时间。

Description String 示例值：a test vif

虚拟接口的描述。

DxgwOwnerId String 示例值：2108892****

虚拟接口关联的全域网关所属账号。

GatewayType String 示例值：DCGW

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

DCGW：专线网关

DXGW：全域网关

LocalIpv6Ip String 示例值：2001:2300:1328:0015:0000:0000:0000:1/126

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

CreationTime String 示例值：2021-11-15T14:53:24+08:00

创建虚拟接口的时间。

EnableBfdEcho Boolean 示例值：false

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

true：开启

false：未开启

OwnerAccountId String 示例值：2108892****

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

BfdDetectInterval Integer 示例值：1000

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

NqaDetectInterval Integer 示例值：2000

NQA检测发送连续探测报文的时间间隔，单位：ms。

VirtualInterfaceId String 示例值：dcv-273w1tcbdf***

虚拟接口的ID。

BfdDetectMultiplier Integer 示例值：3

BFD检测次数。

NqaDetectMultiplier Integer 示例值：5

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

VirtualInterfaceName String 示例值：VIF-sj2x

虚拟接口的名称。

DirectConnectGatewayId String 示例值：dcg-273w1ti8gr***

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

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

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

DirectConnectConnectionId String 示例值：dcc-274342y***

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

请求示例

返回示例

错误码

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

状态码	错误码	错误信息	说明
400	LimitExceeded.DirectConnectVirtualInterfaceId	You've reached the limit on the number of virtual interface IDs that you can describe.	已达到可查询的虚拟接口ID数量上限。
400	InvalidPage.Malformed	The specified page is malformed.	指定的分页参数不合法。
400	InvalidTagFilterKey.Malformed	The specified parameter tag filter key is invalid.	过滤标签键不合法。
400	InvalidTagFilterValue.Malformed	The specified parameter tag filter value is invalid.	过滤标签值不合法。
400	LimitExceeded.TagFilterKey	You've reached the limit on the number of tag keys that you can filter.	已达到单次可指定过滤标签键数量的上限。
400	LimitExceeded.TagFilterValue	You've reached the limit on the number of tag values that you can filter.	已达到单次可指定过滤标签值数量的上限。
400	InvalidTagFilter.Disorder	The specified index order of tag filter is malformed.	指定标签过滤项的索引顺序参数格式不合法。

专线连接