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

Data Types

BFDConfig

BFD configuration.

Referenced by:ModifyInternetConfig, CreateInternet, DescribeInternets

Parameter Name
Type
Required
Description

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

Parameter Name
Type
Required
Description

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

Parameter Name
Type
Required
Description

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

Value
Description

CONSOLE

Created via the Console.

OSS

Created via the VIP process.

BusinessStatus

Business status.

Referenced by:DescribePorts, DescribeCloudRouters, DescribePrivateConnects

Value
Description

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

Value
Description

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

Parameter Name
Type
Description

cloudRegionId

String

Public cloud region ID.

dataCenter

Data center information of the access point.

products

Array of CloudProduct

List of products supported in this region: PrivateConnect (Layer 2 network), CloudRouter (Layer 3 network).

haTypes

Array of HaTypeInfo

List of HA types supported in this region.

CloudRouter

Detailed information about the Cloud Router.

Referenced by:DescribeCloudRouters

Parameter Name
Type
Description

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.

edgePoints

List of edge points of the Cloud Router.

cloudRouterStatus

Business status of the Cloud Router.

connectivityStatus

Connectivity status 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).

source

Business source of the Cloud Router.

tags

Tags associated with the Cloud Router.

CloudRouterAvailableVpc

Information about a VPC that can be added to a Cloud Router.

Referenced by:DescribeCloudRouterAvailableVpcs

Parameter Name
Type
Description

vpcId

String

VPC ID.

vpcName

String

VPC name.

dataCenter

Data center information of the VPC.

cidrBlock

String

CIDR block of the VPC.

CloudRouterEdgePoint

Detailed information about a Cloud Router edge point.

Referenced by:DescribeCloudRouters

Parameter Name
Type
Description

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.

connectivityStatus

Connectivity status of the edge point.

dataCenter

Data center information of the edge point.

edgePointType

Edge point type.

cloudType

Cloud vendor type of the Cloud Connect edge point.

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]

bgpConnection

BGP connection configuration of the edge point.

staticRoutes

Array of IPRoute

Static route configuration of the edge point.

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

Value
Description

AWS

Amazon Web Services

TENCENT

Tencent Cloud

GOOGLE

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

Value
Description

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

Parameter Name
Type
Required
Description

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.

cloudType

No

Cloud vendor type of the Cloud Connect 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.

haType

No

HA type 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

backupIpSec

No

Backup IPSec tunnel configuration.

ipSecBgpConnection

No

BGP connection configuration for IPSec. Choose either this or IPSec static routes.

ipSecStaticRoutes

No

Static route configuration for IPSec. Choose either this or an IPSec BGP connection.

marketingInfo

No

Marketing activity information, including whether to use a POC voucher.

CreateEndpointParam

Parameters for an endpoint when creating a Private Connect.

Referenced by:InquiryCreatePrivateConnectPrice, CreatePrivateConnect

Parameter Name
Type
Required
Description

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.

cloudType

No

Cloud vendor type.

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

Parameter Name
Type
Description

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

Parameter Name
Type
Description

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.

serviceTypes

Array of ServiceType

Set of supported service types.

DatacenterInfo

Basic information about the data center.

Referenced by:DescribeCloudRouters, DescribePrivateConnects, DescribeAWSRegions, DescribeCloudRouterAvailableVpcs, DescribeInternetDatacenters, DescribeInternets

Parameter Name
Type
Description

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

Parameter Name
Type
Description

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.

price

Price information.

stock

Integer

Available stock quantity.

DiversityZone

HA deployment zone (red zone / blue zone).

Referenced by:DescribeCloudAvailableBandwidthTiers

Value
Description

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

Value
Description

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

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

Value
Description

GOOGLE

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

Value
Description

PRIMARY

Primary.

SECONDARY

Secondary.

HaTypeInfo

Describes an HA type within a region and its usage.

Referenced by:DescribeAWSRegions

Parameter Name
Type
Description

haType

HA type.

isUsed

Boolean

Whether this HA type has already been used.

IPAddress

Describes IP information.

Referenced by:DescribeInternets

Parameter Name
Type
Description

ipAddress

String

IP address.

netmask

Integer

Netmask.

gatewayIpAddress

String

Gateway IP address.

IPRoute

Configuration information for the static route.

Referenced by:CreateCloudRouter, DescribeCloudRouters, ModifyCloudRouterEdgePoint

Parameter Name
Type
Required
Description

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

Parameter Name
Type
Required
Description

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

Parameter Name
Type
Required
Description

cidr

String

Yes

Destination CIDR of the static route.

Internet

Internet information.

Referenced by:DescribeInternets

Parameter Name
Type
Description

internetId

String

Internet ID。

internetName

String

Internet name.

internetDescription

String

Internet description.

dataCenter

Data center of the Internet.

peerPortId

String

Connected port ID.

peerPortName

String

Connected port name.

peerDataCenter

Data center of the port side.

deliveryType

Delivery type.

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.

routingType

Routing type.

internetType

Bandwidth billing method.

bandwidth

Integer

Bandwidth cap.

