专线接入
有奖：语音产品征文挑战赛等你来> HOT
文档中心 > 专线接入 > API 文档 > 数据结构

数据结构

最近更新时间：2024-06-14 01:40:46

我的收藏

本页目录：

AccessPoint

接入点信息。

被如下接口引用：DescribeAccessPoints。

名称 类型 描述
AccessPointName String 接入点的名称。
示例值：成都-A-西区
AccessPointId String 接入点唯一ID。
示例值：ap-chengdu-a-xq
State String 接入点的状态。可用，不可用。
示例值：AVAILABLE
Location String 接入点的位置。
示例值：成都电信西区803DC
LineOperator Array of String 接入点支持的运营商列表。
示例值：["ChinaTelecom"]
RegionId String 接入点管理的大区ID。
示例值：cd
AvailablePortType Array of String 接入点可用的端口类型列表。1000BASE-T代表千兆电口，1000BASE-LX代表千兆单模光口10km，1000BASE-ZX代表千兆单模光口80km,10GBASE-LR代表万兆单模光口10km,10GBASE-ZR代表万兆单模光口80km,10GBASE-LH代表万兆单模光口40km,100GBASE-LR4代表100G单模光口10km
注意：此字段可能返回 null，表示取不到有效值。
示例值：["1000BASE-T", "1000BASE-LX"]
Coordinate Coordinate 接入点经纬度
注意：此字段可能返回 null，表示取不到有效值。
示例值：{"Lat": "0.0", "Lng": "0.0"}
City String 接入点所在城市
注意：此字段可能返回 null，表示取不到有效值。
示例值：成都
Area String 接入点地域名称
注意：此字段可能返回 null，表示取不到有效值。
示例值：华北
AccessPointType String 接入点类型。VXLAN/QCPL/QCAR
注意：此字段可能返回 null，表示取不到有效值。
示例值：VXLAN

BFDInfo

BFD配置信息

被如下接口引用：CreateDirectConnectTunnel, DescribeDirectConnectTunnelExtra, ModifyDirectConnectTunnelExtra。

名称 类型 必选 描述
ProbeFailedTimes Integer 否 健康检查次数
Interval Integer 否 健康检查间隔

BGPStatus

bgp状态信息

被如下接口引用：DescribeDirectConnectTunnelExtra。

名称 类型 描述
TencentAddressBgpState String 腾讯侧主互联IP BGP状态
TencentBackupAddressBgpState String 腾讯侧备互联IP BGP状态

BgpPeer

bgp参数，包括Asn，AuthKey

被如下接口引用：CreateDirectConnectTunnel, DescribeDirectConnectTunnelExtra, DescribeDirectConnectTunnels, ModifyDirectConnectTunnelAttribute, ModifyDirectConnectTunnelExtra。

名称 类型 必选 描述
Asn Integer 否 用户侧BGP ASN
注意：此字段可能返回 null，表示取不到有效值。
AuthKey String 否 用户侧BGP密钥
注意：此字段可能返回 null，表示取不到有效值。

Coordinate

坐标，经维度描述

被如下接口引用：DescribeAccessPoints。

名称 类型 描述
Lat Float 纬度
Lng Float 经度

DirectConnect

物理专线信息列表

被如下接口引用：DescribeDirectConnects。

