You need to enable JavaScript to run this app.
导航

DescribeDirectConnectVirtualInterfaceAttributes

最近更新时间2024.04.18 19:01:51

首次发布时间2022.03.25 07:38:20

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

调试

请求参数

名称类型是否必选示例值描述
ActionStringDescribeDirectConnectVirtualInterfaceAttributes要执行的操作,取值:DescribeDirectConnectVirtualInterfaceAttributes。
VersionString2020-04-01API版本信息。
VirtualInterfaceIdStringdcv-7qthudw0ll6jmc****要查询的虚拟接口的ID。您可调用DescribeDirectConnectVirtualInterfaces查询虚拟接口的ID。

返回数据

名称类型
示例值
描述
RequestIdString2021111616110801021214619****请求ID。
AccountIdString21000*****虚拟接口所属账号的ID。
VirtualInterfaceIdStringdcv-7qthudw0ll6jmc****虚拟接口的ID。
VirtualInterfaceNameStringtest虚拟接口的名称。
DescriptionStringThis is a sample description虚拟接口的描述。
DirectConnectConnectionIdStringdcc-3tehy13n2l4c6c0v****虚拟接口关联的物理专线的ID。
DirectConnectGatewayIdStringdcg-2fe3zsmkshs59g****虚拟接口关联的专线网关的ID。
RouteTypeStringBGP虚拟接口的路由类型。
VlanIdInteger2000虚拟接口的VLAN ID。
LocalIpString192.XX.XX.10/24虚拟接口的本端网关互联IP地址。
PeerIpString192.XX.XX.20/24虚拟接口的对端网关互联IP地址。
CreationTimeString2021-04-09T08:36:47+08:00创建虚拟接口的时间。
UpdateTimeString2021-04-10T09:18:28+08:00更新虚拟接口的时间。

Status

String

Available

虚拟接口的状态。

  • Creating: 创建中
  • Deleting: 删除中
  • Pending:配置中
  • Available:可用

EnableBfd

Boolean

false

是否开启BFD检测。

  • true:开启
  • false:未开启
BfdDetectIntervalInteger1000BFD检测时间间隔,单位:ms。
BfdDetectMultiplierInteger3BFD检测次数。
BandwidthInteger100虚拟接口的限速带宽,单位:Mbps。
TagsArray of struct-虚拟接口已添加的全部标签信息。具体请参见下表“Tag”。

EnableNqa

Boolean

false

是否开启了NQA检测功能。

  • true:已开启
  • false(默认):未开启
    RouteTypeStatic时,支持开启NQA检测功能。
NqaDetectIntervalInteger3000NQA检测发送连续探测报文的时间间隔。
NqaDetectMultiplierInteger8NQA检测的时间次数,若NQA检测连续失败次数达到设定的检测次数,则判定此线路故障。
LocalIpv6IpStringfe80:XX::1/120虚拟接口本端网关互联IP的IPv6地址。
PeerIpv6IpStringfe80:XX::2/120虚拟接口对端网关互联IP的IPv6地址。

Tag

名称类型示例值描述
KeyStringkey1标签键。
ValueStringvalue1标签值。

请求示例

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,
        "Tags":[ 
						{	
						 "Key":"k1",	
						 "Value":"v1"	
						},	
						{	
						 "Key":"k2",	
						 "Value":"v2"
						}	
				]
    }
}

错误码

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

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