For the complete documentation index, see llms.txt. This page is also available as Markdown.

数据结构

AsnInfo

可用 ASN 信息。

被如下接口引用:DescribeIPTransitAvailableAsns

参数名称
类型
描述

asn

String

ASN 值。

asnType

ASN 类型。

BFDConfig

BFD配置。

被如下接口引用:ModifyIPTransitConfig, DescribeIPTransits, CreateIPTransit

参数名称
类型
必选
描述

bfdTxInterval

Integer

否

发送间隔。

单位:ms。

取值范围:100~60000。

可选值范围:[100, 6000]

bfdRxInterval

Integer

否

接收间隔。

单位:ms

取值范围:100~60000。

可选值范围:[100, 6000]

bfdMultiplier

Integer

否

本地检测倍数。

取值范围:3~20。

可选值范围:[3, 20]

BgpConfigParam

BGP 变配参数。

被如下接口引用:ModifyIPTransitConfig

参数名称
类型
必选
描述

routeType

否

BGP inbound 路由类型。

type=BGP_ROUTE_TYPE 时必填。

asnList

Array of Integer

否

ASN 列表。

type=BGP_ASN_AS_SET 时与 asSetList 二选一。

asn 创建后不支持修改。

asSetList

Array of String

否

AS-SET 列表。

type=BGP_ASN_AS_SET 时与 asnList 二选一。

asn 创建后不支持修改。

password

String

否

BGP MD5 密码(长度 8–64)。

type=BGP_PASSWORD 时必填。

CidrBlock

可用 CIDR 块信息。

被如下接口引用:DescribeIPTransitAvailableCidrBlocks

参数名称
类型
描述

netmask

Integer

掩码长度。

IPv4 范围 24–32,IPv6 范围 48–64。

ipNetworkType

IP 网络类型。

ConnectivityStatus

链路连通性状态。

被如下接口引用:DescribeIPTransits

值
值说明

ACTIVE

链路正常连通。

DOWN

链路断开。

ABNORMAL

链路部分异常。

DatacenterInfo

数据中心的基本信息。

被如下接口引用:DescribeIPTransitDatacenters, DescribeIPTransits

参数名称
类型
描述

dcId

String

数据中心ID。

dcName

String

数据中心名称。

dcAddress

String

数据中心地址。

cityName

String

数据中心所在城市名称。

countryName

String

数据中心所在国家名称。

areaName

String

数据中心所在区域名称。

latitude

Float

数据中心所在地纬度。

longitude

Float

数据中心所在地经度。

HA 子链路信息。

被如下接口引用:DescribeIPTransits

参数名称
类型
描述

isPrimary

Boolean

当前是否为主线。

ACTIVE_STANDBY 模式下动态反映主备切换状态;ACTIVE_ACTIVE 模式下为 null。

iptStatus

子链路业务状态。

connectivityStatus

子链路连通性状态。

privateConnectId

String

所属 VLL ID。

privateConnectName

String

所属 VLL 名称。

peerPortId

String

对端数据中心端口 ID。

peerPortName

String

对端数据中心端口名称。

peerDataCenter

数据中心端口所在数据中心。

peerPortVlan

Integer

VLAN ID。

interconnect

互联 IP 配置。

IPAddress

描述IP信息。

被如下接口引用:DescribeIPTransits

参数名称
类型
描述

ipAddress

String

IP地址。

netmask

Integer

掩码。

gatewayIpAddress

String

网关IP地址。

IPPrice

IP 价格信息。

被如下接口引用:InquiryCreateIPTransitPrice

参数名称
类型
描述

price

价格详情。

netmask

Integer

掩码长度。

qty

Integer

数量。

ipNetworkType

IP 网络类型。

IPTransit

IP Transit信息。

被如下接口引用:DescribeIPTransits

参数名称
类型
描述

iptId

String

IP Transit ID。

iptName

String

IP Transit名称。

iptDescription

String

IP Transit描述。

dataCenter

IP Transit所在数据中心。

peerPortId

String

对端数据中心端口 ID。

peerPortName

String

对端数据中心端口名称。

peerDataCenter

对端数据中心端口所在数据中心。

deliveryType

开通方式。

resourceGroupId

String

资源组 ID。

resourceGroupName

String

资源组名称。

createTime

String

创建时间。

routingType

路由模式。

internetType

网络计费方式。

bandwidth

Integer

带宽(Mbps)。

commitBandwidth

Integer

保底带宽(Mbps)。

bfd