名称 类型 描述
DirectConnectId String 物理专线ID。
示例值：dc-psjiehij
DirectConnectName String 物理专线的名称。
示例值：test
AccessPointId String 物理专线的接入点ID。
示例值：ap-beijing-c-jxq
State String 物理专线的状态。
申请中：PENDING
申请驳回：REJECTED
待付款：TOPAY
已付款：PAID
建设中：ALLOCATED
已开通：AVAILABLE
删除中 ：DELETING
已删除：DELETED 。
示例值：PENDINGPAY
CreatedTime Timestamp ISO8601 物理专线创建时间。
示例值：2020-12-08 16:57:43
EnabledTime Timestamp ISO8601 物理专线的开通时间。
示例值：2021-01-06 10:39:41
LineOperator String 提供接入物理专线的运营商。ChinaTelecom：中国电信， ChinaMobile：中国移动，ChinaUnicom：中国联通， In-houseWiring：楼内线，ChinaOther：中国其他， InternationalOperator：境外其他。
示例值：In-houseWiring
Location String 本地数据中心的地理位置。
示例值：test
Bandwidth Integer 物理专线接入接口带宽，单位为Mbps。
示例值：1000
PortType String 用户侧物理专线接入端口类型,取值：100Base-T：百兆电口,1000Base-T（默认值）：千兆电口,1000Base-LX：千兆单模光口（10千米）,10GBase-T：万兆电口10GBase-LR：万兆单模光口（10千米），默认值，千兆单模光口（10千米）
示例值：1000Base-LX
CircuitCode String 运营商或者服务商为物理专线提供的电路编码。
注意：此字段可能返回 null，表示取不到有效值。
示例值：1111
RedundantDirectConnectId String 冗余物理专线的ID。
示例值：dc-1234
Vlan Integer 物理专线调试VLAN。默认开启VLAN，自动分配VLAN。
注意：此字段可能返回 null，表示取不到有效值。
示例值：100
TencentAddress String 物理专线调试腾讯侧互联IP。
注意：此字段可能返回 null，表示取不到有效值。
示例值：192.168.1.2
CustomerAddress String 物理专线调试用户侧互联IP。
注意：此字段可能返回 null，表示取不到有效值。
示例值：192.168.1.1
CustomerName String 物理专线申请者姓名。默认从账户体系获取。
注意：此字段可能返回 null，表示取不到有效值。
示例值：test
CustomerContactMail String 物理专线申请者联系邮箱。默认从账户体系获取。
注意：此字段可能返回 null，表示取不到有效值。
示例值：274907341@qq.com
CustomerContactNumber String 物理专线申请者联系号码。默认从账户体系获取。
注意：此字段可能返回 null，表示取不到有效值。
示例值：15802738654
ExpiredTime Timestamp ISO8601 物理专线的过期时间。
注意：此字段可能返回 null，表示取不到有效值。
示例值：2040-01-06 10:39:41
ChargeType String 物理专线计费类型。 NON_RECURRING_CHARGE：一次性接入费用；PREPAID_BY_YEAR：按年预付费。
注意：此字段可能返回 null，表示取不到有效值。
示例值：NON_RECURRING_CHARGE
FaultReportContactPerson String 报障联系人。
注意：此字段可能返回 null，表示取不到有效值。
示例值：test
FaultReportContactNumber String 报障联系电话。
注意：此字段可能返回 null，表示取不到有效值。
示例值：15802738654
TagSet Array of Tag 标签键值对
注意：此字段可能返回 null，表示取不到有效值。
示例值：""
AccessPointType String 物理专线的接入点类型。
示例值：VXLAN
IdcCity String IDC所在城市
注意：此字段可能返回 null，表示取不到有效值。
示例值：成都
ChargeState String 计费状态
注意：此字段可能返回 null，表示取不到有效值。
示例值：NORMAL
StartTime String 物理专线开通时间
注意：此字段可能返回 null，表示取不到有效值。
示例值：2020-12-08 16:57:43
SignLaw Boolean 物理专线是否已签署用户协议
注意：此字段可能返回 null，表示取不到有效值。
示例值：true
LocalZone Boolean 物理专线是否为LocalZone
注意：此字段可能返回 null，表示取不到有效值。
示例值：false
VlanZeroDirectConnectTunnelCount Integer 该物理专线下vlan 0的专用通道数量
注意：此字段可能返回 null，表示取不到有效值。
示例值：0
OtherVlanDirectConnectTunnelCount Integer 该物理专线下非vlan 0的专用通道数量
注意：此字段可能返回 null，表示取不到有效值。
示例值：0
MinBandwidth Integer 物理专线最小带宽
注意：此字段可能返回 null，表示取不到有效值。
示例值：1000

