> 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/networking/sdn/datastructure.md). # Data Types ## BGPConnection Configuration information for the BGP connection. Referenced by：CreateCloudRouter, DescribeCloudRouters, ModifyCloudRouterEdgePoint | Parameter Name | Type | Required | Description | | -------------- | ------- | -------- | -------------------------------------------------------- | | peerIpAddress | String | Yes | Peer interconnect IP address and netmask. | | peerAsn | Integer | Yes |

Peer BGP ASN.

Value range: \[1, 4294967294]

| | password | String | No | MD5 password for the BGP session, up to 32 characters. | | localAsn | Integer | No | Local BGP ASN. | ## BackupIPSecConfig Configuration information for the backup IPSec tunnel. Referenced by：CreateCloudRouter | Parameter Name | Type | Required | Description | | -------------------- | ------ | -------- | --------------------------------------------------------------------- | | dcId | String | No | ID of the data center where the backup IPSec tunnel resides. | | password | String | No | Authentication password for the backup IPSec tunnel, 8-64 characters. | | customerPrivateIP | String | No | Customer-side private IP address of the backup IPSec tunnel. | | virtualEdgePrivateIP | String | No | Virtual Edge-side private IP address of the backup IPSec tunnel. | | psk | String | No | Pre-shared key (PSK) for the backup IPSec tunnel. | ## BusinessSource Business source. Referenced by：DescribeCloudRouters, DescribePrivateConnects | Value | Description | | ------- | ---------------------------- | | CONSOLE | Created via the Console. | | OSS | Created via the VIP process. | ## BusinessStatus Business status. Referenced by：DescribePorts, DescribeCloudRouters, DescribePrivateConnects | Value | Description | | ------------------ | ------------------- | | CREATING | Creating. | | UPDATING | Updating. | | DELETING | Deleting. | | DESTROYING | Destroying. | | RECOVERING | Restoring. | | RUNNING | Normal. | | NOT\_ACCEPT | Not accepted. | | RECYCLED | Recycled. | | DESTROYED | Destroyed. | | CREATING\_FAILED | Creation failed. | | UPDATING\_FAILED | Update failed. | | DELETING\_FAILED | Deletion failed. | | DESTROYING\_FAILED | Destruction failed. | | RECOVERING\_FAILED | Restore failed. | ## CloudProduct Product type. Referenced by：DescribeAliCloudRegions, DescribeAzureRegions, DescribeHuaweiCloudRegions, DescribeBytePlusRegions, DescribeTencentRegions, 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, 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 |

Backbone bandwidth limit of the edge point, in Mbps.

Value range: \[10, +)

Default value: 10