Unit: Mbps.

commitBandwidth

Integer

Committed bandwidth.

Only available when bandwidth billing method is ByInstanceBandwidth95.

bfd

BFD configuration.

bgp

BGP configurations.

interconnect

Interconnect IP address information.

privateConnectId

String

Private connect ID associated with the Internet.

privateConnectName

String

Name of the private connect associated with the Internet.

publicIpv4Addresses

Array of IPAddress

Public IP information.

internetStatus

Internet state.

connectivityStatus

Link connectivity status.

tags

Tags bound to the Internet.

publicIpAddresses

List of public IP addresses.

haMode

HA mode.

zbgRegionId

String

ZBG region ID.

Returned for Internet instances in ZBG scenarios.

peerPortType

Peer port type.

haLinks

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

Parameter Name
Type
Description

asn

String

ASN value.

asnType

ASN type (PUBLIC for public ASN, PRIVATE for private AS-SET).

InternetAsnType

BGP ASN type.

Referenced by:DescribeInternetAvailableAsns

Value
Description

ASN

A single ASN.

AS_SET

AS-SET.

InternetAvailableRoutingType

Available routing type information of the Internet.

Referenced by:DescribeInternetDatacenters

Parameter Name
Type
Description

routingType

Routing type.

availableBgpRouteTypes

List of available BGP route types.

Returned only when routingType is BGP.

availableBgpTiers

Available BGP tiers.

Only available when routingType is BGP.

peerAsns

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.

deliveryType

Delivery type.

publicInterconnectNetmasks

Array of Integer

List of available IPv4 public interconnect netmasks.

Currently only 30 / 31 are supported.

InternetBgpConfig

BGP configurations.

Referenced by:CreateInternet, DescribeInternets

Parameter Name
Type
Required
Description

routeType

Yes

Inbound route type.

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

Parameter Name
Type
Required
Description

routeType

No

BGP inbound route type.

Required when type is BGP_ROUTE_TYPE.

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

Value
Description

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

Value
Description

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

Value
Description

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

Parameter Name
Type
Description

netmask

Integer

Netmask length.

IPv4 range: 24-32. IPv6 range: 48-64.

ipNetworkType

IP network type.

InternetConfigType

Internet configuration change type.

Referenced by:InquiryModifyInternetPrice, ModifyInternetConfig

Value
Description

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

Parameter Name
Type
Description

dataCenter

Data center information.

availableRoutingTypes

Supported routing type configurations.

InternetDeliveryType

Internet delivery type.

Referenced by:DescribeInternetDatacenters, DescribeInternets

Value
Description

Auto

Automated delivery (Usually completed within minutes).

Manual

Manual delivery. (Usually completed within 3 days).

InternetHaConfig

Internet HA configuration.

Referenced by:CreateInternet, InquiryCreateInternetPrice

Parameter Name
Type
Required
Description

haMode

Yes

HA operating mode.

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.

HA sub-link information.

Referenced by:DescribeInternets

Parameter Name
Type
Description

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.

internetStatus

State of the sub-link.

connectivityStatus

Connectivity status of the sub-link.

privateConnectId

String

ID of the associated VLL.

privateConnectName

String

Name of the associated VLL.

peerPortId

String

Connected port ID.

peerPortName

String

Connected port name.

peerDataCenter

Data center of the port.

peerPortVlan

Integer

VLAN ID.

interconnect

Interconnect IP configuration.

InternetHaMode

HA mode.

Referenced by:InquiryCreateInternetPrice, DescribeInternets

Value
Description

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

Parameter Name
Type
Description

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

Parameter Name
Type
Description

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.

ipType

IP type (IPV4 / IPV6).

ipNetworkType

IP network type (BGP_IP / LOCAL_IP).

InternetIpNetworkType

Internet IP network type.

Referenced by:InquiryModifyInternetPrice, ModifyInternetConfig, DescribeInternetAvailableCidrBlocks, InquiryCreateInternetPrice, DescribeInternets

Value
Description

BGP_IP

Regular IP.

LOCAL_IP

Native IP.

InternetIpPrice

IP price information.

Referenced by:InquiryCreateInternetPrice

Parameter Name
Type
Description

price

Price information of the IP CIDR.

netmask

Integer

Netmask length.

qty

Integer

Quantity.

ipNetworkType

IP network type.

InternetIpPriceItem

CIDR block price information.

Referenced by:InquiryModifyInternetPrice

Parameter Name
Type
Description

price

Price information.

netmask

Integer

CIDR netmask length.

amount

Integer

Quantity.

ipNetworkType

IP network type (BGP_IP / LOCAL_IP).

InternetIpRequest

Public IP allocation request.

Referenced by:CreateInternet, InquiryCreateInternetPrice

Parameter Name
Type
Required
Description

netmask

Integer

Yes

CIDR netmask length.

Valid IPv4 range: 24-30. Valid IPv6 range: 48-64.

ipType

Yes

IP type (IPV4 / IPV6).

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

Value
Description

IPV4

IPv4.

IPV6

IPv6.

InternetPeerAsn

