DescribeDirectConnectVirtualInterfaceAttributes--专线连接-火山引擎

文档中心

立即注册

导航

DescribeDirectConnectVirtualInterfaceAttributes

最近更新时间：2024.05.22 15:20:29首次发布时间：2022.03.25 07:38:20

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

调试

API Explorer

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

去调试

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	DescribeDirectConnectVirtualInterfaceAttributes	要执行的操作，取值：DescribeDirectConnectVirtualInterfaceAttributes。
Version	String	是	2020-04-01	API版本信息。
VirtualInterfaceId	String	是	dcv-7qthudw0ll6jmc****	要查询的虚拟接口的ID。您可调用DescribeDirectConnectVirtualInterfaces查询虚拟接口的ID。

返回数据

名称	类型	示例值	描述
RequestId	String	2021111616110801021214619****	请求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：可用
EnableBfd	Boolean	false	是否开启BFD检测。 true：开启 false：未开启
BfdDetectInterval	Integer	1000	BFD检测时间间隔，单位：ms。
BfdDetectMultiplier	Integer	3	BFD检测次数。
Bandwidth	Integer	100	虚拟接口的限速带宽，单位：Mbps。
Tags	Array of struct	-	虚拟接口已添加的全部标签信息。具体请参见下表“Tag”。
EnableNqa	Boolean	false	是否开启了NQA检测功能。 true：已开启 false（默认）：未开启仅`RouteType`为`Static`时，支持开启NQA检测功能。
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****	虚拟接口所属火山引擎账号。

Tag

名称	类型	示例值	描述
Key	String	key1	标签键。
Value	String	value1	标签值。

请求示例

GET /?Action=DescribeDirectConnectVirtualInterfaceAttributes&Version=2020-04-01&VirtualInterfaceId=dcv-7qthudw0ll6jmc**** HTTP/1.1
Host: open.volcengineapi.com
ServiceName: directconnect
Region: cn-beijing

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2021111616110801021214619****",
        "Action": "DescribeDirectConnectVirtualInterfaceAttributes",
        "Version": "2020-04-01",
        "Service": "directconnect",
        "Region": "cn-beijing"
    },
    "Result": {
        "RequestId": "2021111616110801021214619****",
        "AccountId":"210000****",
        "VirtualInterfaceId":"dcv-7qthudw0ll6jmc****",
        "VirtualInterfaceName":"test",
        "Description":"test",
        "DirectConnectConnectionId":"dcc-3tehy13n2l4c6c0v****",
        "DirectConnectGatewayId":"dcg-2fe3zsmkshs59g****",
        "RouteType":"BGP",
        "VlanId":2000,
        "LocalIp":"192.XX.XX.10/24",
        "PeerIp":"192.XX.XX.10/24",
        "CreationTime": "2021-12-15T17:05:42+08:00",
        "UpdateTime": "2021-12-17T11:50:30+08:00",
        "Status": "Available",
        "Bandwidth": 100,
        "EnableBfd": "true",
        "BfdDetectInterval": 1000,
        "BfdDetectMultiplier": 3,
        "LocalIpv6Ip": "fe80:XX::1/120",
        "PeerIpv6Ip": "fe80:XX::2/120",  
        "EnableNqa": "false",
        "NqaDetectInterval": 0,
        "NqaDetectMultiplier": 0,
        "OwnerAccountId": "21000522****",
        "Tags":[ 
						{	
						 "Key":"k1",	
						 "Value":"v1"	
						},	
						{	
						 "Key":"k2",	
						 "Value":"v2"
						}	
				]
    }
}

错误码

此处仅展示当前API的错误码，更多错误码请参见公共错误码。

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