You need to enable JavaScript to run this app.
导航
DescribeDirectConnectVirtualInterfaces
最近更新时间:2024.05.22 15:20:29首次发布时间:2022.03.25 07:38:20

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

调用说明

  • 若请求参数不传入VirtualInterfaceIds,则会按照传入的其他参数查询,返回符合条件的虚拟接口。
  • 若请求参数中的非必选参数都不传入,则会按照当前登录账户查询,返回当前账户下所有的虚拟接口。

调试

请求参数

名称类型是否必选示例值描述
ActionStringDescribeDirectConnectVirtualInterfaces要执行的操作,取值为DescribeDirectConnectVirtualInterfaces。
VersionString2020-04-01API版本信息。

VirtualInterfaceIds.N

List of String

VirtualInterfaceIds.1= dcv-7qthudw0ll6jmc****&VirtualInterfaceIds.2=dcv-13fszmm1xdssg3n6nu4x9****

虚拟接口的ID。

  • 参数 - N:表示虚拟接口 ID的序号,单次调用数量上限100个。
  • 多个虚拟接口 ID之间用&分隔。
DirectConnectConnectionIdStringdcc-3tehy13n2l4c6c0v****虚拟接口关联物理专线的ID。
DirectConnectGatewayIdStringdcg-2fe3zsmkshs59g****虚拟接口关联专线网关的ID。
VirtualInterfaceNameStringtest虚拟接口的名称。
RouteTypeStringBGP虚拟接口的路由类型。
VlanIdInteger2000虚拟接口的VLAN ID。
LocalIpString192.XX.XX.10/24虚拟接口的本端网关互联IP地址。
PeerIpString192.XX.XX.20/24虚拟接口的对端网关互联IP地址。

PageNumber

Integer

1

列表的页码。

  • 如需传入此参数,请传入非负整数。
  • 不传或传入0,则均默认为1。
PageSizeInteger20分页查询时每页的行数。最大值为100,默认值为20。

Status

String

Available

虚拟接口的状态。

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

TagFilters.N.Key

String

TagFilters.1.Key=key1&TagFilters.2.Key=key2&TagFilters.3.Key=key3

云资源实例的标签键(Key)。

  • 参数 - N - 参数:表示标签的序号,取值范围:1、2、3、……、9、10,且N应按照连续的从小到大的顺序。
  • 多个标签键之间用&分隔。
  • 如果传入多个TagFilters.N.Key,多个TagFilters.N.Key之间的关系为逻辑“与(AND)”。

TagFilters.N.Values.N

String

TagFilters.1.Values.1=value1&TagFilters.2.Values.2=value2&TagFilters.3.Values.3=value3

云资源实例的标签值(Value)。

  • 参数 - N - 参数- N :第一个N表示标签值对应标签键的序号,应与标签键TagFilters.N.Key的序号保持一致,取值范围:1、2、3、……、9、10,且N应按照连续的从小到大的顺序。第二个N表示标签值的序号,取值范围:1、2、3。
  • 可不传入Value,表示查询时对Value不作限制。
  • 如果传入的Value是空字符串,表示查询 Value 为空的标签。
  • 如果同一个TagFilters.N.Key传入多个TagFilters.N.Values.N,多个TagFilters.N.Values.N之间的关系为逻辑“或(OR)”。

返回数据

名称类型
示例值
描述
RequestIdString20211222112033010224****请求ID。
TotalCountInteger10满足指定条件的虚拟接口总数。
PageNumberInteger1当前页码。
PageSizeInteger20当前分页的行数。
VirtualInterfacesArray of struct-虚拟接口的详细信息。具体请参见下表“ VirtualInterface ”。

VirtualInterface

名称类型
示例值
描述
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

true

是否开启BFD检测。

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

EnableNqa

Boolean

false

是否开启了NQA检测功能。

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

Tag

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

请求示例

GET /?Action=DescribeDirectConnectVirtualInterfaces&Version=2020-04-01&DirectConnectGatewayIds.1=dcg-7qthudw0ll6jmc****&PageNumber=1&PageSize=20 HTTP/1.1
Host: open.volcengineapi.com
ServiceName: directconnect
Region: cn-beijing

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20211222112033010224****",
        "Action": "DescribeDirectConnectVirtualInterfaces",
        "Version": "2020-04-01",
        "Service": "directconnect",
        "Region": "cn-beijing"
    },
    "Result": {
        "RequestId": "20211222112033010224****",
        "PageNumber": 1,
        "PageSize": 20,
        "TotalCount": 1,
        "VirtualInterfaces": [
            {
                "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.20/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
错误码
错误信息
描述
400LimitExceeded.DirectConnectVirtualInterfaceIdYou've reached the limit on the number of virtual interface IDs that you can describe.已达到可查询的虚拟接口ID数量上限。
400InvalidPage.MalformedThe specified page is malformed.指定的分页参数不合法。
400InvalidTagFilterKey.MalformedThe specified parameter tag filter key is invalid.过滤标签键不合法。
400InvalidTagFilterValue.MalformedThe specified parameter tag filter value is invalid.过滤标签值不合法。
400LimitExceeded.TagFilterKeyYou've reached the limit on the number of tag keys that you can filter.已达到单次可指定过滤标签键数量的上限。
400LimitExceeded.TagFilterValueYou've reached the limit on the number of tag values that you can filter.已达到单次可指定过滤标签值数量的上限。
400InvalidTagFilter.DisorderThe specified index order of tag filter is malformed.指定标签过滤项的索引顺序参数格式不合法。