DirectConnectTunnel

专用通道信息列表

被如下接口引用：DescribeDirectConnectTunnels。

名称 类型 描述
DirectConnectTunnelId String 专用通道ID
示例值：dcx-r3sml04o
DirectConnectId String 物理专线ID
示例值：dc-9s5kpgyp
State String 专用通道状态
AVAILABLE:就绪或者已连接
PENDING:申请中
ALLOCATING:配置中
ALLOCATED:配置完成
ALTERING:修改中
DELETING:删除中
DELETED:删除完成
COMFIRMING:待接受
REJECTED:拒绝
示例值：PENDING
DirectConnectOwnerAccount String 物理专线的拥有者，开发商账号 ID
示例值：2407912486
OwnerAccount String 专用通道的拥有者，开发商账号 ID
示例值：2407912486
NetworkType String 网络类型，分别为VPC、BMVPC、CCN
VPC：私有网络 ，BMVPC：黑石网络，CCN：云联网
示例值：VPC
NetworkRegion String VPC地域对应的网络名，如ap-guangzhou
示例值：ap-guangzhou
VpcId String 私有网络统一 ID 或者黑石网络统一 ID
示例值：vpc-aipqhdez
DirectConnectGatewayId String 专线网关 ID
示例值：dcg-r70hz833
RouteType String BGP ：BGP路由 STATIC：静态 默认为 BGP 路由
示例值：STATIC
BgpPeer BgpPeer 用户侧BGP，Asn，AuthKey
RouteFilterPrefixes Array of RouteFilterPrefix 用户侧网段地址
Vlan Integer 专用通道的Vlan
示例值：123
TencentAddress String TencentAddress，腾讯侧互联 IP
示例值：169.254.64.1/29
CustomerAddress String CustomerAddress，用户侧互联 IP
示例值：169.254.64.2/29
DirectConnectTunnelName String 专用通道名称
示例值：测试通道
CreatedTime Timestamp ISO8601 专用通道创建时间
示例值：2018-06-01 14:59:16
Bandwidth Integer 专用通道带宽值
示例值：1000
TagSet Array of Tag 专用通道标签值
NetDetectId String 关联的网络自定义探测ID
注意：此字段可能返回 null，表示取不到有效值。
EnableBGPCommunity Boolean BGP community开关
注意：此字段可能返回 null，表示取不到有效值。
示例值：False
NatType Integer 是否为Nat通道
注意：此字段可能返回 null，表示取不到有效值。
示例值：1
VpcRegion String VPC地域简码，如gz、cd
注意：此字段可能返回 null，表示取不到有效值。
示例值：gz
BfdEnable Integer 是否开启BFD
注意：此字段可能返回 null，表示取不到有效值。
示例值：1
AccessPointType String 专用通道接入点类型
注意：此字段可能返回 null，表示取不到有效值。
示例值：QCPL
DirectConnectGatewayName String 专线网关名称
注意：此字段可能返回 null，表示取不到有效值。
示例值：测试网关
VpcName String VPC名称
注意：此字段可能返回 null，表示取不到有效值。
示例值：测试VPC
TencentBackupAddress String TencentBackupAddress，腾讯侧备用互联 IP
注意：此字段可能返回 null，表示取不到有效值。
示例值：169.254.64.3/29
SignLaw Boolean 专用通道关联的物理专线是否签署了用户协议
注意：此字段可能返回 null，表示取不到有效值。
示例值：True
CloudAttachId String 高速上云服务ID
注意：此字段可能返回 null，表示取不到有效值。
示例值：cas-xxxxxxxx
ShareOrNot Integer 是否共享通道
注意：此字段可能返回 null，表示取不到有效值。
示例值：1

DirectConnectTunnelExtra

