数据结构

PortInfo

描述端口基本信息，包括名称、商业实体名称、数据中心相关等。

名称	类型	描述
portId	String	端口 的Id。
portName	String	端口 的名称。
portRemarks	String	端口 的备注。
portType	String	端口 规格。 取值范围：1G\10G\40G
connectionStatus	ConnectionStatus	端口 连通性的状态。
portStatus	PortStatus	端口 业务状态。
dcId	String	数据中心 的Id。
dcName	String	数据中心 的名称。
cityName	String	城市 的名称。
areaName	String	区域 的名称。
loaStatus	LOAStatus	LOA 的状态。
loaDownloadUrl	String	LOA 的下载地址。
createdTime	Timestamp	创建时间。 格式为：YYYY-MM-DDThh:mm:ssZ。
expiredTime	Timestamp	到期时间。 格式为：YYYY-MM-DDThh:mm:ssZ。
portChargeType	String	端口计费类型。 PREPAID：预付费，即包年包月。 POSTPAID：后付费。
period	Integer	购买端口的时长。 单位：月。 后付费实例该字段为null。
businessEntityName	String	商业实体的名称。用于LOA

ConnectionStatus

网络连通性的状态。

状态值	状态说明
ACTIVE	连通
DOWN	不连通

PortStatus

端口的业务状态。

状态值	状态说明
CREATING	创建中
UPDATING	更新中
DELETING	终止中
DESTROYING	销毁中
RECOVERING	恢复中
RUNNING	正常运行中
RECYCLED	已入回收站
DESTROYED	已销毁

PortPrice

描述端口的规格及价格信息。

名称	类型	描述
dcId	String	数据中心 的Id，如SIN1。
portType	String	端口 的规格。 取值范围：1G\10G\40G
portPrice	Price	端口价格。

LOAStatus

LOA的业务状态。

状态值	状态说明
LOA_NOT_UPLOAD	未上传
LOA_UPLOADED	已上传

PortTrafficInfo

描述端口流量信息。

名称	类型	描述
unit	String	流量的单位。取值范围: bps
records	Array of TrafficData	带宽明细。
inMax	Double	in方向 最大值。
inMin	Double	in方向 最小值。
inAvg	Double	in方向 均值。
outMax	Double	out方向 最大值。
outMin	Double	out方向 最小值。
outAvg	Double	out方向 均值。

DatacenterInfo

描述数据中心的信息 。

名称	类型	描述
dcId	String	数据中心四字码
dcName	String	数据中心名称。
dcAddress	String	数据中心地址。
cityName	String	城市名称。
countryName	String	国家名称。
areaName	String	地区名称。
latitude	Float	数据中心所在地理位置的维度。
longitude	Float	数据中心所在地理位置的经度。
isPortAvailable	Boolean	数据中心是否支持物理端口。 该字段仅在 DescribeDatacenters 可取值。

PrivateConnect

描述二层专线网络的信息。包括ID, 连通性， 两端（A/Z）的端点信息。

名称	类型	描述
privateConnectId	String	二层专线网络ID。
privateConnectName	String	二层专线网络名称
connectivityStatus	String	连通性状态。 可用值见：ConnectionStatus
endpointA	PrivateConnectEndpoint	连接点A的基本信息。
endpointZ	PrivateConnectEndpoint	连接点Z的基本信息。
privateConnectStatus	String	专线的业务状态。 可用值见：PrivateConnectStatus
bandwidthMbps	Long	二层专线网络的最大带宽限速。
resourceGroupId	String	所属的资源组ID。
resourceGroupName	String	所属的资源组名称。
createTime	Timestamp	创建时间。
expiredTime	Timestamp	过期时间。 预付费资源可用。
recycledTime	Timestamp	回收时间。

PrivateConnectEndpoint

二层网络中连接点的基本信息。

名称	类型	描述
endpointId	String	连接点的ID。
endpointName	String	连接点的名称。
cloudRegionId	String	公有云区域ID。 有且为Google, Tencent, AWS 类型的接入点可取到值。
cloudAccountId	String	云接入的账号。 有且为Google, Tencent, AWS 类型的接入点可取到值。
endpointType	String	连接点的类型。
dataCenter	DataCenterInfo	连接点所属的数据中心信息。
vlanId	Integer	连接点的VLAN ID。 范围 1～4096。
connectivityStatus	ConnectionStatus	连接点的连通性状态。

PrivateConnectStatus

状态值	状态说明
DEPLOYING	部署中
UPDATING	更新中
DELETING	终止中
DESTROYING	销毁中
RECOVERING	恢复中
RUNNING	运行状态
RECYCLED	已入回收站

CloudRouterStatus

状态值	状态说明
DEPLOYING	部署中
UPDATING	更新中
DELETING	终止中
DESTROYING	销毁中
RECOVERING	恢复中
RUNNING	运行状态
RECYCLED	已入回收站

CreateEndpointParam