| | edgePointId | String | Edge point ID. | | edgePointName | String | Edge point name. | | connectivityStatus | [ConnectivityStatus](#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 |

Shared channel ID.

The cloud-side connection identifier corresponding to a public cloud access point; only populated for public cloud type access points.

| | vlanId | Integer |

VLAN ID of the edge point. Value range: 2-4000.

Value range: \[2, 4000]

| | bgpConnection | [BGPConnection](#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：DescribeCloudAvailableBandwidthTiers, CreateCloudRouter, DescribeCloudRouters, CreatePrivateConnect, 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 | | ORACLE | Oracle Cloud | ## ConnectivityStatus Connectivity status of the link. Referenced by：DescribePorts, DescribeCloudRouters, DescribePrivateConnects | Value | Description | | -------- | ------------------------------- | | ACTIVE | The link is connected normally. | | DOWN | The link is down. | | ABNORMAL | The link is partially abnormal. | ## CreateCloudRouterEdgePoint Configuration for creating a Cloud Router edge point. Referenced by：CreateCloudRouter, AddCloudRouterEdgePoints | Parameter Name | Type | Required | Description | | -------------------- | ---------------------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------- | | bandwidthMbps | Integer | Yes |

Backbone bandwidth limit of the edge point, in Mbps.

Value range: \[10, +)

Default value: 10

| | edgePointName | String | No | Edge point name. Only letters, digits, and hyphens are allowed, up to 100 characters. | | vpcId | String | No | VPC ID of a VPC edge point. | | zbgId | String | No | ZBG ID of a ZBG edge point. | | portId | String | No | Port ID of a physical port edge point. | | cloudType | [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 |

VLAN ID of the edge point. Value range: 2-4000.

Value range: \[2, 4000]

| | cloudBandwidthMbps | Integer | No |

Cloud-side bandwidth limit of the Cloud Connect edge point, in Mbps.

Value range: \[10, +)

| | ipAddress | String | No | Interconnect IP address and netmask of the edge point. | | bgpConnection | [BGPConnection](#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 |

Whether to enable health check. Disabled by default.

Default value: false

| | 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. | ## CreateEndpointParam Parameters for an endpoint when creating a Private Connect. Referenced by：InquiryCreatePrivateConnectPrice, CreatePrivateConnect | Parameter Name | Type | Required | Description | | ------------------ | ----------------------- | -------- | -------------------------------------------------------------------------- | | portId | String | No |

Physical port ID.

Used when the endpoint is a physical port.

| | vlanId | Integer | No |

VLAN ID.

Value range: \[1, +)

| | cloudRegionId | String | No |

Cloud region ID.

Used when the endpoint is a Cloud Connect.

| | cloudAccountId | String | No |

Cloud account ID.

Used when the endpoint is a Cloud Connect.

| | haType | [HaType](#hatype) | No | HA type of the Cloud Connect. | | cloudBandwidthMbps | Integer | No |

Cloud Connect bandwidth limit, in Mbps.

Value range: \[10, +)

| | 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 | 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) |

Cross Connect price.

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

| | crossConnectOneTimeConstructionPrice | [PriceItem](#priceitem) |

Cross Connect one-time construction fee.

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

| | dcId | String | Data center ID. | | price | [PriceItem](#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 | Remote IP tunnel border gateway access point | | PORT | Data center physical port access point | | OTHER\_PORT | Third-party port access point | | KEY\_PORT | Key Port access point | | GOOGLE | Google Cloud access point | | TENCENT | Tencent Cloud access point | | ALICLOUD | Alibaba Cloud access point | | AZURE | Azure access point | | AWS | AWS access point | | VIRTUAL\_EDGE | Virtual Edge access point | | ORACLE | Oracle access point | | HUAWEI | Huawei Cloud access point | | BYTEPLUS | BytePlus access point | ## 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. | | PORT | Data center physical port endpoint. | | Ript | IP Transit endpoint. | | OTHER\_PORT | Third-party port endpoint. | ## HaType HA type. Referenced by：CreateCloudRouter, CreatePrivateConnect, 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. | ## 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. | ## InternetType Internet billing type. Referenced by：QueryPrivateConnectBandwidthPrice, InquiryCreatePrivateConnectPrice, QueryPrivateConnectPrice | Value | Description | | --------------------- | ------------------------ | | ByBandwidth | Fixed bandwidth billing. | | ByInstanceBandwidth95 | 95th percentile billing. | ## 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, CreateCloudRouter, CreatePrivateConnect | Parameter Name | Type | Required | Description | | -------------- | ------- | -------- | -------------------------------------------------------------------------------------------------------------------------- | | discountCode | String | No |

Discount code issued by marketing.

If the discount code does not exist, the final discount will not apply.

| | usePocVoucher | Boolean | No |

Whether to use a POC voucher.

If no POC voucher exists in the system, the related creation process will fail.

| ## PortCategory Port category. Referenced by：DescribeDataCenterPortPrice | Value | Description | | --------- | ------------------------------------------------ | | STANDARD | Standard port, billed at a fixed bandwidth spec. | | UNLIMITED | Unlimited port, billed by actual traffic used. | ## PortInfo Describes detailed information about the port. Referenced by：DescribePorts, DescribeCloudRouterAvailablePorts, DescribePrivateConnectAvailablePorts | Parameter Name | Type | Description | | ----------------------- | ----------------------------------------- | ------------------------------------------------- | | portId | String | Port ID. | | portName | String | Port name. | | portRemarks | String | Port remarks. | | portType | String | Port spec. | | dcId | String | Data center four-letter code. | | dcName | String | Data center name. | | cityName | String | City name. | | areaName | String | Name of the region. | | businessEntityName | String | Business entity name, used as the LOA letterhead. | | connectionStatus | [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. | ## 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：DescribeDataCenterPortPrice | Value | Description | | ---------- | --------------- | | STANDARD | Standard price. | | CUSTOMIZED | Fixed price. | ## PriceItem Describes price information. Referenced by：QueryPrivateConnectBandwidthPrice, QueryDataCenterPortPrice, InquiryCreatePrivateConnectPrice, QueryDataCenterPortPrices, QueryCloudRouterBandwidthPrice, DescribeDataCenterPortPrice, QueryCloudOnrampPrice, QueryPrivateConnectPrice | Parameter Name | Type | Description | | ----------------------- | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | discount | Float |

Discount rate.

E.g. 80.0 means 20% off.

| | discountPrice | Float |

Discounted postpaid unit price.

Used in postpaid mode; null if the price is a tiered price.

| | originalPrice | Float |

Original prepaid price.

Used in prepaid mode; null for postpaid.

| | unitPrice | Float |

Original postpaid unit price.

Used in postpaid mode; null if the price is a tiered price.

| | discountUnitPrice | Float |

Discounted postpaid unit price.

Used in postpaid mode; null if the price is a tiered price.

| | chargeUnit | String |

Postpaid billing unit.

Used in postpaid mode. Possible values:
HOUR: billed per hour.

DAY: billed per day.

MONTH: billed per month, used for 95th-percentile billing.

| | stepPrices | Array of [StepPrice](#stepprice) |

Postpaid tiered pricing.

Used in postpaid mode; null if not a tiered price.

| | amountUnit | String |

Usage unit.

E.g. Mbps, LCU, etc.

If null, the value is unavailable.

| | excessUnitPrice | Float | Original excess price. | | excessDiscountUnitPrice | Float | Discounted excess price. | | excessAmountUnit | String |

Excess usage unit.

If null, the value is unavailable.

| | category | [PriceCategory](#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 |

Cloud region ID.

Returned when the endpoint is a Cloud Connect.

| | cloudAccountId | String |

Cloud account ID.

Returned when the endpoint is a Cloud Connect.

| | sharedChannelId | String |

Shared channel ID.

The cloud-side connection identifier corresponding to a public cloud access point; only populated for public cloud type access points.

| ## PrivateConnectEndpointInfo Endpoint information for the Private Connect. The endpoint parameters vary depending on the endpoint type. Referenced by：QueryPrivateConnectPrice | Parameter Name | Type | Required | Description | | ----------------------------- | ----------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | dcId | String | Yes | Data center ID. The latest list of data centers can be obtained via the DescribeDataCenters API. | | cloudType | [CloudType](#cloudtype) | No | Cloud Connect type. | | bandwidthMbps | Integer | No |

Maximum bandwidth limit for the Cloud Connect.

Default: 10, unit: Mbps.

Value range: \[10, +)

Default value: 10

| | vlanId | Integer | No |

VLAN ID.

Value range: \[2, 4000]

| | cloudRegionId | String | No |

Public cloud region ID.

Not required for Google Cloud.

| | portType | String | No | Port spec. The latest port spec list can be obtained via the DescribeDataCenterPortType API. | | buildCrossConnectWithAssisted | Boolean | No |

Whether Zenlayer-assisted Cross Connect construction is required.

If true, the price includes the Cross Connect patch cord fee and the one-time construction fee.

Default: false, meaning the user builds the Cross Connect themselves.

Default value: false

| ## PrivateConnectEndpointPrice Describes price information for a Private Connect endpoint. Referenced by：QueryPrivateConnectPrice | Parameter Name | Type | Description | | ------------------------------------ | ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | crossConnectPrice | [PriceItem](#priceitem) |

Cross Connect price.

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

| | crossConnectOneTimeConstructionPrice | [PriceItem](#priceitem) |

Cross Connect one-time construction fee.

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

| | price | [PriceItem](#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 | | ORACLE | Oracle Cloud | ## StepPrice Describes tiered pricing information. Referenced by：DescribeDataCenterPortPrice | Parameter Name | Type | Description | | ----------------- | ----- | -------------------------------------------------------------------- | | stepStart | Float | Lower bound of the tier. | | stepEnd | Float |

Upper bound of the tier.

Null represents the last tier.

| | unitPrice | Float | Tier unit price. | | discountUnitPrice | Float | Discounted tier unit price. | ## Tag Describes a tag key-value pair. Referenced by：CreatePort, DescribePorts, DescribeCloudRouters, DescribePrivateConnects | Parameter Name | Type | Required | Description | | -------------- | ------ | -------- | ------------------------------------------------ | | key | String | Yes |

Tag key.

Length: 1-64 characters.

| | value | String | No |

Tag value.

Length: 1-64 characters.

| ## TagAssociation Describes the tag pairs bound at resource creation time. Referenced by：CreatePort, CreateCloudRouter, CreatePrivateConnect | 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 | Parameter Name | Type | Description | | -------------- | -------------------- | ------------------ | | tags | Array of [Tag](#tag) | List of tag pairs. | ## TrafficData Describes a bandwidth data point. Referenced by：DescribePrivateConnectTraffic, DescribeCloudRouterEdgePointTraffic, DescribePortTraffic, DescribeCloudRouterDCToDCTraffic | Parameter Name | Type | Description | | -------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | internetRX | Integer |

Inbound bandwidth value.

Unit: bps.

| | internetTX | Integer |

Outbound bandwidth value.

Unit: bps.

| | time | String |

Data timestamp.

In ISO 8601 format, UTC timezone.

Format: YYYY-MM-ddTHH🇲🇲ssZ.

|