Data Types

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.

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.

CONSOLE

Created via the Console.

OSS

Created via the VIP process.

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.

PrivateConnect

Private Connect

CloudRouter

Cloud Router

cloudRegionId

String

Public cloud region ID.

dataCenter

DatacenterInfo

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.

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

Array of CloudRouterEdgePoint

List of edge points of the Cloud Router.

cloudRouterStatus

BusinessStatus

Business status of the Cloud Router.

connectivityStatus

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

BusinessSource

Business source of the Cloud Router.

tags

Tags

Tags associated with the Cloud Router.

vpcId

String

VPC ID.

vpcName

String

VPC name.

dataCenter

DatacenterInfo

Data center information of the VPC.

cidrBlock

String

CIDR block of the VPC.

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

ConnectivityStatus

Connectivity status of the edge point.

dataCenter

DatacenterInfo

Data center information of the edge point.

edgePointType

EdgePointType

Edge point type.

cloudType

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

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.

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

ACTIVE

The link is connected normally.

DOWN

The link is down.

ABNORMAL

The link is partially abnormal.

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

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

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

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

BackupIPSecConfig

No

Backup IPSec tunnel configuration.

ipSecBgpConnection

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.

marketingInfo

MarketingInfo

No

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

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

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

CloudType

No

Cloud vendor type.

endpointName

String

No

Endpoint name. Only letters, digits, and hyphens are allowed.

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.

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.

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.

crossConnectPrice

PriceItem

Cross Connect price.

This value is null if the current data center does not support Zenlayer-assisted Cross Connect construction.

crossConnectOneTimeConstructionPrice

PriceItem

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

PriceItem

Price information.

stock

Integer

Available stock quantity.

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.

VPC

VPC access point

ZBG

Border gateway access point

IptZBG

Remote IP tunnel 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

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

IP Transit endpoint.

OTHER_PORT

Third-party port endpoint.

PRIMARY

Primary.

SECONDARY

Secondary.

haType

HaType

HA type.

isUsed

Boolean

Whether this HA type has already been used.

prefix

String

Yes

Destination CIDR of the static route.

nextHop

String

Yes

Next-hop IP address of the static route.

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.

cidr

String

Yes

Destination CIDR of the static route.

ByBandwidth

Fixed bandwidth billing.

ByInstanceBandwidth95

95th percentile billing.

lagId

String

LAG ID.

lagName

String

LAG name.

LOA_NOT_UPLOAD

LOA not uploaded

LOA_UPLOADED

LOA uploaded

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.

STANDARD

Standard port, billed at a fixed bandwidth spec.

UNLIMITED

Unlimited port, billed by actual traffic used.

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

ConnectivityStatus

Port connection status.

portStatus

BusinessStatus

Port business status.

loaStatus

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

Tags associated with the port.

lag

LagInfo

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.

dcId

String

Data center four-letter code.

portType

String

Port spec.

portCategory

PortCategory

Port category.

portPrice

PriceItem

Port price information.

stock

Integer

Stock quantity.

STANDARD

Standard price.

CUSTOMIZED

Fixed price.

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

PriceCategory

Price category.

privateConnectId

String

Private Connect ID.

privateConnectName

String

Private Connect name.

connectivityStatus

ConnectivityStatus

Connectivity status.

privateConnectStatus

BusinessStatus

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

PrivateConnectEndpoint

Endpoint A of the Private Connect.

endpointZ

PrivateConnectEndpoint

Endpoint Z of the Private Connect.

source

BusinessSource

Business source.

tags

Tags

Associated tags.

endpointId

String

Endpoint ID.

endpointName

String

Endpoint name.

endpointType

EndpointType

Endpoint type.

connectivityStatus

ConnectivityStatus

Connectivity status.

vlanId

Integer

VLAN ID.

dataCenter

DatacenterInfo

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.

dcId

String

Yes

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

cloudType

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

crossConnectPrice

PriceItem

Cross Connect price.

Populated when the endpoint type is a data center port and the data center supports Zenlayer-assisted Cross Connect construction.

crossConnectOneTimeConstructionPrice

PriceItem

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

PriceItem

Price information.

stock

Integer

Available stock quantity.

SINGLE_PROTECTED

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

SINGLE_UNPROTECTED

Single-path unprotected -- no line protection.

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

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.

key

String

Yes

Tag key.

Length: 1-64 characters.

value

String

No

Tag value.

Length: 1-64 characters.

tags

Array of Tag

Yes

List of tag pairs.

tags

Array of Tag

List of tag pairs.

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🇲🇲ssZ.

Average

Average value.

Maximum

Maximum value.