创建二层网络的连接点信息。连接点类型分为 Subnet, AWS, Google, Tencent, Azure 不同的连接点所需要的信息不同。

数据中心端口参数信息。

名称	类型	必选	描述
portId	String	是	数据中心端口的ID。
vlanId	Integer	是。	VLAN ID。 可以通过DescribePortUsableVlan 获取到当前端口可用的VLAN ID。

腾讯云 / AWS / Google / AliCloud / Azure 作为接入点所需要参数信息。

名称	类型	必选	描述
cloudAccountId	String	是	云平台账号。 Google 云此处为Pairing Key，如何获取请参考Google云配置。
cloudType	String	是	云连接类型。可选值： AWS TENCENT GOOGLE ALI_CLOUD AZURE
cloudRegionId	String	否	公有云区域ID。 Google云无需传参
dcId	String	是	连接云接入点的数据中心ID。
vlanId	Integer	是	VLAN ID。
haType	HATypeEnum	否	高可用类型。 如果CloudType是AZURE，则此字段为必传。

TrafficData

带宽数据。

名称	类型	描述
internetRX	Integer	入口带宽。单位：bps。
internetTX	Integer	出口带宽。单位：bps。
time	Timestamp	数据时间。 格式为：YYYY-MM-DDThh:mm:ssZ。

EndpointType

端点类型。描述了连接二层网络专线A/Z两端的类型。

枚举值	枚举说明
SUBNET	子网云连接点
GOOGLE	Google 云连接点
TENCENT	Tencent 云连接点
AZURE	Azure 云连接点
ALI_CLOUD	Aliyun 连接点
AWS	AWS 云连接点
AZURE	AZURE 云连接点
PORT	数据中心端口连接点（客户独享）
OTHER_PORT	数据中心端口连接点（客户共享）

Price

价格。描述了购买资源的预付费或后付费价格信息。

名称	类型	描述
originalPrice	Float	预付费的原价。 预付费模式使用，后付费该值为 null。
discountPrice	Float	预付费的折扣价。 预付费模式使用，后付费该值为 null。
discount	Float	折扣大小。 如80.0代表8折。
unitPrice	Float	后付费的单元原始价格。 后付费模式使用，如果价格为阶梯价格，该项为null。
discountUnitPrice	Float	后付费的单元折后价格。 后付费模式使用，如果价格为阶梯价格，该项为null。
chargeUnit	String	后付费计价单元。 后付费模式使用，可取值范围： HOUR: 表示计价单元是按每小时来计算。 DAY: 表示计价单元是按天来计算。 MONTH: 表示计价单元是按月来计算，95计费则是这种。
stepPrices	Array of StepPrice	后付费阶梯价格。 后付费模式使用，如果非阶梯价格，该项为null。

StepPrice

后付费阶梯价格。描述了价格的一个阶梯的信息。

名称	类型	描述
stepStart	Float	阶梯用量的开始。
stepEnd	Float	阶梯用量的结束。
unitPrice	Float	当前阶梯的单元原始价格。 后付费模式使用。
discountUnitPrice	Float	当前阶梯的单元折后价格。 后付费模式使用。

CreateCloudRouterEdgePoint

创建三层网络的连接点信息。根据连接点的类型不同，连接点的参数也是不同的。

CreateVpcEdgePoint

创建三层网络加入VPC 连接点所需要的信息。

名称	类型	必选	描述
vpcId	String	是	裸金属产品内VPC ID。 可以通过DescribeCloudRouterAvailableVpcs接口来获取可以使用的VPC。 一个VPC 只能加入一个三层网络。
bandwidthMbps	Integer	否	接入的带宽大小。 单位： Mbps 默认值为1。

CreateDcPortEdgePoint

创建三层网络加入物理端口所需要的信息。

名称	类型	必选	描述
portId	String	是	物理端口ID。 可以通过接口DescribeCloudRouterAvailablePorts来获取支持三层网络的物理端口。
vlanId	Integer	是	VLAN ID。 查询端口可用的vlan范围， 可以根据DescribePortUsableVlan获取 范围：2-4000
ipAddress	String	是	IP地址信息。
bandwidthMbps	Integer	否	接入的带宽大小。 单位： Mbps 默认值：1 Mbps。
bgpConnection	BGPConnection	否	BGP连接配置信息。 BGP和静态路由配置二者二选其一。
staticRoutes	Array of IpRoute	否	静态路由配置信息。 BGP和静态路由配置二者二选其一。

CreateCloudEdgePoint

创建三层网络加入云（AWS/Tencent/Google/AliCloud/Azure) 接入点所需要的信息。