BFD 配置。

bgp

BGP 相关配置。

interconnect

互联地址配置。

privateConnectId

String

关联的 VLL ID。

privateConnectName

String

关联的 VLL 名称。

publicIpv4Addresses

Array of IPAddress

公网 IPv4 地址列表。

iptStatus

业务状态。

connectivityStatus

链路连通性状态。

tags

该IP Transit关联的标签。

publicIpAddresses

公网 IP 地址列表。

haMode

高可用模式。

zbgRegionId

String

ZBG 区域 ID。

ZBG 场景下的 IP Transit 将返回此字段。

peerPortType

对端数据中心端口类型。

haLinks

Array of HaLink

HA 子链路列表。

非 HA 模式下为 null;HA 模式下含两个子链路对象。

IPTransitAsnType

BGP ASN 类型。

被如下接口引用:DescribeIPTransitAvailableAsns

值
值说明

ASN

单个 ASN。

AS_SET

AS_SET。

IPTransitAvailableRoutingType

IP Transit可用路由模式信息。

被如下接口引用:DescribeIPTransitDatacenters

参数名称
类型
描述

routingType

路由模式。

availableBgpRouteTypes

可选的 BGP 路由通告类型列表。

仅 routingType 为 BGP 时有值。

availableBgpTiers

Array of RiptBgpTier

可选的 BGP 档位列表。

仅 routingType 为 BGP 时有值。

peerAsns

Array of RiptPeerAsn

各 BGP 档位对应的 Zenlayer 侧(对端)AS 号,供客户本地路由器 BGP 邻居配置。

仅 routingType 为 BGP 时有值。

deliveryType

开通方式。

publicInterconnectNetmasks

Array of Integer

IPv4 公网互联可选掩码列表。

目前仅 30 / 31。

IPTransitBgpRouteType

BGP 接收路由类型。

被如下接口引用:ModifyIPTransitConfig

值
值说明

ALL_ROUTES

全路由。

ALL_ROUTES_WITH_DEFAULT_ROUTES

全路由+默认路由。

DEFAULT_ROUTES

默认路由。

IPTransitConfigType

IP Transit配置变更类型。

被如下接口引用:ModifyIPTransitConfig, InquiryModifyIPTransitPrice

值
值说明

BANDWIDTH

带宽。

BFD

BFD 开关。

BGP_ROUTE_TYPE

BGP 路由类型。

BGP_ASN_AS_SET

BGP ASN/AS-SET。

BGP_PASSWORD

BGP 密码。

ADD_CIDR_BLOCK

新增公网 IP 地址段。

普通 BGP 档位(bgp.tier=STANDARD)的实例不支持。

DEL_CIDR_BLOCK

删除公网 IP 地址段。

EXPAND_CIDR_BLOCK

扩容公网 IP 地址段。

SHRINK_CIDR_BLOCK

缩容公网 IP 地址段。

HA_SWITCH_PRIMARY

HA 主备切换。

HA_SWITCH_MODE

HA 模式切换。

IPTransitDatacenter

可连接数据中心信息。

被如下接口引用:DescribeIPTransitDatacenters

参数名称
类型
描述

dataCenter

数据中心信息。

availableRoutingTypes

该数据中心可用的路由模式列表。

IPTransitDeliveryType

IP Transit开通方式。

被如下接口引用:DescribeIPTransitDatacenters, DescribeIPTransits

值
值说明

Auto

自动开通。

Manual

人工开通。

IPTransitHaConfig

IP Transit HA配置信息。

被如下接口引用:InquiryCreateIPTransitPrice, CreateIPTransit

参数名称
类型
必选
描述

haMode

是

HA 运行模式。

secondaryPortId

String

是

备链路接入数据中心端口 ID。

与顶层 peerPortId 必须同城不同 DC。

secondaryPortVlanId

Integer

是

备链路数据中心端口 VLAN ID。

IPTransitHaMode

HA 主备模式。

被如下接口引用:InquiryCreateIPTransitPrice, DescribeIPTransits

值
值说明

ACTIVE_STANDBY

主备模式。

仅主链路转发流量。

ACTIVE_ACTIVE

负载均衡模式。

两条子链路同时转发流量。

IPTransitIpAddress

IP Transit公网 IP 地址信息。

被如下接口引用:DescribeIPTransits

参数名称
类型
描述

ipUuid

String

IP 块 UUID。

变更(升降级/删除)时作为 ipUuid 传入。

ipAddress

String