专用通道扩展信息

被如下接口引用：DescribeDirectConnectTunnelExtra。

名称 类型 描述
DirectConnectTunnelId String 专用通道ID
示例值：dcx-xxxxxxxx
DirectConnectId String 物理专线ID
示例值：dc-xxxxxxxx
State String 专用通道状态
AVAILABLE:就绪或者已连接
PENDING:申请中
ALLOCATING:配置中
ALLOCATED:配置完成
ALTERING:修改中
DELETING:删除中
DELETED:删除完成
COMFIRMING:待接受
REJECTED:拒绝
示例值：ALLOCATING
DirectConnectOwnerAccount String 物理专线的拥有者，开发商账号 ID
示例值：1233453
OwnerAccount String 专用通道的拥有者，开发商账号 ID
示例值：12343252
NetworkType String 网络类型，分别为VPC、BMVPC、CCN
VPC：私有网络 ，BMVPC：黑石网络，CCN：云联网
示例值：VPC
NetworkRegion String VPC地域对应的网络名，如ap-guangzhou
示例值：ap-guangzhou
VpcId String 私有网络统一 ID 或者黑石网络统一 ID
示例值：vpc-xxxxxxxx
DirectConnectGatewayId String 专线网关 ID
示例值：dcx-xxxxxxxx
RouteType String BGP ：BGP路由 STATIC：静态 默认为 BGP 路由
示例值：STATIC
BgpPeer BgpPeer 用户侧BGP，Asn，AuthKey
RouteFilterPrefixes Array of RouteFilterPrefix 用户侧网段地址
PublicAddresses Array of RouteFilterPrefix 互联网通道公网网段地址
Vlan Integer 专用通道的Vlan
示例值：100
TencentAddress String 腾讯侧互联 IP
示例值：192.168.1.1/29
TencentBackupAddress String 腾讯侧备用互联IP
示例值：192.168.1.2/29
CustomerAddress String 用户侧互联 IP
示例值：192.168.1.3/29
DirectConnectTunnelName String 专用通道名称
示例值：通道
CreatedTime Timestamp ISO8601 专用通道创建时间
示例值：2020-09-23 00:00:00
Bandwidth Integer 专用通道带宽值
示例值：2020-09-23 00:00:00
NetDetectId String 关联的网络自定义探测ID
示例值：netid-xxxxxxxx
EnableBGPCommunity Boolean BGP community开关
示例值：true
NatType Integer 是否为Nat通道
示例值：1
VpcRegion String VPC地域简码，如gz、cd
示例值：gz
BfdEnable Integer 是否开启BFD
示例值：1
NqaEnable Integer 是否开启NQA
示例值：1
AccessPointType String 专用通道接入点类型
示例值：1
DirectConnectGatewayName String 专线网关名称
示例值：网关
VpcName String VPC名称
示例值：VPC
SignLaw Boolean 专用通道关联的物理专线是否签署了用户协议
示例值：true
BfdInfo BFDInfo BFD配置信息
NqaInfo NQAInfo NQA配置信息
BgpStatus BGPStatus BGP状态
IPv6Enable Integer 是否开启IPv6
注意：此字段可能返回 null，表示取不到有效值。
示例值：1
TencentIPv6Address String 腾讯侧互联IPv6地址
注意：此字段可能返回 null，表示取不到有效值。
示例值：2402:4e00:4011:1004::5/126
TencentBackupIPv6Address String 腾讯侧备用互联IPv6地址
注意：此字段可能返回 null，表示取不到有效值。
示例值：2402:4e00:4011:1004::5/126
BgpIPv6Status BGPStatus BGPv6状态
注意：此字段可能返回 null，表示取不到有效值。
CustomerIPv6Address String 用户侧互联IPv6地址
注意：此字段可能返回 null，表示取不到有效值。
示例值：2402:4e00:4011:1004::5/126
JumboEnable Integer 专用通道是否支持巨帧。1 支持，0 不支持
注意：此字段可能返回 null，表示取不到有效值。
示例值：1
HighPrecisionBFDEnable Integer 专用通道是否支持高精度BFD。1支持，0不支持
注意：此字段可能返回 null，表示取不到有效值。
示例值：1

