> For the complete documentation index, see [llms.txt](https://docs.console.zenlayer.com/api-reference/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.console.zenlayer.com/api-reference/sdn/datastructure.md).

# Data Types

## BFDConfig

BFD configuration.

Referenced by：ModifyInternetConfig, CreateInternet, DescribeInternets

| Parameter Name | Type    | Required | Description                                                                                            |
| -------------- | ------- | -------- | ------------------------------------------------------------------------------------------------------ |
| bfdTxInterval  | Integer | No       | <p>Transmit interval.</p><p>Unit: ms.</p><p>Value range: 100-6000.</p><p>Value range: \[100, 6000]</p> |
| bfdRxInterval  | Integer | No       | <p>Receive interval.</p><p>Unit: ms.</p><p>Value range: 100-6000.</p><p>Value range: \[100, 6000]</p>  |
| bfdMultiplier  | Integer | No       | <p>Detection multiplier.</p><p>Value range: 3-20.</p><p>Value range: \[3, 20]</p>                      |

## 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      | <p>Peer BGP ASN.</p><p>Value range: \[1, 4294967294]</p> |
| 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     | [DatacenterInfo](#datacenterinfo)      | Data center information of the access point.                                                                |
| products       | Array of [CloudProduct](#cloudproduct) | List of products supported in this region: PrivateConnect (Layer 2 network), CloudRouter (Layer 3 network). |
| haTypes        | Array of [HaTypeInfo](#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             | Array of [CloudRouterEdgePoint](#cloudrouteredgepoint) | List of edge points of the Cloud Router.                |
| cloudRouterStatus      | [BusinessStatus](#businessstatus)                      | Business status of the Cloud Router.                    |
| connectivityStatus     | [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](#businesssource)                      | Business source of the Cloud Router.                    |
| tags                   | [Tags](#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     | [DatacenterInfo](#datacenterinfo) | 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                                   | <p>Backbone bandwidth limit of the edge point, in Mbps.</p><p>Value range: \[10, +)</p><p>Default value: 10</p>                                                        |
| edgePointId        | String                                    | Edge point ID.                                                                                                                                                         |
| edgePointName      | String                                    | Edge point name.                                                                                                                                                       |
| connectivityStatus | [ConnectivityStatus](#connectivitystatus) | Connectivity status of the edge point.                                                                                                                                 |
| dataCenter         | [DatacenterInfo](#datacenterinfo)         | Data center information of the edge point.                                                                                                                             |
| edgePointType      | [EdgePointType](#edgepointtype)           | Edge point type.                                                                                                                                                       |
| cloudType          | [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                                    | <p>Shared channel ID.</p><p>The cloud-side connection identifier corresponding to a public cloud access point; only populated for public cloud type access points.</p> |
| vlanId             | Integer                                   | <p>VLAN ID of the edge point. Value range: 2-4000.</p><p>Value range: \[2, 4000]</p>                                                                                   |
| bgpConnection      | [BGPConnection](#bgpconnection)           | BGP connection configuration of the edge point.                                                                                                                        |
| staticRoutes       | Array of [IPRoute](#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      | <p>Backbone bandwidth limit of the edge point, in Mbps.</p><p>Value range: \[10, +)</p><p>Default value: 10</p> |
| 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](#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](#hatype)                              | No       | HA type of the Cloud Connect edge point.                                                                        |
| vlanId               | Integer                                        | No       | <p>VLAN ID of the edge point. Value range: 2-4000.</p><p>Value range: \[2, 4000]</p>                            |
| cloudBandwidthMbps   | Integer                                        | No       | <p>Cloud-side bandwidth limit of the Cloud Connect edge point, in Mbps.</p><p>Value range: \[10, +)</p>         |
| ipAddress            | String                                         | No       | Interconnect IP address and netmask of the edge point.                                                          |
| bgpConnection        | [BGPConnection](#bgpconnection)                | No       | BGP connection configuration of the edge point. Choose either this or static routes.                            |
| staticRoutes         | Array of [IPRoute](#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       | <p>Whether to enable health check. Disabled by default.</p><p>Default value: false</p>                          |
| backupIpSec          | [BackupIPSecConfig](#backupipsecconfig)        | No       | Backup IPSec tunnel configuration.                                                                              |
| ipSecBgpConnection   | [IPSecBGPConnection](#ipsecbgpconnection)      | No       | BGP connection configuration for IPSec. Choose either this or IPSec static routes.                              |
| ipSecStaticRoutes    | Array of [IPSecStaticRoute](#ipsecstaticroute) | No       | Static route configuration for IPSec. Choose either this or an IPSec BGP connection.                            |
| marketingInfo        | [MarketingInfo](#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       | <p>Physical port ID.</p><p>Used when the endpoint is a physical port.</p>                                                                                                                                                                                       |
| vlanId             | Integer                 | No       | <p>VLAN ID.</p><p>Value range: \[1, +)</p>                                                                                                                                                                                                                      |
| cloudRegionId      | String                  | No       | <p>Cloud region ID.</p><p>Used when the endpoint is a Cloud Connect.</p>                                                                                                                                                                                        |
| cloudAccountId     | String                  | No       | <p>Cloud account ID.</p><p>Used when the endpoint is a Cloud Connect.</p>                                                                                                                                                                                       |
| haType             | [HaType](#hatype)       | No       | <p>HA type of the Cloud Connect.</p><p>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 <code>haTypes</code> returned by <code>DescribeAzureRegions</code>.</p> |
| cloudBandwidthMbps | Integer                 | No       | <p>Cloud Connect bandwidth limit, in Mbps.</p><p>Value range: \[10, +)</p>                                                                                                                                                                                      |
| dcId               | String                  | No       | Data center ID.                                                                                                                                                                                                                                                 |
| cloudType          | [CloudType](#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](#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                    | [PriceItem](#priceitem) | <p>Cross Connect price.</p><p>This value is null if the current data center does not support Zenlayer-assisted Cross Connect construction.</p>                     |
| crossConnectOneTimeConstructionPrice | [PriceItem](#priceitem) | <p>Cross Connect one-time construction fee.</p><p>This value is null if the current data center does not support Zenlayer-assisted Cross Connect construction.</p> |
| dcId                                 | String                  | Data center ID.                                                                                                                                                    |
| price                                | [PriceItem](#priceitem) | 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         | [HaType](#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          | [DatacenterInfo](#datacenterinfo)                | Data center of the Internet.                                                                             |
| peerPortId          | String                                           | Connected port ID.                                                                                       |
| peerPortName        | String                                           | Connected port name.                                                                                     |
| peerDataCenter      | [DatacenterInfo](#datacenterinfo)                | Data center of the port side.                                                                            |
| deliveryType        | [InternetDeliveryType](#internetdeliverytype)    | Delivery type.                                                                                           |
| resourceGroupId     | String                                           | Resource group ID of the Internet.                                                                       |
| resourceGroupName   | String                                           | Resource group name of the Internet.                                                                     |
| createTime          | String                                           | <p>Creation time.</p><p>Format: YYYY-MM-ddTHH:mm:ssZ.</p>                                                |
| routingType         | [InternetRouteType](#internetroutetype)          | Routing type.                                                                                            |
| internetType        | [InternetType](#internettype)                    | Bandwidth billing method.                                                                                |
| bandwidth           | Integer                                          | <p>Bandwidth cap.</p><p>Unit: Mbps.</p>                                                                  |
| commitBandwidth     | Integer                                          | <p>Committed bandwidth.</p><p>Only available when bandwidth billing method is ByInstanceBandwidth95.</p> |
| bfd                 | [BFDConfig](#bfdconfig)                          | BFD configuration.                                                                                       |
| bgp                 | [InternetBgpConfig](#internetbgpconfig)          | BGP configurations.                                                                                      |
| interconnect        | [InternetInterconnect](#internetinterconnect)    | 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](#ipaddress)                 | Public IP information.                                                                                   |
| internetStatus      | [InternetStatus](#internetstatus)                | Internet state.                                                                                          |
| connectivityStatus  | [ConnectivityStatus](#connectivitystatus)        | Link connectivity status.                                                                                |
| tags                | [Tags](#tags)                                    | Tags bound to the Internet.                                                                              |
| publicIpAddresses   | Array of [InternetIpAddress](#internetipaddress) | List of public IP addresses.                                                                             |
| haMode              | [InternetHaMode](#internethamode)                | HA mode.                                                                                                 |
| zbgRegionId         | String                                           | <p>ZBG region ID.</p><p>Returned for Internet instances in ZBG scenarios.</p>                            |
| peerPortType        | [InternetPeerPortType](#internetpeerporttype)    | Peer port type.                                                                                          |
| haLinks             | Array of [InternetHaLink](#internethalink)       | <p>List of HA sub-links.</p><p>Null for non-HA mode. Contains two sub-link objects for HA mode.</p>      |

## InternetAsnInfo

Available ASN information.

Referenced by：DescribeInternetAvailableAsns

| Parameter Name | Type                                | Description                                                   |
| -------------- | ----------------------------------- | ------------------------------------------------------------- |
| asn            | String                              | ASN value.                                                    |
| asnType        | [InternetAsnType](#internetasntype) | 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                | [InternetRouteType](#internetroutetype)                            | Routing type.                                                                                                                                                                 |
| availableBgpRouteTypes     | Array of [InternetBgpConfigRouteType](#internetbgpconfigroutetype) | <p>List of available BGP route types.</p><p>Returned only when <code>routingType</code> is BGP.</p>                                                                           |
| availableBgpTiers          | Array of [InternetBgpTier](#internetbgptier)                       | <p>Available BGP tiers.</p><p>Only available when <code>routingType</code> is BGP.</p>                                                                                        |
| peerAsns                   | Array of [InternetPeerAsn](#internetpeerasn)                       | <p>Zenlayer-side (peer) AS numbers for each BGP tier, used to configure the BGP neighbor on your local router.</p><p>Only available when <code>routingType</code> is BGP.</p> |
| deliveryType               | [InternetDeliveryType](#internetdeliverytype)                      | Delivery type.                                                                                                                                                                |
| publicInterconnectNetmasks | Array of Integer                                                   | <p>List of available IPv4 public interconnect netmasks.</p><p>Currently only 30 / 31 are supported.</p>                                                                       |

## InternetBgpConfig

BGP configurations.

Referenced by：CreateInternet, DescribeInternets

| Parameter Name | Type                                                      | Required | Description                                                                                                                                                           |
| -------------- | --------------------------------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| routeType      | [InternetBgpConfigRouteType](#internetbgpconfigroutetype) | Yes      | Inbound route type.                                                                                                                                                   |
| tier           | [InternetBgpTier](#internetbgptier)                       | No       | <p>BGP tier.</p><p>STANDARD: Standard BGP. PREMIUM: Premium BGP.</p><p>Defaults to PREMIUM if not specified (consistent with the behavior before the tier split).</p> |
| 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      | [InternetBgpRouteType](#internetbgproutetype) | No       | <p>BGP inbound route type.</p><p>Required when type is BGP\_ROUTE\_TYPE.</p>          |
| asnList        | Array of Integer                              | No       | <p>List of ASNs.</p><p>Effective when type is BGP\_ASN\_AS\_SET.</p>                  |
| asSetList      | Array of String                               | No       | <p>List of AS-SETs.</p><p>Effective when type is BGP\_ASN\_AS\_SET.</p>               |
| password       | String                                        | No       | <p>BGP MD5 password (8-64 characters).</p><p>Required when type is BGP\_PASSWORD.</p> |

## 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 | <p>Standard BGP.</p><p>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.</p>   |
| PREMIUM  | <p>Premium BGP.</p><p>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.</p> |

## InternetCidrBlock

Available CIDR block information.

Referenced by：DescribeInternetAvailableCidrBlocks

| Parameter Name | Type                                            | Description                                                        |
| -------------- | ----------------------------------------------- | ------------------------------------------------------------------ |
| netmask        | Integer                                         | <p>Netmask length.</p><p>IPv4 range: 24-32. IPv6 range: 48-64.</p> |
| ipNetworkType  | [InternetIpNetworkType](#internetipnetworktype) | 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    | <p>Add a public IP address block.</p><p>Not supported for instances with the Standard BGP tier (<code>bgp.tier=STANDARD</code>).</p> |
| 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            | [DatacenterInfo](#datacenterinfo)                                      | Data center information.               |
| availableRoutingTypes | Array of [InternetAvailableRoutingType](#internetavailableroutingtype) | 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              | [InternetHaMode](#internethamode) | Yes      | HA operating mode.                                                                                                                        |
| secondaryPortId     | String                            | Yes      | <p>Access port ID of the secondary link.</p><p>Must be in the same city as but a different data center from the top-level peerPortId.</p> |
| secondaryPortVlanId | Integer                           | Yes      | VLAN ID of the secondary link port.                                                                                                       |

## InternetHaLink

HA sub-link information.

Referenced by：DescribeInternets

| Parameter Name     | Type                                          | Description                                                                                                                                                                                    |
| ------------------ | --------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| isPrimary          | Boolean                                       | <p>Whether this is currently the primary link.</p><p>In ACTIVE\_STANDBY mode, this dynamically reflects the primary/secondary switchover state. In ACTIVE\_ACTIVE mode, the value is null.</p> |
| internetStatus     | [InternetStatus](#internetstatus)             | State of the sub-link.                                                                                                                                                                         |
| connectivityStatus | [ConnectivityStatus](#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     | [DatacenterInfo](#datacenterinfo)             | Data center of the port.                                                                                                                                                                       |
| peerPortVlan       | Integer                                       | VLAN ID.                                                                                                                                                                                       |
| interconnect       | [InternetInterconnect](#internetinterconnect) | Interconnect IP configuration.                                                                                                                                                                 |

## InternetHaMode

HA mode.

Referenced by：InquiryCreateInternetPrice, DescribeInternets

| Value           | Description                                                                     |
| --------------- | ------------------------------------------------------------------------------- |
| ACTIVE\_STANDBY | <p>Active/standby mode.</p><p>Only the primary link forwards traffic.</p>       |
| ACTIVE\_ACTIVE  | <p>Active/active mode.</p><p>Both sub-links forward traffic simultaneously.</p> |

## 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                                          | <p>IP block UUID.</p><p>Passed as ipUuid when modifying (expanding/shrinking/deleting).</p> |
| ipAddress        | String                                          | IP address (in CIDR notation, e.g., 192.0.2.0/30).                                          |
| netmask          | Integer                                         | Netmask length.                                                                             |
| gatewayIpAddress | String                                          | Gateway IP.                                                                                 |
| ipType           | [InternetIpType](#internetiptype)               | IP type (IPV4 / IPV6).                                                                      |
| ipNetworkType    | [InternetIpNetworkType](#internetipnetworktype) | 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          | [PriceItem](#priceitem)                         | Price information of the IP CIDR. |
| netmask        | Integer                                         | Netmask length.                   |
| qty            | Integer                                         | Quantity.                         |
| ipNetworkType  | [InternetIpNetworkType](#internetipnetworktype) | IP network type.                  |

## InternetIpPriceItem

CIDR block price information.

Referenced by：InquiryModifyInternetPrice

| Parameter Name | Type                                            | Description                            |
| -------------- | ----------------------------------------------- | -------------------------------------- |
| price          | [PriceItem](#priceitem)                         | Price information.                     |
| netmask        | Integer                                         | CIDR netmask length.                   |
| amount         | Integer                                         | Quantity.                              |
| ipNetworkType  | [InternetIpNetworkType](#internetipnetworktype) | IP network type (BGP\_IP / LOCAL\_IP). |

## InternetIpRequest

Public IP allocation request.

Referenced by：CreateInternet, InquiryCreateInternetPrice

| Parameter Name | Type                                            | Required | Description                                                                                                         |
| -------------- | ----------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------- |
| netmask        | Integer                                         | Yes      | <p>CIDR netmask length.</p><p>Valid IPv4 range: 24-30. Valid IPv6 range: 48-64.</p>                                 |
| ipType         | [InternetIpType](#internetiptype)               | Yes      | IP type (IPV4 / IPV6).                                                                                              |
| ipNetworkType  | [InternetIpNetworkType](#internetipnetworktype) | No       | <p>IP network type.</p><p>Default: BGP\_IP (allocated from the IP pool).</p><p>LOCAL\_IP indicates a native IP.</p> |
| amount         | Integer                                         | No       | <p>Purchase quantity.</p><p>Specifies the number of IP blocks with the same netmask length. Default: 1.</p>         |

## 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           | [InternetBgpTier](#internetbgptier) | 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       | <p>Discount code issued by marketing.</p><p>If the discount code does not exist, the final discount will not apply.</p>    |
| usePocVoucher  | Boolean | No       | <p>Whether to use a POC voucher.</p><p>If no POC voucher exists in the system, the related creation process will fail.</p> |

## 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        | [ConnectivityStatus](#connectivitystatus) | Port connection status.                                                                                                                                                                                                                          |
| portStatus              | [BusinessStatus](#businessstatus)         | Port business status.                                                                                                                                                                                                                            |
| loaStatus               | [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)                             | Tags associated with the port.                                                                                                                                                                                                                   |
| lag                     | [LagInfo](#laginfo)                       | <p>The LAG to which the port belongs.</p><p>Empty if the port has not joined a LAG.</p><p>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.</p> |

## 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   | [PortCategory](#portcategory) | Port category.                |
| portPrice      | [PriceItem](#priceitem)       | 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                            | <p>Discount rate.</p><p>E.g. 80.0 means 20% off.</p>                                                                                                                                              |
| discountPrice           | Float                            | <p>Discounted postpaid unit price.</p><p>Used in postpaid mode; null if the price is a tiered price.</p>                                                                                          |
| originalPrice           | Float                            | <p>Original prepaid price.</p><p>Used in prepaid mode; null for postpaid.</p>                                                                                                                     |
| unitPrice               | Float                            | <p>Original postpaid unit price.</p><p>Used in postpaid mode; null if the price is a tiered price.</p>                                                                                            |
| discountUnitPrice       | Float                            | <p>Discounted postpaid unit price.</p><p>Used in postpaid mode; null if the price is a tiered price.</p>                                                                                          |
| chargeUnit              | String                           | <p>Postpaid billing unit.</p><p>Used in postpaid mode. Possible values:<br>HOUR: billed per hour.</p><p>DAY: billed per day.</p><p>MONTH: billed per month, used for 95th-percentile billing.</p> |
| stepPrices              | Array of [StepPrice](#stepprice) | <p>Postpaid tiered pricing.</p><p>Used in postpaid mode; null if not a tiered price.</p>                                                                                                          |
| amountUnit              | String                           | <p>Usage unit.</p><p>E.g. Mbps, LCU, etc.</p><p>If null, the value is unavailable.</p>                                                                                                            |
| excessUnitPrice         | Float                            | Original excess price.                                                                                                                                                                            |
| excessDiscountUnitPrice | Float                            | Discounted excess price.                                                                                                                                                                          |
| excessAmountUnit        | String                           | <p>Excess usage unit.</p><p>If null, the value is unavailable.</p>                                                                                                                                |
| category                | [PriceCategory](#pricecategory)  | 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   | [ConnectivityStatus](#connectivitystatus)         | Connectivity status.               |
| privateConnectStatus | [BusinessStatus](#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](#privateconnectendpoint) | Endpoint A of the Private Connect. |
| endpointZ            | [PrivateConnectEndpoint](#privateconnectendpoint) | Endpoint Z of the Private Connect. |
| source               | [BusinessSource](#businesssource)                 | Business source.                   |
| tags                 | [Tags](#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       | [EndpointType](#endpointtype)             | Endpoint type.                                                                                                                                                         |
| connectivityStatus | [ConnectivityStatus](#connectivitystatus) | Connectivity status.                                                                                                                                                   |
| vlanId             | Integer                                   | VLAN ID.                                                                                                                                                               |
| dataCenter         | [DatacenterInfo](#datacenterinfo)         | Data center information.                                                                                                                                               |
| cloudRegionId      | String                                    | <p>Cloud region ID.</p><p>Returned when the endpoint is a Cloud Connect.</p>                                                                                           |
| cloudAccountId     | String                                    | <p>Cloud account ID.</p><p>Returned when the endpoint is a Cloud Connect.</p>                                                                                          |
| sharedChannelId    | String                                    | <p>Shared channel ID.</p><p>The cloud-side connection identifier corresponding to a public cloud access point; only populated for public cloud type access points.</p> |

## 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](https://docs.console.zenlayer.com/api-reference/sdn/location/describedatacenters.md) API.                                                                                               |
| cloudType                     | [CloudType](#cloudtype) | No       | Cloud Connect type.                                                                                                                                                                                                                                                                   |
| bandwidthMbps                 | Integer                 | No       | <p>Maximum bandwidth limit for the Cloud Connect.</p><p>Default: 10, unit: Mbps.</p><p>Value range: \[10, +)</p><p>Default value: 10</p>                                                                                                                                              |
| vlanId                        | Integer                 | No       | <p>VLAN ID.</p><p>Value range: \[2, 4000]</p>                                                                                                                                                                                                                                         |
| cloudRegionId                 | String                  | No       | <p>Public cloud region ID.</p><p>Not required for Google Cloud.</p>                                                                                                                                                                                                                   |
| portType                      | String                  | No       | Port spec. The latest port spec list can be obtained via the [DescribeDataCenterPortPrice](https://docs.console.zenlayer.com/api-reference/sdn/data-center-port/describedatacenterportprice.md) API.                                                                                  |
| buildCrossConnectWithAssisted | Boolean                 | No       | <p>Whether Zenlayer-assisted Cross Connect construction is required.</p><p>If true, the price includes the Cross Connect patch cord fee and the one-time construction fee.</p><p>Default: false, meaning the user builds the Cross Connect themselves.</p><p>Default value: false</p> |

## PrivateConnectEndpointPrice

Describes price information for a Private Connect endpoint.

Referenced by：QueryPrivateConnectPrice

| Parameter Name                       | Type                    | Description                                                                                                                                                                             |
| ------------------------------------ | ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| crossConnectPrice                    | [PriceItem](#priceitem) | <p>Cross Connect price.</p><p>Populated when the endpoint type is a data center port and the data center supports Zenlayer-assisted Cross Connect construction.</p>                     |
| crossConnectOneTimeConstructionPrice | [PriceItem](#priceitem) | <p>Cross Connect one-time construction fee.</p><p>Populated when the endpoint type is a data center port and the data center supports Zenlayer-assisted Cross Connect construction.</p> |
| price                                | [PriceItem](#priceitem) | 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 | <p>Upper bound of the tier.</p><p>Null represents the last tier.</p> |
| 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      | <p>Tag key.</p><p>Length: 1-64 characters.</p>   |
| value          | String | No       | <p>Tag value.</p><p>Length: 1-64 characters.</p> |

## 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](#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](#tag) | List of tag pairs. |

## TrafficData

Describes a bandwidth data point.

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

| Parameter Name | Type    | Description                                                                                        |
| -------------- | ------- | -------------------------------------------------------------------------------------------------- |
| internetRX     | Integer | <p>Inbound bandwidth value.</p><p>Unit: bps.</p>                                                   |
| internetTX     | Integer | <p>Outbound bandwidth value.</p><p>Unit: bps.</p>                                                  |
| time           | String  | <p>Data timestamp.</p><p>In ISO 8601 format, UTC timezone.</p><p>Format: YYYY-MM-ddTHH:mm:ssZ.</p> |

## TrafficStatistic

Statistical method of traffic data.

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

| Value   | Description    |
| ------- | -------------- |
| Average | Average value. |
| Maximum | Maximum value. |
