Data Types
BFDConfig
BFD configuration.
Referenced by:ModifyInternetConfig, CreateInternet, DescribeInternets
bfdTxInterval
Integer
No
Transmit interval.
Unit: ms.
Value range: 100-6000.
Value range: [100, 6000]
bfdRxInterval
Integer
No
Receive interval.
Unit: ms.
Value range: 100-6000.
Value range: [100, 6000]
bfdMultiplier
Integer
No
Detection multiplier.
Value range: 3-20.
Value range: [3, 20]
BGPConnection
Configuration information for the BGP connection.
Referenced by:CreateCloudRouter, DescribeCloudRouters, ModifyCloudRouterEdgePoint
peerIpAddress
String
Yes
Peer interconnect IP address and netmask.
peerAsn
Integer
Yes
Peer BGP ASN.
Value range: [1, 4294967294]
password
String
No
MD5 password for the BGP session, up to 32 characters.
localAsn
Integer
No
Local BGP ASN.
BackupIPSecConfig
Configuration information for the backup IPSec tunnel.
Referenced by:CreateCloudRouter
dcId
String
No
ID of the data center where the backup IPSec tunnel resides.
password
String
No
Authentication password for the backup IPSec tunnel, 8-64 characters.
customerPrivateIP
String
No
Customer-side private IP address of the backup IPSec tunnel.
virtualEdgePrivateIP
String
No
Virtual Edge-side private IP address of the backup IPSec tunnel.
psk
String
No
Pre-shared key (PSK) for the backup IPSec tunnel.
BusinessSource
Business source.
Referenced by:DescribeCloudRouters, DescribePrivateConnects
CONSOLE
Created via the Console.
OSS
Created via the VIP process.
BusinessStatus
Business status.
Referenced by:DescribePorts, DescribeCloudRouters, DescribePrivateConnects
CREATING
Creating.
UPDATING
Updating.
DELETING
Deleting.
DESTROYING
Destroying.
RECOVERING
Restoring.
RUNNING
Normal.
NOT_ACCEPT
Not accepted.
RECYCLED
Recycled.
DESTROYED
Destroyed.
CREATING_FAILED
Creation failed.
UPDATING_FAILED
Update failed.
DELETING_FAILED
Deletion failed.
DESTROYING_FAILED
Destruction failed.
RECOVERING_FAILED
Restore failed.
CloudProduct
Product type.
Referenced by:DescribeAliCloudRegions, DescribeAzureRegions, DescribeHuaweiCloudRegions, DescribeBytePlusRegions, DescribeTencentRegions, DescribeVolcengineRegions, DescribeAWSRegions, DescribeOracleRegions, DescribeGoogleRegions
PrivateConnect
Private Connect
CloudRouter
Cloud Router
CloudRegion
Describes a public cloud access region and the products and HA types it supports.
Referenced by:DescribeAliCloudRegions, DescribeAzureRegions, DescribeHuaweiCloudRegions, DescribeBytePlusRegions, DescribeTencentRegions, DescribeVolcengineRegions, DescribeAWSRegions, DescribeOracleRegions, DescribeGoogleRegions
cloudRegionId
String
Public cloud region ID.
products
Array of CloudProduct
List of products supported in this region: PrivateConnect (Layer 2 network), CloudRouter (Layer 3 network).
CloudRouter
Detailed information about the Cloud Router.
Referenced by:DescribeCloudRouters
cloudRouterId
String
Cloud Router ID.
cloudRouterName
String
Name of the Cloud Router.
cloudRouterDescription
String
Description of the Cloud Router.
createTime
String
Creation time of the Cloud Router.
expiredTime
String
Expiration time of the Cloud Router.
recycledTime
String
Recycle time of the Cloud Router.
resourceGroupId
String
ID of the resource group the Cloud Router belongs to.
resourceGroupName
String
Name of the resource group the Cloud Router belongs to.
period
Integer
Purchase duration of the Cloud Router (months).
CloudRouterAvailableVpc
Information about a VPC that can be added to a Cloud Router.
Referenced by:DescribeCloudRouterAvailableVpcs
vpcId
String
VPC ID.
vpcName
String
VPC name.
cidrBlock
String
CIDR block of the VPC.
CloudRouterEdgePoint
Detailed information about a Cloud Router edge point.
Referenced by:DescribeCloudRouters
bandwidthMbps
Integer
Backbone bandwidth limit of the edge point, in Mbps.
Value range: [10, +)
Default value: 10
edgePointId
String
Edge point ID.
edgePointName
String
Edge point name.
cloudAccountId
String
Cloud account ID of the Cloud Connect edge point.
cloudRegionId
String
Cloud region ID of the Cloud Connect edge point.
vpcId
String
VPC ID of a VPC edge point.
zbgId
String
ZBG ID of a ZBG edge point.
zbgRegionId
String
Region the ZBG edge point belongs to.
portId
String
Port ID of a physical port edge point.
sharedChannelId
String
Shared channel ID.
The cloud-side connection identifier corresponding to a public cloud access point; only populated for public cloud type access points.
vlanId
Integer
VLAN ID of the edge point. Value range: 2-4000.
Value range: [2, 4000]
createTime
String
Creation time of the edge point.
ipAddress
String
Interconnect IP address of the edge point.
CloudType
Cloud vendor type.
Referenced by:InquiryCreatePrivateConnectPrice, DescribeCloudAvailableBandwidthTiers, CreateCloudRouter, DescribeCloudRouters, QueryCloudOnrampPrice, QueryPrivateConnectPrice
AWS
Amazon Web Services
TENCENT
Tencent Cloud
Google Cloud
AZURE
Microsoft Azure
ALI_CLOUD
Alibaba Cloud
HUAWEI_CLOUD
Huawei Cloud
BYTE_PLUS
BytePlus (ByteDance's international cloud)
VOLCENGINE
Volcengine
ORACLE
Oracle Cloud
ConnectivityStatus
Connectivity status of the link.
Referenced by:DescribePorts, DescribeCloudRouters, DescribePrivateConnects, DescribeInternets
ACTIVE
The link is connected normally.
DOWN
The link is down.
ABNORMAL
The link is partially abnormal.
CreateCloudRouterEdgePoint
Configuration for creating a Cloud Router edge point.
Referenced by:CreateCloudRouter, AddCloudRouterEdgePoints
bandwidthMbps
Integer
Yes
Backbone bandwidth limit of the edge point, in Mbps.
Value range: [10, +)
Default value: 10
edgePointName
String
No
Edge point name. Only letters, digits, and hyphens are allowed, up to 100 characters.
vpcId
String
No
VPC ID of a VPC edge point.
zbgId
String
No
ZBG ID of a ZBG edge point.
portId
String
No
Port ID of a physical port edge point.
cloudAccountId
String
No
Cloud account ID of the Cloud Connect edge point.
dcId
String
No
Data center ID where the edge point resides.
cloudRegionId
String
No
Cloud region ID of the Cloud Connect edge point.
vlanId
Integer
No
VLAN ID of the edge point. Value range: 2-4000.
Value range: [2, 4000]
cloudBandwidthMbps
Integer
No
Cloud-side bandwidth limit of the Cloud Connect edge point, in Mbps.
Value range: [10, +)
ipAddress
String
No
Interconnect IP address and netmask of the edge point.
bgpConnection
No
BGP connection configuration of the edge point. Choose either this or static routes.
staticRoutes
Array of IPRoute
No
Static route configuration of the edge point. Choose either this or a BGP connection.
ipSecTunnel
String
No
IPSec tunnel type. Valid values: FQDN or RemoteIP.
customerPublicIP
String
No
Customer-side public IP address for IPSec.
customerPrivateIP
String
No
Customer-side private IP address for IPSec.
virtualEdgePrivateIP
String
No
Virtual Edge-side private IP address for IPSec.
psk
String
No
Pre-shared key (PSK) for IPSec.
enableHealthCheck
Boolean
No
Whether to enable health check. Disabled by default.
Default value: false
ipSecBgpConnection
No
BGP connection configuration for IPSec. Choose either this or IPSec static routes.
ipSecStaticRoutes
Array of IPSecStaticRoute
No
Static route configuration for IPSec. Choose either this or an IPSec BGP connection.
CreateEndpointParam
Parameters for an endpoint when creating a Private Connect.
Referenced by:InquiryCreatePrivateConnectPrice, CreatePrivateConnect
portId
String
No
Physical port ID.
Used when the endpoint is a physical port.
vlanId
Integer
No
VLAN ID.
Value range: [1, +)
cloudRegionId
String
No
Cloud region ID.
Used when the endpoint is a Cloud Connect.
cloudAccountId
String
No
Cloud account ID.
Used when the endpoint is a Cloud Connect.
haType
No
HA type of the Cloud Connect.
Required when the endpoint is an Azure Cloud Connect. The value must be a type actually supported by the data center, which can be obtained from haTypes returned by DescribeAzureRegions.
cloudBandwidthMbps
Integer
No
Cloud Connect bandwidth limit, in Mbps.
Value range: [10, +)
dcId
String
No
Data center ID.
endpointName
String
No
Endpoint name. Only letters, digits, and hyphens are allowed.
DataCenterAssemble
Describes basic information about a data center, including location, coordinates, and available port bandwidth.
Referenced by:DescribeBorderGatewayDatacenters, DescribeVPCDatacenters, DescribeDatacenters, DescribeVirtualEdgeDatacenters
dcId
String
Data center ID.
dcName
String
Data center name.
dcAddress
String
Data center address.
cityName
String
Name of the city.
countryName
String
Name of the country.
areaName
String
Name of the region.
latitude
Float
Latitude.
longitude
Float
Longitude.
isPortAvailable
Boolean
Whether new data center ports can be created.
availableBandwidth
Integer
Available bandwidth (Mbps).
regionId
String
Node ID.
DataCenterWithServiceResponse
Data center details with service type information.
Referenced by:DescribeDatacentersWithService
dcId
String
Data center ID.
dcName
String
Data center name.
dcAddress
String
Data center address.
cityName
String
Name of the city.
countryName
String
Name of the country.
areaName
String
Name of the region.
latitude
Float
Latitude.
longitude
Float
Longitude.
cloudRegionId
String
Public cloud region ID.
DatacenterInfo
Basic information about the data center.
Referenced by:DescribeCloudRouters, DescribePrivateConnects, DescribeAWSRegions, DescribeCloudRouterAvailableVpcs, DescribeInternetDatacenters, DescribeInternets
dcId
String
Data center four-letter code.
dcName
String
Data center name.
dcAddress
String
Data center address.
cityName
String
Name of the city where the data center is located.
countryName
String
Name of the country where the data center is located.
areaName
String
Name of the region where the data center is located.
latitude
Float
Latitude of the data center.
longitude
Float
Longitude of the data center.
DatacenterPortPrice
Describes price information for a data center port.
Referenced by:QueryDataCenterPortPrices
crossConnectPrice
Cross Connect price.
This value is null if the current data center does not support Zenlayer-assisted Cross Connect construction.
crossConnectOneTimeConstructionPrice
Cross Connect one-time construction fee.
This value is null if the current data center does not support Zenlayer-assisted Cross Connect construction.
dcId
String
Data center ID.
stock
Integer
Available stock quantity.
DiversityZone
HA deployment zone (red zone / blue zone).
Referenced by:DescribeCloudAvailableBandwidthTiers
RED
Red zone, used as the counterpart of the blue zone in HA deployments.
BLUE
Blue zone, used as the counterpart of the red zone in HA deployments.
EdgePointType
Access point type.
Referenced by:DescribeCloudRouters
VPC
VPC access point
ZBG
Border gateway access point
IptZBG
Internet border gateway access point.
PORT
Data center physical port access point
OTHER_PORT
Third-party port access point
KEY_PORT
Key Port access point
Google Cloud access point
TENCENT
Tencent Cloud access point
ALICLOUD
Alibaba Cloud access point
AZURE
Azure access point
AWS
AWS access point
VIRTUAL_EDGE
Virtual Edge access point
ORACLE
Oracle access point
HUAWEI
Huawei Cloud access point
BYTEPLUS
BytePlus access point
VOLCENGINE
Volcengine access point
EndpointType
Endpoint type.
Referenced by:DescribePrivateConnects
Google Cloud endpoint.
TENCENT
Tencent Cloud endpoint.
AZURE
Azure endpoint.
ALI_CLOUD
Alibaba Cloud endpoint.
AWS
AWS endpoint.
HUAWEI_CLOUD
Huawei Cloud endpoint.
ORACLE
Oracle endpoint.
BYTE_PLUS
BytePlus endpoint.
VOLCENGINE
Volcengine endpoint.
PORT
Data center physical port endpoint.
Ript
Internet connection point.
OTHER_PORT
Third-party port endpoint.
HaType
HA type.
Referenced by:InquiryCreatePrivateConnectPrice, CreateCloudRouter, DescribeAWSRegions
PRIMARY
Primary.
SECONDARY
Secondary.
HaTypeInfo
Describes an HA type within a region and its usage.
Referenced by:DescribeAWSRegions
isUsed
Boolean
Whether this HA type has already been used.
IPAddress
Describes IP information.
Referenced by:DescribeInternets
ipAddress
String
IP address.
netmask
Integer
Netmask.
gatewayIpAddress
String
Gateway IP address.
IPRoute
Configuration information for the static route.
Referenced by:CreateCloudRouter, DescribeCloudRouters, ModifyCloudRouterEdgePoint
prefix
String
Yes
Destination CIDR of the static route.
nextHop
String
Yes
Next-hop IP address of the static route.
IPSecBGPConnection
BGP connection configuration information for IPSec.
Referenced by:CreateCloudRouter
customerAsn
Integer
Yes
Customer-side BGP ASN.
virtualEdgeAsn
Integer
Yes
Virtual Edge-side BGP ASN.
password
String
No
Authentication password for the BGP session, 8-64 characters.
IPSecStaticRoute
Static route configuration information for IPSec.
Referenced by:CreateCloudRouter
cidr
String
Yes
Destination CIDR of the static route.
Internet
Internet information.
Referenced by:DescribeInternets
internetId
String
Internet ID。
internetName
String
Internet name.
internetDescription
String
Internet description.
peerPortId
String
Connected port ID.
peerPortName
String
Connected port name.
resourceGroupId
String
Resource group ID of the Internet.
resourceGroupName
String
Resource group name of the Internet.
createTime
String
Creation time.
Format: YYYY-MM-ddTHH:mm:ssZ.
bandwidth
Integer
Bandwidth cap.
Unit: Mbps.
commitBandwidth
Integer
Committed bandwidth.
Only available when bandwidth billing method is ByInstanceBandwidth95.
privateConnectId
String
Private connect ID associated with the Internet.
privateConnectName
String
Name of the private connect associated with the Internet.
zbgRegionId
String
ZBG region ID.
Returned for Internet instances in ZBG scenarios.
haLinks
Array of InternetHaLink
List of HA sub-links.
Null for non-HA mode. Contains two sub-link objects for HA mode.
InternetAsnInfo
Available ASN information.
Referenced by:DescribeInternetAvailableAsns
asn
String
ASN value.
InternetAsnType
BGP ASN type.
Referenced by:DescribeInternetAvailableAsns
ASN
A single ASN.
AS_SET
AS-SET.
InternetAvailableRoutingType
Available routing type information of the Internet.
Referenced by:DescribeInternetDatacenters
availableBgpRouteTypes
Array of InternetBgpConfigRouteType
List of available BGP route types.
Returned only when routingType is BGP.
availableBgpTiers
Array of InternetBgpTier
Available BGP tiers.
Only available when routingType is BGP.
peerAsns
Array of InternetPeerAsn
Zenlayer-side (peer) AS numbers for each BGP tier, used to configure the BGP neighbor on your local router.
Only available when routingType is BGP.
publicInterconnectNetmasks
Array of Integer
List of available IPv4 public interconnect netmasks.
Currently only 30 / 31 are supported.
InternetBgpConfig
BGP configurations.
Referenced by:CreateInternet, DescribeInternets
tier
No
BGP tier.
STANDARD: Standard BGP. PREMIUM: Premium BGP.
Defaults to PREMIUM if not specified (consistent with the behavior before the tier split).
asn
Integer
No
ASN for announcing outbound routes.
password
String
No
Authentication key.
asnList
Array of Integer
No
ASN list for announcing outbound routes.
asSetList
Array of String
No
AS-SET list for announcing outbound routes.
InternetBgpConfigParam
BGP configuration change parameters.
Referenced by:ModifyInternetConfig
asnList
Array of Integer
No
List of ASNs.
Effective when type is BGP_ASN_AS_SET.
asSetList
Array of String
No
List of AS-SETs.
Effective when type is BGP_ASN_AS_SET.
password
String
No
BGP MD5 password (8-64 characters).
Required when type is BGP_PASSWORD.
InternetBgpConfigRouteType
BGP inbound route type.
Referenced by:DescribeInternetDatacenters, CreateInternet, InquiryCreateInternetPrice
ALL_ROUTES
Full routes.
ALL_ROUTES_WITH_DEFAULT_ROUTES
All routes with default routes.
DEFAULT_ROUTES
Default routes.
InternetBgpRouteType
BGP inbound route type.
Referenced by:ModifyInternetConfig
ALL_ROUTES
Full routes.
ALL_ROUTES_WITH_DEFAULT_ROUTES
All routes with default routes.
DEFAULT_ROUTES
Default routes.
InternetBgpTier
Internet BGP tier.
Referenced by:DescribeInternetDatacenters, CreateInternet, InquiryCreateInternetPrice
STANDARD
Standard BGP.
Available only in some data centers. It supports fixed bandwidth billing only, and the bandwidth must be one of the fixed tier levels of that data center.
PREMIUM
Premium BGP.
A low-latency line directly connected to the backbone. This is the default tier. Existing instances created before the tier split uniformly return this tier.
InternetCidrBlock
Available CIDR block information.
Referenced by:DescribeInternetAvailableCidrBlocks
netmask
Integer
Netmask length.
IPv4 range: 24-32. IPv6 range: 48-64.
InternetConfigType
Internet configuration change type.
Referenced by:InquiryModifyInternetPrice, ModifyInternetConfig
BANDWIDTH
Bandwidth.
BFD
BFD switch.
BGP_ROUTE_TYPE
BGP route type.
BGP_ASN_AS_SET
BGP ASN/AS-SET.
BGP_PASSWORD
BGP password.
ADD_CIDR_BLOCK
Add a public IP address block.
Not supported for instances with the Standard BGP tier (bgp.tier=STANDARD).
DEL_CIDR_BLOCK
Delete a public IP address block.
EXPAND_CIDR_BLOCK
Expand a public IP address block.
SHRINK_CIDR_BLOCK
Shrink a public IP address block.
HA_SWITCH_PRIMARY
HA primary/secondary switchover.
HA_SWITCH_MODE
HA mode switch.
InternetDatacenter
Describes data center information supporting Internet, including basic data center information and supported routing types.
Referenced by:DescribeInternetDatacenters
InternetDeliveryType
Internet delivery type.
Referenced by:DescribeInternetDatacenters, DescribeInternets
Auto
Automated delivery (Usually completed within minutes).
Manual
Manual delivery. (Usually completed within 3 days).
InternetHaConfig
Internet HA configuration.
Referenced by:CreateInternet, InquiryCreateInternetPrice
secondaryPortId
String
Yes
Access port ID of the secondary link.
Must be in the same city as but a different data center from the top-level peerPortId.
secondaryPortVlanId
Integer
Yes
VLAN ID of the secondary link port.
InternetHaLink
HA sub-link information.
Referenced by:DescribeInternets
isPrimary
Boolean
Whether this is currently the primary link.
In ACTIVE_STANDBY mode, this dynamically reflects the primary/secondary switchover state. In ACTIVE_ACTIVE mode, the value is null.
privateConnectId
String
ID of the associated VLL.
privateConnectName
String
Name of the associated VLL.
peerPortId
String
Connected port ID.
peerPortName
String
Connected port name.
peerPortVlan
Integer
VLAN ID.
InternetHaMode
HA mode.
Referenced by:InquiryCreateInternetPrice, DescribeInternets
ACTIVE_STANDBY
Active/standby mode.
Only the primary link forwards traffic.
ACTIVE_ACTIVE
Active/active mode.
Both sub-links forward traffic simultaneously.
InternetInterconnect
Interconnect IP address information.
Referenced by:DescribeInternets
vendorIpv4Address
String
Vendor-side IPv4 address.
customerIpv4Address
String
Customer-side IPv4 address.
vendorIpv6Address
String
Zenlayer-side IPv6 interconnect address.
customerIpv6Address
String
Customer-side IPv6 interconnect address.
InternetIpAddress
Public IP address information of the Internet.
Referenced by:DescribeInternets
ipUuid
String
IP block UUID.
Passed as ipUuid when modifying (expanding/shrinking/deleting).
ipAddress
String
IP address (in CIDR notation, e.g., 192.0.2.0/30).
netmask
Integer
Netmask length.
gatewayIpAddress
String
Gateway IP.
InternetIpNetworkType
Internet IP network type.
Referenced by:InquiryModifyInternetPrice, ModifyInternetConfig, DescribeInternetAvailableCidrBlocks, InquiryCreateInternetPrice, DescribeInternets
BGP_IP
Regular IP.
LOCAL_IP
Native IP.
InternetIpPrice
IP price information.
Referenced by:InquiryCreateInternetPrice
netmask
Integer
Netmask length.
qty
Integer
Quantity.
InternetIpPriceItem
CIDR block price information.
Referenced by:InquiryModifyInternetPrice
netmask
Integer
CIDR netmask length.
amount
Integer
Quantity.
InternetIpRequest
Public IP allocation request.
Referenced by:CreateInternet, InquiryCreateInternetPrice
netmask
Integer
Yes
CIDR netmask length.
Valid IPv4 range: 24-30. Valid IPv6 range: 48-64.
ipNetworkType
No
IP network type.
Default: BGP_IP (allocated from the IP pool).
LOCAL_IP indicates a native IP.
amount
Integer
No
Purchase quantity.
Specifies the number of IP blocks with the same netmask length. Default: 1.
InternetIpType
IP protocol type.
Referenced by:InquiryCreateInternetPrice, DescribeInternets
IPV4
IPv4.
IPV6
IPv6.
InternetPeerAsn
Describes the mapping between a BGP tier and the Zenlayer-side (peer) AS number.
Referenced by:DescribeInternetDatacenters
asn
Integer
The Zenlayer-side (peer) AS number of this tier.
InternetPeerPortType
Port type of the Internet peer data center.
Referenced by:DescribeInternets
PORT
Data center physical port.
KEY_PORT
Key Port.
ZBG
Border gateway (ZBG).
InternetRouteType
Internet routing type.
Referenced by:DescribeInternetAvailableCidrBlocks, DescribeInternetDatacenters, CreateInternet, InquiryCreateInternetPrice, DescribeInternets
BGP
BGP. (Currently not supported via API)
Static
Static routing.
Gateway
Gateway mode.
InternetStatus
Internet state.
Referenced by:DescribeInternets
CREATING
Creating.
UPDATING
Updating.
DELETING
Deleting.
DESTROYING
Releasing.
RECOVERING
Restoring.
RUNNING
Running.
RECYCLED
Recycled.
DESTROYED
Released.
CREATING_FAILED
Creating failed.
UPDATING_FAILED
Updating failed.
DELETING_FAILED
Deleting failed.
DESTROYING_FAILED
Releasing failed.
RECOVERING_FAILED
Restoring failed.
InternetType
Internet billing type.
Referenced by:QueryPrivateConnectBandwidthPrice, InquiryCreatePrivateConnectPrice, CreateInternet, QueryPrivateConnectPrice, InquiryCreateInternetPrice, DescribeInternets
ByBandwidth
Fixed bandwidth billing.
ByInstanceBandwidth95
95th percentile billing.
LagInfo
Information about the LAG to which the port belongs.
Referenced by:DescribePorts
lagId
String
LAG ID.
lagName
String
LAG name.
LoaStatus
LOA upload status.
Referenced by:DescribePorts
LOA_NOT_UPLOAD
LOA not uploaded
LOA_UPLOADED
LOA uploaded
MarketingInfo
Describes marketing activity information.
Referenced by:CreatePort, InquiryModifyInternetPrice, ModifyInternetConfig, CreateCloudRouter, CreatePrivateConnect
discountCode
String
No
Discount code issued by marketing.
If the discount code does not exist, the final discount will not apply.
usePocVoucher
Boolean
No
Whether to use a POC voucher.
If no POC voucher exists in the system, the related creation process will fail.
PortCategory
Port category.
Referenced by:DescribeDataCenterPortPrice
STANDARD
Standard port, billed at a fixed bandwidth spec.
UNLIMITED
Unlimited port, billed by actual traffic used.
PortInfo
Describes detailed information about the port.
Referenced by:DescribePorts, DescribeCloudRouterAvailablePorts, DescribePrivateConnectAvailablePorts
portId
String
Port ID.
portName
String
Port name.
portRemarks
String
Port remarks.
portType
String
Port spec.
dcId
String
Data center four-letter code.
dcName
String
Data center name.
cityName
String
City name.
areaName
String
Name of the region.
businessEntityName
String
Business entity name, used as the LOA letterhead.
loaDownloadUrl
String
LOA download URL.
createdTime
String
Creation time.
expiredTime
String
Expiration time.
period
Integer
Purchase duration, in months.
isCreateBusinessAllowed
Boolean
Whether business can be provisioned on this port.
lag
The LAG to which the port belongs.
Empty if the port has not joined a LAG.
After a port joins a LAG, services can only be created using that LAG, and its member ports can no longer be used individually to create services.
PortPrice
Describes the port's type, category, and price information.
Referenced by:DescribeDataCenterPortPrice
dcId
String
Data center four-letter code.
portType
String
Port spec.
stock
Integer
Stock quantity.
PriceCategory
Describes the price category.
Referenced by:QueryCloudOnrampPrice
STANDARD
Standard price.
CUSTOMIZED
Fixed price.
PriceItem
Describes price information.
Referenced by:QueryPrivateConnectBandwidthPrice, QueryDataCenterPortPrice, InquiryModifyInternetPrice, InquiryCreatePrivateConnectPrice, QueryDataCenterPortPrices, QueryCloudRouterBandwidthPrice, DescribeDataCenterPortPrice, QueryCloudOnrampPrice, QueryPrivateConnectPrice, InquiryCreateInternetPrice
discount
Float
Discount rate.
E.g. 80.0 means 20% off.
discountPrice
Float
Discounted postpaid unit price.
Used in postpaid mode; null if the price is a tiered price.
originalPrice
Float
Original prepaid price.
Used in prepaid mode; null for postpaid.
unitPrice
Float
Original postpaid unit price.
Used in postpaid mode; null if the price is a tiered price.
discountUnitPrice
Float
Discounted postpaid unit price.
Used in postpaid mode; null if the price is a tiered price.
chargeUnit
String
Postpaid billing unit.
Used in postpaid mode. Possible values: HOUR: billed per hour.
DAY: billed per day.
MONTH: billed per month, used for 95th-percentile billing.
stepPrices
Array of StepPrice
Postpaid tiered pricing.
Used in postpaid mode; null if not a tiered price.
amountUnit
String
Usage unit.
E.g. Mbps, LCU, etc.
If null, the value is unavailable.
excessUnitPrice
Float
Original excess price.
excessDiscountUnitPrice
Float
Discounted excess price.
excessAmountUnit
String
Excess usage unit.
If null, the value is unavailable.
PrivateConnect
Detailed information about the Private Connect.
Referenced by:DescribePrivateConnects
privateConnectId
String
Private Connect ID.
privateConnectName
String
Private Connect name.
bandwidthMbps
Integer
Maximum bandwidth limit, in Mbps.
resourceGroupId
String
Resource group ID.
resourceGroupName
String
Resource group name.
createTime
String
Creation time.
expiredTime
String
Expiration time.
recycledTime
String
Recycle time.
PrivateConnectEndpoint
Detailed information about a Private Connect endpoint.
Referenced by:DescribePrivateConnects
endpointId
String
Endpoint ID.
endpointName
String
Endpoint name.
vlanId
Integer
VLAN ID.
cloudRegionId
String
Cloud region ID.
Returned when the endpoint is a Cloud Connect.
cloudAccountId
String
Cloud account ID.
Returned when the endpoint is a Cloud Connect.
sharedChannelId
String
Shared channel ID.
The cloud-side connection identifier corresponding to a public cloud access point; only populated for public cloud type access points.
PrivateConnectEndpointInfo
Endpoint information for the Private Connect. The endpoint parameters vary depending on the endpoint type.
Referenced by:QueryPrivateConnectPrice
dcId
String
Yes
Data center ID. The latest list of data centers can be obtained via the DescribeDataCenters API.
bandwidthMbps
Integer
No
Maximum bandwidth limit for the Cloud Connect.
Default: 10, unit: Mbps.
Value range: [10, +)
Default value: 10
vlanId
Integer
No
VLAN ID.
Value range: [2, 4000]
cloudRegionId
String
No
Public cloud region ID.
Not required for Google Cloud.
portType
String
No
Port spec. The latest port spec list can be obtained via the DescribeDataCenterPortPrice API.
buildCrossConnectWithAssisted
Boolean
No
Whether Zenlayer-assisted Cross Connect construction is required.
If true, the price includes the Cross Connect patch cord fee and the one-time construction fee.
Default: false, meaning the user builds the Cross Connect themselves.
Default value: false
PrivateConnectEndpointPrice
Describes price information for a Private Connect endpoint.
Referenced by:QueryPrivateConnectPrice
crossConnectPrice
Cross Connect price.
Populated when the endpoint type is a data center port and the data center supports Zenlayer-assisted Cross Connect construction.
crossConnectOneTimeConstructionPrice
Cross Connect one-time construction fee.
Populated when the endpoint type is a data center port and the data center supports Zenlayer-assisted Cross Connect construction.
stock
Integer
Available stock quantity.
ProtectionType
Private Connect protection type.
Referenced by:QueryPrivateConnectBandwidthPrice
SINGLE_PROTECTED
Single-path protected -- provides line protection/redundancy.
SINGLE_UNPROTECTED
Single-path unprotected -- no line protection.
ServiceType
Service type.
Referenced by:DescribeDatacentersWithService
AWS
Amazon Web Services
TENCENT
Tencent Cloud
Google Cloud
AZURE
Microsoft Azure
ALI_CLOUD
Alibaba Cloud
HUAWEI_CLOUD
Huawei Cloud
DATACENTER_PORT
Data center physical port (non-cloud service).
BYTE_PLUS
BytePlus (ByteDance's international cloud)
VOLCENGINE
Volcengine
ORACLE
Oracle Cloud
StepPrice
Describes tiered pricing information.
Referenced by:QueryCloudOnrampPrice
stepStart
Float
Lower bound of the tier.
stepEnd
Float
Upper bound of the tier.
Null represents the last tier.
unitPrice
Float
Tier unit price.
discountUnitPrice
Float
Discounted tier unit price.
Tag
Describes a tag key-value pair.
Referenced by:CreatePort, DescribePorts, DescribeCloudRouters, DescribePrivateConnects, DescribeInternets
key
String
Yes
Tag key.
Length: 1-64 characters.
value
String
No
Tag value.
Length: 1-64 characters.
TagAssociation
Describes the tag pairs bound at resource creation time.
Referenced by:CreatePort, CreateCloudRouter, CreatePrivateConnect, CreateInternet
Tags
Describes the tags associated with the resource.
Referenced by:DescribePorts, DescribeCloudRouters, DescribePrivateConnects, DescribeInternets
TrafficData
Describes a bandwidth data point.
Referenced by:DescribeInternetTraffic, DescribePrivateConnectTraffic, DescribeCloudRouterEdgePointTraffic, DescribePortTraffic, DescribeCloudRouterDCToDCTraffic
internetRX
Integer
Inbound bandwidth value.
Unit: bps.
internetTX
Integer
Outbound bandwidth value.
Unit: bps.
time
String
Data timestamp.
In ISO 8601 format, UTC timezone.
Format: YYYY-MM-ddTHH:mm:ssZ.
TrafficStatistic
Statistical method of traffic data.
Referenced by:DescribeInternetTraffic, DescribePrivateConnectTraffic, DescribeCloudRouterEdgePointTraffic, DescribePortTraffic, DescribeCloudRouterDCToDCTraffic
Average
Average value.
Maximum
Maximum value.
Last updated