IP 地址(CIDR 表示法,如 192.0.2.0/30)。

netmask

Integer

掩码长度。

gatewayIpAddress

String

网关 IP。

ipType

IP 类型(IPV4 / IPV6)。

ipNetworkType

IP 网络类型(BGP_IP / LOCAL_IP)。

IPTransitIpNetworkType

IP Transit IP 网络类型。

被如下接口引用:DescribeIPTransitAvailableCidrBlocks, ModifyIPTransitConfig, InquiryCreateIPTransitPrice, InquiryModifyIPTransitPrice, DescribeIPTransits

值
值说明

BGP_IP

普通 IP。

LOCAL_IP

原生 IP。

IPTransitIpPriceItem

CIDR 块价格信息。

被如下接口引用:InquiryModifyIPTransitPrice

参数名称
类型
描述

price

价格信息。

netmask

Integer

CIDR 掩码长度。

amount

Integer

数量。

ipNetworkType

IP 网络类型(BGP_IP / LOCAL_IP)。

IPTransitIpRequest

公网 IP 分配请求。

被如下接口引用:InquiryCreateIPTransitPrice, CreateIPTransit

参数名称
类型
必选
描述

netmask

Integer

是

CIDR 掩码长度。

IPv4 有效范围 24–30,IPv6 有效范围 48–64。

ipType

是

IP 类型(IPV4 / IPV6)。

ipNetworkType

否

IP 类型。

默认 BGP_IP(从 IP 池分配)。

LOCAL_IP 表示原生 IP。

amount

Integer

否

购买数量。

指定相同掩码长度的 IP 块数量,默认为 1。

IPTransitIpType

IP 协议类型。

被如下接口引用:InquiryCreateIPTransitPrice, DescribeIPTransits

值
值说明

IPV4

IPv4。

IPV6

IPv6。

IPTransitPeerPortType

IP Transit对端数据中心端口类型。

被如下接口引用:DescribeIPTransits

值
值说明

PORT

数据中心端口。

KEY_PORT

Key Port。

ZBG

边界网关(ZBG)。

IPTransitRouteType

IP Transit路由模式。

被如下接口引用:DescribeIPTransitAvailableCidrBlocks, DescribeIPTransitDatacenters, InquiryCreateIPTransitPrice, DescribeIPTransits, CreateIPTransit

值
值说明

BGP

BGP 路由模式。

Static

静态路由模式。

Gateway

网关路由模式。

IPTransitStatus

IP Transit业务状态。

被如下接口引用:DescribeIPTransits

值
值说明

CREATING

创建中。

UPDATING

更新中。

DELETING

删除中。

DESTROYING

销毁中。

RECOVERING

恢复中。

RUNNING

运行中。

RECYCLED

已回收。

DESTROYED

已销毁。

CREATING_FAILED

创建失败。

UPDATING_FAILED

更新失败。

DELETING_FAILED

删除失败。

DESTROYING_FAILED

销毁失败。

RECOVERING_FAILED

恢复失败。

Interconnect

互联地址配置。

被如下接口引用:DescribeIPTransits

参数名称
类型
描述

vendorIpv4Address

String

Zenlayer 侧 IPv4 互联地址。

customerIpv4Address

String

客户侧 IPv4 互联地址。

vendorIpv6Address

String

Zenlayer 侧 IPv6 互联地址。

customerIpv6Address

String

客户侧 IPv6 互联地址。

InternetType

网络计费方式。

被如下接口引用:InquiryCreateIPTransitPrice, DescribeIPTransits, CreateIPTransit

值
值说明

ByBandwidth

固定带宽计费。

ByInstanceBandwidth95

95带宽计费。

MarketingInfo

描述市场活动的相关信息。

被如下接口引用:ModifyIPTransitConfig, InquiryModifyIPTransitPrice

参数名称
类型
必选
描述

discountCode

String

否

使用市场发放的折扣码。

如果折扣码不存在,最终折扣将不会生效。

usePocVoucher

Boolean

否

是否使用POC代金券。

如果系统不存在POC代金券,相关创建流程会失败。

PriceCategory

描述价格类型。

被如下接口引用:InquiryCreateIPTransitPrice

值
值说明

STANDARD

标准价格。

CUSTOMIZED

一口价格。

PriceItem

描述价格的信息。

被如下接口引用:InquiryCreateIPTransitPrice, InquiryModifyIPTransitPrice

参数名称
类型
描述

discount

Float

折扣大小。

如80.0代表8折。