Describes the mapping between a BGP tier and the Zenlayer-side (peer) AS number.

Referenced by:DescribeInternetDatacenters

Parameter Name
Type
Description

tier

BGP tier.

asn

Integer

The Zenlayer-side (peer) AS number of this tier.

InternetPeerPortType

Port type of the Internet peer data center.

Referenced by:DescribeInternets

Value
Description

PORT

Data center physical port.

KEY_PORT

Key Port.

ZBG

Border gateway (ZBG).

InternetRouteType

Internet routing type.

Referenced by:DescribeInternetAvailableCidrBlocks, DescribeInternetDatacenters, CreateInternet, InquiryCreateInternetPrice, DescribeInternets

Value
Description

BGP

BGP. (Currently not supported via API)

Static

Static routing.

Gateway

Gateway mode.

InternetStatus

Internet state.

Referenced by:DescribeInternets

Value
Description

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

Value
Description

ByBandwidth

Fixed bandwidth billing.

ByInstanceBandwidth95

95th percentile billing.

LagInfo

Information about the LAG to which the port belongs.

Referenced by:DescribePorts

Parameter Name
Type
Description

lagId

String

LAG ID.

lagName

String

LAG name.

LoaStatus

LOA upload status.

Referenced by:DescribePorts

Value
Description

LOA_NOT_UPLOAD

LOA not uploaded

LOA_UPLOADED

LOA uploaded

MarketingInfo

Describes marketing activity information.

Referenced by:CreatePort, InquiryModifyInternetPrice, ModifyInternetConfig, CreateCloudRouter, CreatePrivateConnect

Parameter Name
Type
Required
Description

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

Value
Description

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

Parameter Name
Type
Description

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.

connectionStatus

Port connection status.

portStatus

Port business status.

loaStatus

LOA status.

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.

tags

Tags associated with the 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

Parameter Name
Type
Description

dcId

String

Data center four-letter code.

portType

String

Port spec.

portCategory

Port category.

portPrice

Port price information.

stock

Integer

Stock quantity.

PriceCategory

Describes the price category.

Referenced by:QueryCloudOnrampPrice

Value
Description

STANDARD

Standard price.

CUSTOMIZED

Fixed price.

PriceItem

Describes price information.

Referenced by:QueryPrivateConnectBandwidthPrice, QueryDataCenterPortPrice, InquiryModifyInternetPrice, InquiryCreatePrivateConnectPrice, QueryDataCenterPortPrices, QueryCloudRouterBandwidthPrice, DescribeDataCenterPortPrice, QueryCloudOnrampPrice, QueryPrivateConnectPrice, InquiryCreateInternetPrice

Parameter Name
Type
Description

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.

category

Price category.

PrivateConnect

Detailed information about the Private Connect.

Referenced by:DescribePrivateConnects

Parameter Name
Type
Description

privateConnectId

String

Private Connect ID.

privateConnectName

String

Private Connect name.

connectivityStatus

Connectivity status.

privateConnectStatus

Private Connect business status.

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.

endpointA

Endpoint A of the Private Connect.

endpointZ

Endpoint Z of the Private Connect.

source

Business source.

tags

Associated tags.

PrivateConnectEndpoint

Detailed information about a Private Connect endpoint.

Referenced by:DescribePrivateConnects

Parameter Name
Type
Description

endpointId

String

Endpoint ID.

endpointName

String

Endpoint name.

endpointType

Endpoint type.

connectivityStatus

Connectivity status.

vlanId

Integer

VLAN ID.

dataCenter

Data center information.

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

Parameter Name
Type
Required
Description

dcId

String

Yes

Data center ID. The latest list of data centers can be obtained via the DescribeDataCenters API.

cloudType

No

Cloud Connect type.

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

Parameter Name
Type
Description

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.

price

Price information.

stock

Integer

Available stock quantity.

ProtectionType

Private Connect protection type.

Referenced by:QueryPrivateConnectBandwidthPrice

Value
Description

SINGLE_PROTECTED

Single-path protected -- provides line protection/redundancy.

SINGLE_UNPROTECTED

Single-path unprotected -- no line protection.

ServiceType

Service type.

Referenced by:DescribeDatacentersWithService

Value
Description

AWS

Amazon Web Services

TENCENT

Tencent Cloud

GOOGLE

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

Parameter Name
Type
Description

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

Parameter Name
Type
Required
Description

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

Parameter Name
Type
Required
Description

tags

Array of Tag

Yes

List of tag pairs.

Tags

Describes the tags associated with the resource.

Referenced by:DescribePorts, DescribeCloudRouters, DescribePrivateConnects, DescribeInternets

Parameter Name
Type
Description

tags

Array of Tag

List of tag pairs.

TrafficData

Describes a bandwidth data point.

Referenced by:DescribeInternetTraffic, DescribePrivateConnectTraffic, DescribeCloudRouterEdgePointTraffic, DescribePortTraffic, DescribeCloudRouterDCToDCTraffic

Parameter Name
Type
Description

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

Value
Description

Average

Average value.

Maximum

Maximum value.

Last updated