DirectConnectTunnelRoute

专用通道路由

被如下接口引用：DescribePublicDirectConnectTunnelRoutes。

名称 类型 描述
RouteId String 专用通道路由ID
示例值：dcxr-69sg663r
DestinationCidrBlock String 网段CIDR
示例值：10.0.0.0/16
RouteType String 路由类型：BGP/STATIC路由
示例值：BGP
Status String ENABLE：路由启用，DISABLE：路由禁用
示例值：ENABLE
ASPath Array of String ASPath信息
示例值：['123', '342']
NextHop String 路由下一跳IP
示例值：0.0.0.0

Filter

用于条件过滤查询

被如下接口引用：DescribeDirectConnectTunnels, DescribeDirectConnects, DescribeInternetAddress, DescribePublicDirectConnectTunnelRoutes。

名称 类型 必选 描述
Name String 是 需要过滤的字段。
Values Array of String 是 字段的过滤值。

InternetAddressDetail

互联网地址详细信息

被如下接口引用：DescribeInternetAddress。

名称 类型 描述
InstanceId String 互联网地址ID
注意：此字段可能返回 null，表示取不到有效值。
Subnet String 互联网网络地址
注意：此字段可能返回 null，表示取不到有效值。
MaskLen Integer 网络地址掩码长度
注意：此字段可能返回 null，表示取不到有效值。
AddrType Integer 0:BGP
1:电信
2:移动
3:联通
注意：此字段可能返回 null，表示取不到有效值。
Status Integer 0:使用中
1:已停用
2:已退还
ApplyTime String 申请时间
注意：此字段可能返回 null，表示取不到有效值。
StopTime String 停用时间
注意：此字段可能返回 null，表示取不到有效值。
ReleaseTime String 退还时间
注意：此字段可能返回 null，表示取不到有效值。
Region String 地域信息
注意：此字段可能返回 null，表示取不到有效值。
AppId Integer 用户ID
注意：此字段可能返回 null，表示取不到有效值。
AddrProto Integer 0:IPv4 1:IPv6
注意：此字段可能返回 null，表示取不到有效值。
ReserveTime Integer 释放状态的IP地址保留的天数
注意：此字段可能返回 null，表示取不到有效值。

InternetAddressStatistics

互联网公网地址统计

被如下接口引用：DescribeInternetAddressStatistics。

名称 类型 描述
Region String 地域
注意：此字段可能返回 null，表示取不到有效值。
SubnetNum Integer 互联网公网地址数量
注意：此字段可能返回 null，表示取不到有效值。

NQAInfo

nqa配置信息

被如下接口引用：CreateDirectConnectTunnel, DescribeDirectConnectTunnelExtra, ModifyDirectConnectTunnelExtra。

名称 类型 必选 描述
ProbeFailedTimes Integer 否 健康检查次数
Interval Integer 否 健康检查间隔
DestinationIp String 否 健康检查地址

RouteFilterPrefix

用户侧网段地址

被如下接口引用：CreateDirectConnectTunnel, DescribeDirectConnectTunnelExtra, DescribeDirectConnectTunnels, ModifyDirectConnectTunnelAttribute, ModifyDirectConnectTunnelExtra。

名称 类型 必选 描述
Cidr String 否 用户侧网段地址
注意：此字段可能返回 null，表示取不到有效值。

Tag

标签键值对

被如下接口引用：DescribeDirectConnectTunnels, DescribeDirectConnects。

名称 类型 描述
Key String 标签键
注意：此字段可能返回 null，表示取不到有效值。
Value String 标签值
注意：此字段可能返回 null，表示取不到有效值。
中国站