discountPrice

Float

后付费的单元折后价格。

后付费模式使用,如果价格为阶梯价格,该项为null。

originalPrice

Float

预付费的原价。

预付费模式使用,后付费该值为 null。

unitPrice

Float

后付费的单元原始价格。

后付费模式使用,如果价格为阶梯价格,该项为null。

discountUnitPrice

Float

后付费的单元折后价格。

后付费模式使用,如果价格为阶梯价格,该项为null。

chargeUnit

String

后付费计价单元。

后付费模式使用,可取值范围: HOUR: 表示计价单元是按每小时来计算。

DAY: 表示计价单元是按天来计算。

MONTH: 表示计价单元是按月来计算,95计费则是这种。

stepPrices

Array of StepPrice

后付费阶梯价格。

后付费模式使用,如果非阶梯价格,该项为null。

amountUnit

String

用量单位。

比如Mbps, LCU等。

如果为null, 代表取不到值。

excessUnitPrice

Float

超量原始价格。

excessDiscountUnitPrice

Float

超量折扣后价格。

excessAmountUnit

String

超量用量单位。

如果为null, 代表取不到值。

category

价格所属类别。

RiptBgpConfig

BGP相关配置

被如下接口引用:DescribeIPTransits, CreateIPTransit

参数名称
类型
必选
描述

routeType

是

入站路由类型。

tier

否

BGP 档位。

STANDARD-普通 BGP,PREMIUM-优质 BGP。

不传默认优质档(与拆分前行为一致)。

asn

Integer

否

宣告出站路由的ASN号。

password

String

否

加密认证秘钥。

asnList

Array of Integer

否

宣告出站路由的ASN号列表。

asSetList

Array of String

否

宣告出站路由的AS-SET列表。

RiptBgpRouteType

BGP入站路由类型。

被如下接口引用:DescribeIPTransitDatacenters, InquiryCreateIPTransitPrice, CreateIPTransit

值
值说明

ALL_ROUTES

全路由。

ALL_ROUTES_WITH_DEFAULT_ROUTES

全路由+默认路由。

DEFAULT_ROUTES

默认路由。

RiptBgpTier

IP Transit BGP 档位。

被如下接口引用:DescribeIPTransitDatacenters, InquiryCreateIPTransitPrice, CreateIPTransit

值
值说明

STANDARD

普通 BGP。

仅在部分数据中心开放,仅支持固定带宽计费,带宽只能取该数据中心的固定档位值。

PREMIUM

优质 BGP。

骨干直连低时延线路,为档位缺省值;档位拆分前创建的存量实例统一返回该档位。

RiptPeerAsn

BGP 档位与 Zenlayer 侧(对端)AS 号的对应关系。

被如下接口引用:DescribeIPTransitDatacenters

参数名称
类型
描述

tier

BGP 档位。

asn

Integer

该档位对应的 Zenlayer 侧(对端)AS 号。

StepPrice

描述阶梯价格的信息。

被如下接口引用:InquiryCreateIPTransitPrice

参数名称
类型
描述

stepStart

Float

阶梯的起始值。

stepEnd

Float

阶梯的到达值。

为null代表最后一级阶梯。

unitPrice

Float

阶梯单价。

discountUnitPrice

Float

阶梯折后价。

Tag

描述一个标签键值对的信息。

被如下接口引用:DescribeIPTransits, CreateIPTransit

参数名称
类型
必选
描述

key

String

是

标签键。

长度限制:1~64个字符。

value

String

否

标签值。

长度限制:1~64个字符。

TagAssociation

描述创建资源时同时绑定的标签对的信息。

被如下接口引用:CreateIPTransit

参数名称
类型
必选
描述

tags

Array of Tag

是

标签对列表。

Tags

描述资源关联的标签信息。

被如下接口引用:DescribeIPTransits

参数名称
类型
描述

tags

Array of Tag

标签对列表。

TrafficData

描述带宽的数据点信息。

被如下接口引用:DescribeIPTransitTraffic

参数名称
类型
描述

internetRX

Integer

入方向带宽值。

单位:bps。

internetTX

Integer

出方向带宽值。

单位:bps。

time

String

数据时间。

按照ISO8601标准表示,并且使用UTC时间。

格式为:YYYY-MM-ddTHH🇲🇲ssZ。

TrafficStatistic

流量数据的统计方式。

被如下接口引用:DescribeIPTransitTraffic

值
值说明

Average

平均值。

Maximum

最大值。

最后更新于