最近更新时间：2024.04.18 19:01:51
首次发布时间：2022.03.25 07:38:20
调用DescribeDirectConnectVirtualInterfaces查询符合要求的虚拟接口的详细信息。
VirtualInterfaceIds，则会按照传入的其他参数查询，返回符合条件的虚拟接口。| 名称 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | DescribeDirectConnectVirtualInterfaces | 要执行的操作，取值为DescribeDirectConnectVirtualInterfaces。 |
| Version | String | 是 | 2020-04-01 | API版本信息。 |
VirtualInterfaceIds.N | List of String | 否 | VirtualInterfaceIds.1= dcv-7qthudw0ll6jmc****&VirtualInterfaceIds.2=dcv-13fszmm1xdssg3n6nu4x9**** | 虚拟接口的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 | 列表的页码。
|
| PageSize | Integer | 否 | 20 | 分页查询时每页的行数。最大值为100，默认值为20。 |
Status | String | 否 | Available | 虚拟接口的状态。
|
TagFilters.N.Key | String | 是 | TagFilters.1.Key=key1&TagFilters.2.Key=key2&TagFilters.3.Key=key3 | 云资源实例的标签键（Key）。
|
TagFilters.N.Values.N | String | 否 | TagFilters.1.Values.1=value1&TagFilters.2.Values.2=value2&TagFilters.3.Values.3=value3 | 云资源实例的标签值（Value）。
|
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| RequestId | String | 20211222112033010224**** | 请求ID。 |
| TotalCount | Integer | 10 | 满足指定条件的虚拟接口总数。 |
| PageNumber | Integer | 1 | 当前页码。 |
| PageSize | Integer | 20 | 当前分页的行数。 |
| VirtualInterfaces | Array of struct | - | 虚拟接口的详细信息。具体请参见下表“ VirtualInterface ”。 |
VirtualInterface
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| 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 | 虚拟接口的状态。
|
EnableBfd | Boolean | true | 是否开启BFD检测。
|
| BfdDetectInterval | Integer | 1000 | BFD检测时间间隔，单位：ms。 |
| BfdDetectMultiplier | Integer | 3 | BFD检测次数。 |
| Bandwidth | Integer | 100 | 虚拟接口的限速带宽，单位：Mbps。 |
| Tags | Array of struct | - | 虚拟接口已添加的全部标签信息。具体请参见下表“Tag”。 |
EnableNqa | Boolean | false | 是否开启了NQA检测功能。
|
| NqaDetectInterval | Integer | 0 | NQA检测发送连续探测报文的时间间隔。 |
| NqaDetectMultiplier | Integer | 0 | NQA检测的时间次数，若NQA检测连续失败次数达到设定的检测次数，则判定此线路故障。 |
| LocalIpv6Ip | String | fe80:XX::1/120 | 虚拟接口本端网关互联IP的IPv6地址。 |
| PeerIpv6Ip | String | fe80:XX::2/120 | 虚拟接口对端网关互联IP的IPv6地址。 |
Tag
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Key | String | key1 | 标签键。 |
| Value | String | value1 | 标签值。 |
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, "Tags":[ { "Key":"k1", "Value":"v1" }, { "Key":"k2", "Value":"v2" } ] } ] } }
此处仅展示当前API的错误码，更多错误码请参见公共错误码。
| HttpCode | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 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. | 指定标签过滤项的索引顺序参数格式不合法。 |