名称	类型	必选	描述
cloudType	String	是	云连接类型。可选值： AWS TENCENT GOOGLE ALI_CLOUD AZURE
cloudAccountId	String	是	云平台账号。 Google 云此处为Pairing Key，如何获取请参考Google云配置。 Azure 云此处为Service Key。如何获取请参考Azure云配置。
edgePointName	String	否	接入点的名称。 长度范围为1～255个字符。
cloudRegionId	String	否	公有云区域ID。 Google云无需传参
dcId	String	是	连接云接入点的数据中心ID。
vlanId	Integer	是	VLAN ID。 查询端口可用的vlan范围， 可以根据DescribePortUsableVlan获取 范围：2-4000
ipAddress	String	是	IP地址信息。
bandwidthMbps	Integer	否	接入的带宽大小。 单位： Mbps 默认值：1 Mbps。
bgpConnection	BGPConnection	否	BGP连接配置信息。 BGP和静态路由配置二者二选其一。
staticRoutes	Array of IpRoute	否	静态路由配置信息。 BGP和静态路由配置二者二选其一。
haType	HATypeEnum	否	高可用类型。 如果cloudType是AZURE，则此字段为必传。

BGPConnection

BGP 连接的配置信息。

名称	类型	必选	描述
peerIpAddress	String	是	BGP 对等体的 IP 地址。
peerAsn	Integer	是	远程 BGP 对等体的 ASN。 范围为 1 - 4294967294 之间的整数。
localAsn	Integer	否	本地 BGP 的 ASN。 范围为 1 - 4294967294 之间的整数。 配置物理端口、Tencent、Google、AWS连接点的配置信息时不可填，且值为 62610。
password	String	否	用于验证 BGP MD5 认证的对等体的共享密钥。 最多 32 个字符。

IPRoute

静态路由的相关信息。

名称	类型	必选	描述
prefix	String	是	用于路由到下一跳的 IPv4 前缀。
nextHop	String	否	下一跳IPv4地址。 配置物理端口、Tencent、Google、AWS、Azure、Aliyun连接点时该地址必填。

CloudRouter

三层网络的信息。

名称	类型	描述
cloudRouterId	String	三层网络的ID。
cloudRouterName	Integer	三层网络的名称。
cloudRouterDescription	String	三层网络的描述信息。
edgePoints	Array of CloudRouterEdgePoint	三层网络中边缘连接点的信息。
cloudRouterChargeType	String	三层网络的计费类型。 PREPAID：预付费，即包年包月。 POSTPAID：后付费。
createTime	Timestamp	创建时间。
expiredTime	Timestamp	到期时间。 后付费实例该字段取值为null。
recycledTime	Timestamp	销毁的时间。 当删除三层网络后，将会在该时间进行资源的销毁。
period	Integer	购买三层网络的时长。 单位：月。 后付费实例该字段为null。
cloudRouterStatus	CloudRouterStatus	三层网络的状态。
connectivityStatus	String	三层网络的连通性状态。
resourceGroupId	String	三层网络所在资源组ID。
resourceGroupName	String	三层网络所在资源组名称

CloudRouterEdgePoint

三层网络中边缘连接点的信息。

名称	类型	描述
edgePointId	String	边缘连接点的ID。
edgePointName	String	边缘连接点的名称。
connectivityStatus	String	边缘连接点的状态。
dataCenter	DataCenterInfo	边缘连接点所在的数据中心信息。
ipAddress	String	IP地址。
edgePointType	String	边缘连接点的类型。 VPC: VPC PORT: 物理端口(客户独享) OTHER_PORT: 物理端口(客户共享) GOOGLE: Google 云 TENCENT: 腾讯云 ALI_CLOUD：阿里云 AWS: AWS云 AZURE: AZURE云 VIRTUAL_EDGE: IP Sec
vpcId	String	VPC边缘连接点的ID. 该字段仅当类型为VPC时不为null。
portId	String	物理端口的ID. 该字段仅当类型为PORT时不为null。
cloudRegionId	String	有且为Google, Tencent, AWS, Alibaba Cloud, Azure 类型的接入点可取到值。
cloudAccountId	String	云接入的账号。
vlanId	Integer	边缘连接点配置的VLAN ID。
bandwidthMbps	Integer	带宽大小。
bgpConnection	BGPConnection	BGP连接配置信息。
staticRoutes	Array of IPRoute	静态路由配置信息
createTime	Timestamp	创建时间。

CloudRouterAvailableVpc

可用于加入三层网络的裸金属VPC信息

名称	类型	描述
vpcId	String	VPC ID。
vpcName	String	VPC 名称
dataCenter	DataCenterInfo	vpc所在的数据中心。
cidrBlock	String	VPC 的 CIDR。

CloudRegion

描述公有云连接的区域信息。

名称	类型	描述
cloudRegionId	String	公有云区域ID。
dataCenter	DataCenterInfo	云接入点所在的数据中心信息。
products	Array of String	当前云节点点支持的产品。 可用值： PrivateConnect: 二层网络 CloudRouter: 三层网络
haTypes	Array of HaType

HAType

描述高可用类型的信息

名称	类型	描述
haType	HATypeEnum	高可用类型
isUsed	Boolean	是否被使用（如被使用则不可再用）

HATypeEnum

高可用类型枚举

值	说明
PRIMARY	主
SECONDARY	备