# Data Types

## PortInfo

Basic information on a port, including port name, business entity name, data center, and etc.

<table><thead><tr><th width="219.33333333333331">Parameter Name</th><th width="189">Type</th><th>Description</th></tr></thead><tbody><tr><td>portId</td><td>String</td><td>Port ID.</td></tr><tr><td>portName</td><td>String</td><td>Port name.</td></tr><tr><td>portRemarks</td><td>String</td><td>Port Description.</td></tr><tr><td>portType</td><td>String</td><td>Port speed.<br>Value range: 1G/10G/40G</td></tr><tr><td>connectionStatus</td><td><a href="#connectionstatus">ConnectionStatus</a></td><td>Network connectivity state.</td></tr><tr><td>portStatus</td><td><a href="#portstatus">PortStatus</a></td><td>Port state.</td></tr><tr><td>dcId</td><td>String</td><td>Data center ID</td></tr><tr><td>dcName</td><td>String</td><td>Data center name.</td></tr><tr><td>cityName</td><td>String</td><td>City name.</td></tr><tr><td>areaName</td><td>String</td><td>Region name.</td></tr><tr><td>loaStatus</td><td><a href="#loastatus">LOAStatus</a></td><td>LOA state.</td></tr><tr><td>loaDownloadUrl</td><td>String</td><td>LOA URL address.</td></tr><tr><td>createdTime</td><td><a href="/pages/M4DhDpj2ZXShvmgIF72n">Timestamp</a></td><td><p>Creation time.</p><p>Use UTC time according to the ISO8601 standard. Format: <code>YYYY-MM-DDThh:mm:ssZ</code>.</p></td></tr><tr><td>expiredTime</td><td><a href="/pages/M4DhDpj2ZXShvmgIF72n">Timestamp</a></td><td><p>Expiration time.</p><p>Use UTC time according to the ISO8601 standard. Format: <code>YYYY-MM-DDThh:mm:ssZ</code>.</p></td></tr><tr><td>portChargeType</td><td>String</td><td><p>Port pricing model.</p><p>PREPAID: monthly subscription.</p><p>POSTPAID: pay-as-you-go.</p></td></tr><tr><td>period</td><td>Integer</td><td><p>Period of port subscription.</p><p>Unit: month.</p><p>For postpaid instances, the value is empty.</p></td></tr><tr><td>businessEntityName</td><td>String</td><td><p>Business entity name.</p><p>The entity name to be used on the Letter of Authorization (LOA). This should be the name that is registered with the colocation facility.</p></td></tr><tr><td>tags</td><td><a href="#tags">Tags</a></td><td>Tags bound to the resources.</td></tr></tbody></table>

## ConnectionStatus

Network connectivity state.

<table><thead><tr><th width="318">State</th><th>Description</th></tr></thead><tbody><tr><td>ACTIVE</td><td>The network is connected.</td></tr><tr><td>DOWN</td><td>The network is not connected.</td></tr></tbody></table>

## PortStatus

Port state.

<table><thead><tr><th width="320.1351869606903">State</th><th>Description</th></tr></thead><tbody><tr><td>CREATING</td><td>Creating.</td></tr><tr><td>UPDATING</td><td>Updating.</td></tr><tr><td>DELETING</td><td>Deleting.</td></tr><tr><td>DESTROYING</td><td>Releasing.</td></tr><tr><td>RECOVERING</td><td>Restoring.</td></tr><tr><td>RUNNING</td><td>Running.</td></tr><tr><td>RECYCLED</td><td>Recycled.</td></tr><tr><td>DESTROYED</td><td>Released.</td></tr><tr><td>CREATING_FAILED</td><td>Creating failed.</td></tr><tr><td>UPDATING_FAILED</td><td>Updating failed.</td></tr><tr><td>DELETING_FAILED</td><td>Deleting failed.</td></tr><tr><td>DESTROYING_FAILED</td><td>Releasing failed.</td></tr><tr><td>RECOVERING_FAILED</td><td>Restoring failed.</td></tr></tbody></table>

## PortPrice

Port speed and price.

<table><thead><tr><th width="211.33333333333331">Parameter Name</th><th width="125">Type</th><th>Description</th></tr></thead><tbody><tr><td>dcId</td><td>String</td><td>Data center ID, such as <code>SIN1</code>.</td></tr><tr><td>portType</td><td>String</td><td>Port speed.<br>Value range: 1G/10G/40G</td></tr><tr><td>portDailyPrice</td><td>Float</td><td>Daily price of a port.</td></tr><tr><td>portMonthlyPrice</td><td>Float</td><td>Monthly price of a port.</td></tr></tbody></table>

## LOAStatus

LOA state.

| State            | Description   |
| ---------------- | ------------- |
| LOA\_NOT\_UPLOAD | Not uploaded. |
| LOA\_UPLOADED    | Uploaded.     |

## PortTrafficInfo

Port bandwidth information.

<table><thead><tr><th width="194.33333333333331">Parameter Name</th><th width="187">Type</th><th>Description</th></tr></thead><tbody><tr><td>unit</td><td>String</td><td>Bandwidth unit: bps.</td></tr><tr><td>records</td><td>Array of <a href="#trafficdata">TrafficData</a></td><td>Details of bandwidth.</td></tr><tr><td>inMax</td><td>Double</td><td>Maximum value of inbound bandwidth.</td></tr><tr><td>inMin</td><td>Double</td><td>Minimum value of inbound bandwidth.</td></tr><tr><td>inAvg</td><td>Double</td><td>Average value of inbound bandwidth.</td></tr><tr><td>outMax</td><td>Double</td><td>Maximum value of outbound bandwidth.</td></tr><tr><td>outMin</td><td>Double</td><td>Minimum value of outbound bandwidth.</td></tr><tr><td>outAvg</td><td>Double</td><td>Average value of outbound bandwidth.</td></tr></tbody></table>

## DatacenterInfo

Information on a data center.

<table><thead><tr><th width="221.33333333333331">Parameter Name</th><th width="116">Type</th><th>Description</th></tr></thead><tbody><tr><td>dcId</td><td>String</td><td>Code of a data center, consisting of an IATA airport code and a number.</td></tr><tr><td>dcName</td><td>String</td><td>Data center name.</td></tr><tr><td>dcAddress</td><td>String</td><td>Data center location.</td></tr><tr><td>cityName</td><td>String</td><td>City name.</td></tr><tr><td>countryName</td><td>String</td><td>Country name.</td></tr><tr><td>areaName</td><td>String</td><td>Region name.</td></tr><tr><td>latitude</td><td>Float</td><td>Latitude of the data center.</td></tr><tr><td>longitude</td><td>Float</td><td>Longitude of the data center.</td></tr><tr><td>isPortAvailable</td><td>Boolean</td><td>Whether port creation is supported or not.<br>Only takes a value in <a href="/pages/6NryHUpaL9ykwvihast7">DescribeDatacenters</a></td></tr><tr><td>availableBandwidth</td><td>Integer</td><td><p>Bandwidth cap. Unit: Mbps.</p><p>This parameter is only available in <a href="/pages/YXM2p8QMVn88uz86CquW">DescribeVirtualEdgeDatacenters</a>.</p></td></tr><tr><td>regionId</td><td>String</td><td><p>Region ID.</p><p>This parameter is only available in <a href="/pages/qtuoMUrFC1L9nBANnjZw">DescribeBorderGatewayDatacenters</a> and <a href="/pages/ROXhy6SFSEXAvrzBd9vy">DescribeVPCDatacenters</a>.</p></td></tr></tbody></table>

## PrivateConnect

Information on a Layer 2 private connect, including ID, connectivity, access point A and access point Z.

<table><thead><tr><th width="239.9143426294821">Parameter Name</th><th width="153.33333333333331">Type</th><th>Description</th></tr></thead><tbody><tr><td>privateConnectId</td><td>String</td><td>Private connect ID.</td></tr><tr><td>privateConnectName</td><td>String</td><td>Private connect name.</td></tr><tr><td>connectivityStatus</td><td>String</td><td>Network connectivity state.<br>See <a href="#connectionstatus"><code>ConnectionStatus</code></a> for more details.</td></tr><tr><td>endpointA</td><td><a href="#privateconnectendpoint">PrivateConnectEndpoint</a></td><td>Basic information of access point A.</td></tr><tr><td>endpointZ</td><td><a href="#privateconnectendpoint">PrivateConnectEndpoint</a></td><td>Basic information of access point Z.</td></tr><tr><td>privateConnectStatus</td><td>String</td><td>Private connect state.<br>See <a href="#privateconnectstatus"><code>PrivateConnectStatus</code></a> for more details.</td></tr><tr><td>bandwidthMbps</td><td>Long</td><td>Maximum bandwidth cap limit of a private connect.</td></tr><tr><td>resourceGroupId</td><td>String</td><td>Resource group ID.</td></tr><tr><td>resourceGroupName</td><td>String</td><td>Resource group name.</td></tr><tr><td>createTime</td><td><a href="/pages/M4DhDpj2ZXShvmgIF72n">Timestamp</a></td><td>Creation time.</td></tr><tr><td>expiredTime</td><td><a href="/pages/M4DhDpj2ZXShvmgIF72n">Timestamp</a></td><td>Expiration time. This parameter is only valid for subscription resources.</td></tr><tr><td>recycledTime</td><td><a href="/pages/M4DhDpj2ZXShvmgIF72n">Timestamp</a></td><td>Recycled time.</td></tr><tr><td>tags</td><td><a href="#tags">Tags</a></td><td>Tags bound to the resources.</td></tr></tbody></table>

## PrivateConnectEndpoint

Basic information on access points in a private connect.

<table><thead><tr><th width="206.5168884339816">Parameter Name</th><th width="178.33333333333331">Type</th><th>Description</th></tr></thead><tbody><tr><td>endpointId</td><td>String</td><td>Access point ID.</td></tr><tr><td>endpointName</td><td>String</td><td>Access point name.</td></tr><tr><td>endpointType</td><td>String</td><td>Access point type.</td></tr><tr><td>dataCenter</td><td><a href="#datacenterinfo">DataCenterInfo</a></td><td>Information on data center to which the access point belongs.</td></tr><tr><td>vlanId</td><td>Integer</td><td>Access point VLAN ID.<br>Value range: from 1 to 4096.</td></tr><tr><td>connectivityStatus</td><td><a href="#portconnectionstatus">ConnectionStatus</a></td><td>Connectivity state of an access point.</td></tr></tbody></table>

## PrivateConnectStatus

State of a private connect.

<table><thead><tr><th width="320.1351869606903">State</th><th>Description</th></tr></thead><tbody><tr><td>CREATING</td><td>Creating.</td></tr><tr><td>UPDATING</td><td>Updating.</td></tr><tr><td>DELETING</td><td>Deleting.</td></tr><tr><td>DESTROYING</td><td>Releasing.</td></tr><tr><td>RECOVERING</td><td>Restoring.</td></tr><tr><td>RUNNING</td><td>Running.</td></tr><tr><td>RECYCLED</td><td>Recycled.</td></tr><tr><td>DESTROYED</td><td>Released.</td></tr><tr><td>CREATING_FAILED</td><td>Creating failed.</td></tr><tr><td>UPDATING_FAILED</td><td>Updating failed.</td></tr><tr><td>DELETING_FAILED</td><td>Deleting failed.</td></tr><tr><td>DESTROYING_FAILED</td><td>Releasing failed.</td></tr><tr><td>RECOVERING_FAILED</td><td>Restoring failed.</td></tr></tbody></table>

## CloudRouterStatus

State of a cloud router.

<table><thead><tr><th width="320.1351869606903">State</th><th>Description</th></tr></thead><tbody><tr><td>CREATING</td><td>Creating.</td></tr><tr><td>UPDATING</td><td>Updating.</td></tr><tr><td>DELETING</td><td>Deleting.</td></tr><tr><td>DESTROYING</td><td>Releasing.</td></tr><tr><td>RECOVERING</td><td>Restoring.</td></tr><tr><td>RUNNING</td><td>Running.</td></tr><tr><td>RECYCLED</td><td>Recycled.</td></tr><tr><td>DESTROYED</td><td>Released.</td></tr><tr><td>CREATING_FAILED</td><td>Creating failed.</td></tr><tr><td>UPDATING_FAILED</td><td>Updating failed.</td></tr><tr><td>DELETING_FAILED</td><td>Deleting failed.</td></tr><tr><td>DESTROYING_FAILED</td><td>Releasing failed.</td></tr><tr><td>RECOVERING_FAILED</td><td>Restoring failed.</td></tr></tbody></table>

## CreateEndpointParam

Create access point information, including types of ports, AWS, Google, Tencent, and etc. with different detailed information.

### PortEndpointParam

Information on a data center port as an endpoint.

<table><thead><tr><th width="192.14389359129387">Parameter Name</th><th width="94.33333333333331">Type</th><th width="115">Required</th><th>Description</th></tr></thead><tbody><tr><td>portId</td><td>String</td><td>Yes</td><td>Data center port ID.</td></tr><tr><td>vlanId</td><td>Integer</td><td>Yes</td><td>VLAN ID.<br>Call <a href="/pages/ThbDCwOVvhO5hgwpjevb"><code>DescribePortUsableVlan</code></a> to query available VLAN ID for a specified port.</td></tr></tbody></table>

### CloudEndpointParam

Information on a public cloud (Tencent/AWS/Google/AliCloud/Azure…) as an endpoint.

<table><thead><tr><th width="191">Parameter Name</th><th width="127.42708333333331">Type</th><th width="114.15625">Required</th><th>Description</th></tr></thead><tbody><tr><td>cloudAccountId</td><td>String</td><td>Yes</td><td>Cloud account ID.<br>For Google Cloud, pass the value of Pairing Key. See <a href="https://docs.console.zenlayer.com/welcome/cloud-networking/get-started/validate-connection-in-public-cloud/google-cloud-configuration"><strong>Google Cloud Configuration</strong></a> for more details.</td></tr><tr><td>cloudType</td><td>String</td><td>Yes</td><td><p>Public cloud type. Available value:</p><ul><li><code>AWS</code></li><li><code>TENCENT</code></li><li><code>GOOGLE</code></li><li><code>ALI_CLOUD</code></li><li><code>AZURE</code></li><li><code>HUAWEI_CLOUD</code></li><li><code>BYTE_PLUS</code></li><li><code>ORACLE</code></li></ul></td></tr><tr><td>cloudRegionId</td><td>String</td><td>No</td><td>Available location ID for public cloud.<br>The value is not required for Google Cloud.</td></tr><tr><td>dcId</td><td>String</td><td>Yes</td><td>Data center ID to connect to public cloud.</td></tr><tr><td>vlanId</td><td>Integer</td><td>Yes.</td><td>VLAN ID.<br>The value is empty when <code>cloudType</code> is <code>ALI_CLOUD</code>.</td></tr><tr><td>haType</td><td><a href="#hatypeenum">HATypeEnum</a></td><td>No</td><td><p>High availability type.</p><p>If the value of <code>cloudType</code> is <code>AZURE</code>, this parameter is required.</p></td></tr><tr><td>cloudBandwidthMbps</td><td>Integer</td><td>No</td><td>Cloud Connect access bandwidth.<br>If the value is empty, Cloud Connect access bandwidth will be automatically adjusted to the nearest cap higher than the backbone bandwidth.<br>If you need to configure Cloud Connect access bandwidth separately, you can call <a href="/pages/SxFiXuZIQLRuErD6xWMC"><code>DescribeCloudAvailableBandwidthTiers</code></a> to query available cloud connect access bandwidth specifications.</td></tr></tbody></table>

## TrafficData

Information on bandwidth.

<table><thead><tr><th width="181.61355406104508">Parameter Name</th><th width="140.33333333333331">Type</th><th>Description</th></tr></thead><tbody><tr><td>internetRX</td><td>Integer</td><td>Inbound bandwidth. Unit: bps.</td></tr><tr><td>internetTX</td><td>Integer</td><td>Outbound bandwidth. Unit: bps.</td></tr><tr><td>time</td><td><a href="/pages/M4DhDpj2ZXShvmgIF72n">Timestamp</a></td><td><p>Data time.</p><p>Time format: <code>YYYY-MM-DDThh:mm:ssZ.</code></p></td></tr></tbody></table>

## EndpointType

Access point types in a private connect

<table><thead><tr><th width="269">Type</th><th>Description</th></tr></thead><tbody><tr><td>SUBNET</td><td>Subnet.</td></tr><tr><td>GOOGLE</td><td>Google Cloud.</td></tr><tr><td>TENCENT</td><td>Tencent Cloud.</td></tr><tr><td>AZURE</td><td>Microsoft Azure.</td></tr><tr><td>ALI_CLOUD</td><td>Alibaba Cloud.</td></tr><tr><td>HUAWEI_CLOUD</td><td>Huawei Cloud.</td></tr><tr><td>AWS</td><td>Amazon Web Services.</td></tr><tr><td>ORACLE</td><td>Oracle Cloud.</td></tr><tr><td>BYTE_PLUS</td><td>BytePlus.</td></tr><tr><td>PORT</td><td>Dedicated port.</td></tr><tr><td>RIpt</td><td>IP Transit.</td></tr><tr><td>OTHER_PORT</td><td>Shared port.</td></tr></tbody></table>

## Price

Describe price information of subscription and pay-as-you-go resources.

<table><thead><tr><th width="196.95217624932832">Parameter Name</th><th width="117.33333333333331">Type</th><th>Description</th></tr></thead><tbody><tr><td>originalPrice</td><td>Float</td><td><p>Original price of subscription resources.</p><p>Only used in subscription model. For pay-as-you-go model, the value is empty.</p></td></tr><tr><td>discountPrice</td><td>Float</td><td><p>Discount price of subscription resources.</p><p>Only used in subscription model. For pay-as-you-go model, the value is empty.</p></td></tr><tr><td>discount</td><td>Float</td><td>Discount.<br>For example, <code>80.0</code> means 20% off.</td></tr><tr><td>unitPrice</td><td>Float</td><td><p>Original unit price of pay-as-you-go resources.</p><p>Only used in pay-as-you-go model. For tiered billing, the value is empty.</p></td></tr><tr><td>discountUnitPrice</td><td>Float</td><td><p>Discount unit price of pay-as-you-go resources.</p><p>Only used in pay-as-you-go model. For tiered billing, the value is empty.</p></td></tr><tr><td>chargeUnit</td><td>String</td><td><p>Unit of pay-as-you-go billing.<br>Only used in pay-as-you-go model.</p><p>Value range:<br><code>HOUR</code>: you will be billed by hour.<br><code>DAY</code>: you will be billed by day.<br><code>MONTH</code>: you will be billed by month. For example, the burstable 95th pricing model.</p></td></tr><tr><td>stepPrices</td><td>Array of <a href="#stepprice">StepPrice</a></td><td>Tiered price of pay-as-you-go billing.<br>Only used in pay-as-you-go model. If it is not tiered price, the value is empty.</td></tr></tbody></table>

## StepPrice

Tiered price of pay-as-you-go billing. Describe a tier of the price.

<table><thead><tr><th width="199.33944954128447">Parameter Name</th><th width="103.33333333333331">Type</th><th>Description</th></tr></thead><tbody><tr><td>stepStart</td><td>Float</td><td>First price range of a tiered price.</td></tr><tr><td>stepEnd</td><td>Float</td><td>Last price range of a tiered price.</td></tr><tr><td>unitPrice</td><td>Float</td><td>Original unit price of current price range.<br>Only used in pay-as-you-go model.</td></tr><tr><td>discountUnitPrice</td><td>Float</td><td>Discount unit price of current price range.<br>Only used in pay-as-you-go model.</td></tr></tbody></table>

## CreateCloudRouterEdgePoint

Information on creating access points in a cloud router, including types of ports, VPCs, AWS, Google, and Tencent with different detailed information.

### CreateVpcEdgePoint

Information on creating a VPC access point in a cloud router.

<table><thead><tr><th width="190">Parameter Name</th><th width="90">Type</th><th width="123.27022375215147">Required</th><th>Description</th></tr></thead><tbody><tr><td>vpcId</td><td>String</td><td>Yes</td><td>VPC ID related to bare metal.<br>You can call <a href="/pages/00X80UODRgCe2Cxbbwis"><code>DescribeCloudRouterAvailableVpcs</code></a> to obtain available VPCs.<br>A VPC can only be added into one cloud router.</td></tr><tr><td>bandwidthMbps</td><td>Integer</td><td>No</td><td><p>Access bandwidth of the access point.</p><p>Unit: Mbps.<br>The value is <code>10</code> by default.</p></td></tr></tbody></table>

### CreateZBGEdgePoint

Information on creating a border gateway access point in a cloud router.

<table><thead><tr><th width="170.0035400390625">Parameter Name</th><th width="90">Type</th><th width="109.32845129121397">Required</th><th>Description</th></tr></thead><tbody><tr><td>zbgId</td><td>String</td><td>Yes</td><td>Border gateway ID related to elastic compute.<br>You can call <a href="/pages/Mb7mter9LCCw0nHqMQH3"><code>DescribeBorderGateways</code></a> to obtain available border gateways.</td></tr><tr><td>bandwidthMbps</td><td>Integer</td><td>No</td><td><p>Access bandwidth of the access point.</p><p>Unit: Mbps.<br>The value is <code>10</code> by default.</p></td></tr></tbody></table>

### CreateDcPortEdgePoint

Information on creating a port access point in a cloud router.

<table><thead><tr><th width="194">Parameter Name</th><th width="101">Type</th><th width="118">Required</th><th>Description</th></tr></thead><tbody><tr><td>portId</td><td>String</td><td>Yes</td><td>Port ID.<br>You can call <a href="/pages/FbHfMb2F3RHwFBzPK0oU"><code>DescribeCloudRouterAvailablePorts</code></a> to obtain available ports.</td></tr><tr><td>vlanId</td><td>Integer</td><td>Yes</td><td>VLAN ID.<br>You can call <a href="/pages/ThbDCwOVvhO5hgwpjevb">DescribePortUsableVlan</a> to obtain available VLANs.<br>VLAN range: from 2 to 4000</td></tr><tr><td>ipAddress</td><td>String</td><td>Yes</td><td>IP address.</td></tr><tr><td>bandwidthMbps</td><td>Integer</td><td>No</td><td><p>Access bandwidth of the access point.</p><p>Unit: Mbps.<br>The value is 1 by default.</p></td></tr><tr><td>bgpConnection</td><td><a href="#bgpconnection">BGPConnection</a></td><td>No</td><td>BGP routing.<br>One of BGP and Static routing must be specified.</td></tr><tr><td>staticRoutes</td><td>Array of <a href="#iproute">IpRoute</a></td><td>No</td><td>Static routing.<br>One of BGP and Static routing must be specified.</td></tr></tbody></table>

### CreateCloudEdgePoint

Information on creating a public cloud access point (AWS/Tencent/Google/AliCloud/Azure) in a cloud router.

<table><thead><tr><th width="195">Parameter Name</th><th width="95.17791411042944">Type</th><th width="118">Required</th><th>Description</th></tr></thead><tbody><tr><td>cloudType</td><td>String</td><td>Yes</td><td><p>Public cloud type. Available value:</p><ul><li><code>AWS</code></li><li><code>TENCENT</code></li><li><code>GOOGLE</code></li><li><code>ALI_CLOUD</code></li><li><code>AZURE</code></li><li><code>HUAWEI_CLOUD</code></li><li><code>BYTE_PLUS</code></li><li><code>ORACLE</code></li></ul></td></tr><tr><td>cloudAccountId</td><td>String</td><td>Yes</td><td>Cloud account ID.<br>For Google Cloud, pass the value of Pairing Key. See <a href="https://docs.console.zenlayer.com/welcome/cloud-networking/get-started/validate-connection-in-public-cloud/google-cloud-configuration"><strong>Google Cloud Configuration</strong></a> for more details.<br>For Microsoft Azure, pass the value of Service Key. See <a href="https://docs.console.zenlayer.com/welcome/cloud-networking/get-started/validate-connection-in-public-cloud/microsoft-azure-cloud-configuration"><strong>Microsoft Azure Configuration</strong></a> for more details.</td></tr><tr><td>edgePointName</td><td>String</td><td>No</td><td>Access point name.<br>The length should be 1 to 255 characters.</td></tr><tr><td>cloudRegionId</td><td>String</td><td>No</td><td>Available location ID for public cloud.<br>The value is not required for Google Cloud.</td></tr><tr><td>dcId</td><td>String</td><td>Yes</td><td>Data center ID to connect to public cloud.</td></tr><tr><td>vlanId</td><td>Integer</td><td>Yes</td><td>VLAN ID.<br>You can call <a href="/pages/HjUGapdiifqt3wgUDEc1"><code>DescribeAWSVlanUsage</code></a>, <a href="https://github.com/zenlayer/zenlayercloud-api-doc-en/blob/main/cloud-networking/cloud/describe-aws-available-vlan-1.md"><code>DescribeTencentVlanUsage</code></a>, <a href="/pages/O6T4hNx9RnPDqZvWwM8b"><code>DescribeGoogleVlanUsage</code></a> to obtain available VLANs.<br>VLAN range: from 2 to 4000<br>The value is empty when <code>cloudType</code> is <code>ALI_CLOUD</code>.</td></tr><tr><td>ipAddress</td><td>String</td><td>Yes</td><td>IP address.</td></tr><tr><td>bandwidthMbps</td><td>Integer</td><td>No</td><td><p>Access bandwidth of the access point.</p><p>Unit: Mbps.<br>The value is 1 by default.</p></td></tr><tr><td>bgpConnection</td><td><a href="#bgpconnection">BGPConnection</a></td><td>No</td><td>BGP routing.<br>One of BGP and Static routing must be specified.</td></tr><tr><td>staticRoutes</td><td>Array of <a href="#iproute">IpRoute</a></td><td>No</td><td>Static routing.<br>One of BGP and Static routing must be specified.</td></tr><tr><td>haType</td><td><a href="#hatypeenum">HATypeEnum</a></td><td>No</td><td><p>High availability type.</p><p>If the value of <code>cloudType</code> is <code>AZURE</code>, this parameter is required.</p></td></tr><tr><td>cloudBandwidthMbps</td><td>Integer</td><td>No</td><td>Cloud Connect access bandwidth.<br>If the value is empty, Cloud Connect access bandwidth will be automatically adjusted to the nearest cap higher than the backbone bandwidth.<br>If you need to configure Cloud Connect access bandwidth separately, you can call <a href="/pages/SxFiXuZIQLRuErD6xWMC"><code>DescribeCloudAvailableBandwidthTiers</code></a> to query available cloud connect access bandwidth specifications.</td></tr></tbody></table>

### CreateIPSecEdgePoint

Information on creating a virtual edge access point in a cloud router.

<table><thead><tr><th width="189.45465087890625">Parameter Name</th><th width="115.17791411042944">Type</th><th width="99.92181396484375">Required</th><th>Description</th></tr></thead><tbody><tr><td>edgePointName</td><td>String</td><td>No</td><td>Access point name.<br>The length should be 1 to 255 characters.</td></tr><tr><td>dcId</td><td>String</td><td>Yes</td><td><p>Data center ID to connect to virtual edge.</p><p>You can call <a href="/pages/YXM2p8QMVn88uz86CquW">DescribeVirtualEdgeDatacenters</a> to view details.</p></td></tr><tr><td>bandwidthMbps</td><td>Integer</td><td>No</td><td><p>Access bandwidth of the access point.</p><p>Unit: Mbps.<br>The value is <code>10</code> by default.</p></td></tr><tr><td>ipSecTunnel</td><td>String</td><td>Yes</td><td><p>IPsec tunnel.</p><p>Available values:</p><ul><li><code>FQDN</code></li><li><code>RemoteIP</code></li></ul><p>You can view <a href="https://docs.console.zenlayer.com/welcome/cloud-networking/get-started/create-a-layer-3-connection/select-virtual-edge-as-access-point#ipsec-tunnel-configuration">IPsec Tunnel Configuration</a> docs for details.</p></td></tr><tr><td>psk</td><td>String</td><td>Yes</td><td>Pre-shared key.</td></tr><tr><td>customerPublicIP</td><td>String</td><td>No</td><td><p>Customer public IP address.</p><p>The value is required when <code>ipSecTunnel</code> is <code>RemoteIP</code>.</p></td></tr><tr><td>customerPrivateIP</td><td>String</td><td>Yes</td><td>Customer private IP address.</td></tr><tr><td>virtualEdgePrivateIP</td><td>String</td><td>Yes</td><td>Virtual edge private IP address.</td></tr><tr><td>enableHealthCheck</td><td>Boolean</td><td>No</td><td><p>Enable health check or not.</p><p>Default value: <code>false</code>.</p></td></tr><tr><td>ipSecBgpConnection</td><td><a href="#ipsecbgpconnection">IPSecBGPConnection</a></td><td>No</td><td>BGP routing configurations.<br>Pass either <code>ipSecBgpConnection</code> or <code>ipSecStaticRoutes</code>.</td></tr><tr><td>ipSecStaticRoutes</td><td>Array of <a href="#ipsecstaticroute">IPSecStaticRoute</a></td><td>No</td><td>Static routing configurations.<br>Pass either <code>ipSecBgpConnection</code> or <code>ipSecStaticRoutes</code>.</td></tr><tr><td>backupIpSec</td><td><a href="#backupipsecconfig">BackupIPSecConfig</a></td><td>No</td><td><p>Backup virtual edge configurations.</p><p>Pass this parameter to enable high availability. Static routing is not supported in high availability.</p></td></tr></tbody></table>

## IPSecBGPConnection

BGP routing configurations of virtual edge.

<table><thead><tr><th width="174">Parameter Name</th><th width="120">Type</th><th width="90">Required</th><th>Description</th></tr></thead><tbody><tr><td>customerAsn</td><td>Integer</td><td>Yes</td><td>Customer ASN.<br>The range is an integer between <code>1</code> and <code>4,294,967,294</code>.</td></tr><tr><td>virtualEdgeAsn</td><td>Integer</td><td>Yes</td><td>Virtual edge ASN.<br>The range is an integer between <code>1</code> and <code>4,294,967,294</code>.</td></tr><tr><td>password</td><td>String</td><td>No</td><td>The shared key for verifying BGP MD5 authentication.<br>Up to 64 characters.</td></tr></tbody></table>

## BackupIPSecConfig

Backup virtual edge configurations.

<table><thead><tr><th width="194.59814453125">Parameter Name</th><th width="107.04193115234375">Type</th><th width="90">Required</th><th>Description</th></tr></thead><tbody><tr><td>dcId</td><td>String</td><td>Yes</td><td>Data center ID to connect to backup virtual edge.</td></tr><tr><td>psk</td><td>String</td><td>Yes</td><td>Pre-shared key.</td></tr><tr><td>customerPrivateIP</td><td>String</td><td>Yes</td><td>Customer private IP address.</td></tr><tr><td>virtualEdgePrivateIP</td><td>String</td><td>Yes</td><td>Virtual edge private IP address.</td></tr><tr><td>password</td><td>String</td><td>No</td><td>The shared key for verifying BGP MD5 authentication.<br>Up to 64 characters.</td></tr></tbody></table>

## IPSecStaticRoute

Static routing configurations.

<table><thead><tr><th width="179.35308837890625">Parameter Name</th><th width="120">Type</th><th width="90">Required</th><th>Description</th></tr></thead><tbody><tr><td>cidr</td><td>String</td><td>Yes</td><td>Customer subnet.</td></tr></tbody></table>

## BGPConnection

BGP routing configurations.

<table><thead><tr><th width="189">Parameter Name</th><th width="103">Type</th><th width="111">Required</th><th>Description</th></tr></thead><tbody><tr><td>peerIpAddress</td><td>String</td><td>Yes</td><td>BGP peering IP address.</td></tr><tr><td>peerAsn</td><td>Integer</td><td>Yes</td><td>Peer BGP ASN.<br>An integer ranges from 1 to 4294967294.</td></tr><tr><td>localAsn</td><td>Integer</td><td>No</td><td>On-premise BGP ASN.<br>An integer ranges from 1 to 4294967294.<br>The value is <code>62610</code> and cannot be changed while configuring ports, Tencent Cloud, Google Cloud and AWS access points.</td></tr><tr><td>password</td><td>String</td><td>No</td><td><p>BGP authentication key.</p><p>At most 32 characters are allowed.</p></td></tr></tbody></table>

## IPRoute

Static routing configurations.

<table><thead><tr><th width="193">Parameter Name</th><th width="94">Type</th><th width="112">Required</th><th>Description</th></tr></thead><tbody><tr><td>prefix</td><td>String</td><td>Yes</td><td>IPv4 prefix used for routing to the next hop.</td></tr><tr><td>nextHop</td><td>String</td><td>No</td><td>Next hop IPv4 address.<br>The value is needed while configuring ports, Tencent Cloud, Google Cloud and AWS access points.</td></tr></tbody></table>

## CloudRouter

Information on Layer 3 cloud router.

<table><thead><tr><th width="238">Parameter Name</th><th width="208">Type</th><th>Description</th></tr></thead><tbody><tr><td>cloudRouterId</td><td>String</td><td>Cloud router ID.</td></tr><tr><td>cloudRouterName</td><td>Integer</td><td>Cloud router name.</td></tr><tr><td>cloudRouterDescription</td><td>String</td><td>Cloud router description.</td></tr><tr><td>edgePoints</td><td>Array of <a href="#cloudrouteredgepointparam">CloudRouterEdgePoint</a></td><td>Access points in a cloud router.</td></tr><tr><td>cloudRouterChargeType</td><td>String</td><td><p>Cloud router pricing model.</p><ul><li>PREPAID: monthly subscription.</li><li>POSTPAID: pay-as-you-go.</li></ul></td></tr><tr><td>createTime</td><td><a href="/pages/M4DhDpj2ZXShvmgIF72n">Timestamp</a></td><td>Creation time.</td></tr><tr><td>expiredTime</td><td><a href="/pages/M4DhDpj2ZXShvmgIF72n">Timestamp</a></td><td><p>Expiration time.</p><p>This parameter is only valid for subscription resources.</p></td></tr><tr><td>recycledTime</td><td><a href="/pages/M4DhDpj2ZXShvmgIF72n">Timestamp</a></td><td><p>Released time.</p><p>After a cloud router is deleted, it will be released at the released time.</p></td></tr><tr><td>period</td><td>Integer</td><td><p>Subscription term.</p><p>Unit: calendar month.</p><p>This parameter is only valid for subscription resources.</p></td></tr><tr><td>cloudRouterStatus</td><td><a href="#cloudrouterstatus">CloudRouterStatus</a></td><td>Cloud router state.</td></tr><tr><td>connectivityStatus</td><td>String</td><td>Cloud router connectivity.</td></tr><tr><td>resourceGroupId</td><td>String</td><td>Resource group ID.</td></tr><tr><td>resourceGroupName</td><td>String</td><td>Resource group name.</td></tr><tr><td>tags</td><td><a href="#tags">Tags</a></td><td>Tags bound to the resources.</td></tr></tbody></table>

## CloudRouterEdgePoint

Information on access points in a cloud router.

<table><thead><tr><th width="197">Parameter Name</th><th width="155.4152139461173">Type</th><th>Description</th></tr></thead><tbody><tr><td>edgePointId</td><td>String</td><td>Access point ID.</td></tr><tr><td>edgePointName</td><td>String</td><td>Access point name.</td></tr><tr><td>connectivityStatus</td><td>String</td><td>Access point state.</td></tr><tr><td>dataCenter</td><td><a href="#datacenterinfo">DataCenterInfo</a></td><td>Data center information of the access point.</td></tr><tr><td>ipAddress</td><td>String</td><td>IP address.</td></tr><tr><td>edgePointType</td><td>String</td><td><p>Access point type. Available value:</p><ul><li><code>VPC</code>: VPC</li><li><code>PORT</code>: physical port (dedicated)</li><li>OTHER_PORT: physical port (shared)</li><li><code>GOOGLE</code>: Google Cloud</li><li><code>TENCENT</code>: Tencent Cloud</li><li><code>AWS</code>: AWS</li><li><code>ALI_CLOUD</code>: Aliyun</li><li><code>AZURE</code>: Azure</li><li><code>VIRTUAL_EDGE</code>: IP Sec</li></ul></td></tr><tr><td>vpcId</td><td>String</td><td>VPC ID.<br>This parameter is only valid when access point type is <code>VPC</code>.</td></tr><tr><td>portId</td><td>String</td><td>Port ID<br>This parameter is only valid when access point type is <code>PORT</code>.</td></tr><tr><td>cloudRegionId</td><td>String</td><td><p>Available location ID for public cloud.</p><p>This parameter is only valid when access point type is <code>GOOGLE</code>, <code>TENCENT</code> ,<code>ALI_CLOUD</code>or <code>AWS</code>.</p></td></tr><tr><td>cloudAccountId</td><td>String</td><td>Cloud account ID.</td></tr><tr><td>vlanId</td><td>Integer</td><td>Access point VLAN ID.</td></tr><tr><td>bandwidthMbps</td><td>Integer</td><td><p>Access bandwidth of the access point.</p><p>Unit: Mbps.</p></td></tr><tr><td>bgpConnection</td><td><a href="#bgpconnection">BGPConnection</a></td><td>BGP routing information.</td></tr><tr><td>staticRoutes</td><td>Array of <a href="#iproute">IPRoute</a></td><td>Static routing information.</td></tr><tr><td>createTime</td><td><a href="/pages/M4DhDpj2ZXShvmgIF72n">Timestamp</a></td><td>Creation time.</td></tr><tr><td>zbgId</td><td>String</td><td>ZBG ID.<br>This parameter is only valid when access point type is <code>ZBG</code>.</td></tr></tbody></table>

## CloudRouterAvailableVpc

Information on VPCs in a Layer 3 cloud router.

<table><thead><tr><th width="198">Parameter Name</th><th width="164">Type</th><th>Description</th></tr></thead><tbody><tr><td>vpcId</td><td>String</td><td>VPC ID.</td></tr><tr><td>vpcName</td><td>String</td><td>VPC name.</td></tr><tr><td>dataCenter</td><td><a href="#datacenterinfo">DataCenterInfo</a></td><td>Data center of VPC.</td></tr><tr><td>cidrBlock</td><td>String</td><td>CIDR block of VPC.</td></tr></tbody></table>

## CloudRegion

Location information of public cloud access point.

<table><thead><tr><th width="199">Parameter Name</th><th width="159.33333333333331">Type</th><th>Description</th></tr></thead><tbody><tr><td>cloudRegionId</td><td>String</td><td>Available location ID for public cloud.</td></tr><tr><td>dataCenter</td><td><a href="#datacenterinfo">DataCenterInfo</a></td><td>Data center information of cloud access point.</td></tr><tr><td>products</td><td>Array of String</td><td><p>Supported products at the location<br>Available value:</p><ul><li><code>PrivateConnect</code>: Layer 2 Private Connect</li><li><code>CloudRouter</code>: Layer 3 Cloud Router</li></ul></td></tr><tr><td>haTypes</td><td>Array of <a href="#hatype">HaType</a></td><td><p>High availability type.</p><p>If the value of <code>cloudType</code> is <code>AZURE</code>, this parameter is required.</p></td></tr></tbody></table>

### HAType

Information of high availability types.

<table><thead><tr><th width="173.58453369140625">Parameter Name</th><th width="141.97536214192706">Type</th><th>Description</th></tr></thead><tbody><tr><td>haType</td><td><a href="#hatypeenum">HATypeEnum</a></td><td>High availability types.</td></tr><tr><td>isUsed</td><td>Boolean</td><td>Whether is used. If used, it cannot be reused.</td></tr></tbody></table>

### HATypeEnum <a href="#hatypeenum" id="hatypeenum"></a>

Value of high availability types.

<table><thead><tr><th width="288.1796875">Type</th><th>Description</th></tr></thead><tbody><tr><td>PRIMARY</td><td>Primary location.</td></tr><tr><td>SECONDARY</td><td>Backup location.</td></tr></tbody></table>

## InternetType

Network billing model.

<table><thead><tr><th width="293.3828125">Type</th><th>Description</th></tr></thead><tbody><tr><td>ByBandwidth</td><td>Flat rate billing.</td></tr><tr><td>ByInstanceBandwidth95</td><td>Burstable 95th billing.</td></tr></tbody></table>

## ServiceType

Available access point types.

<table><thead><tr><th width="288.1796875">Type</th><th>Description</th></tr></thead><tbody><tr><td>AWS</td><td>Amazon Web Services</td></tr><tr><td>TENCENT</td><td>Tencent Cloud</td></tr><tr><td>GOOGLE</td><td>Google Cloud</td></tr><tr><td>AZURE</td><td>Microsoft Azure</td></tr><tr><td>ALI_CLOUD</td><td>Alibaba Cloud</td></tr><tr><td>HUAWEI_CLOUD</td><td>Huawei Cloud</td></tr><tr><td>ORACLE</td><td>Oracle Cloud</td></tr><tr><td>DATACENTER_PORT</td><td>Data Center</td></tr></tbody></table>

## DatacenterWithServiceInfo

Information of data center supporting the specified services.

<table><thead><tr><th width="186.20703125">Parameter Name</th><th width="136.33333333333331">Type</th><th>Description</th></tr></thead><tbody><tr><td>dcId</td><td>String</td><td>Data center ID.</td></tr><tr><td>dcName</td><td>String</td><td>Data center name.</td></tr><tr><td>areaName</td><td>String</td><td>Area name of data center.</td></tr><tr><td>cityName</td><td>String</td><td>City name of data center.</td></tr><tr><td>cloudRegionId</td><td>String</td><td>Region ID of public cloud.</td></tr><tr><td>serviceTypes</td><td>Array of <a href="#servicetype">ServiceType</a></td><td>Supported services of data center.</td></tr><tr><td>latitude</td><td>Float</td><td>The latitude of the data center's location.</td></tr><tr><td>longitude</td><td>Float</td><td>The longitude of the data center's location.</td></tr></tbody></table>

## DatacenterPortPrice

Price information of a data center access point.

<table><thead><tr><th width="235.05047607421875">Parameter Name</th><th width="98.71626790364581">Type</th><th>Description</th></tr></thead><tbody><tr><td>price</td><td><a href="#price">Price</a></td><td>Price of a data center port.</td></tr><tr><td>crossConnectPrice</td><td><a href="#price">Price</a></td><td>Price of a cross connect.<br>If <a href="https://docs.console.zenlayer.com/welcome/cloud-networking/get-started/create-a-port/create-a-cross-connect">Assisted Build</a> not supported for the data center, the value is empty.</td></tr><tr><td>crossConnectOneTimeConstructionPrice</td><td><a href="#price">Price</a></td><td><p>One-time construction fee of a cross connect.</p><p>If <a href="https://docs.console.zenlayer.com/welcome/cloud-networking/get-started/create-a-port/create-a-cross-connect">Assisted Build</a> not supported for the data center, the value is empty.</p></td></tr><tr><td>stock</td><td>Integer</td><td>Stock of data center ports.</td></tr><tr><td>dcId</td><td>String</td><td>Data center ID.</td></tr></tbody></table>

## PrivateConnectEndpointInfo

Access point information of a Layer 2 private connect.

If the access point is a data center port:

<table><thead><tr><th width="166.647705078125">Parameter Name</th><th width="108.84094642122886">Required</th><th width="91.7137451171875">Type</th><th>Description</th></tr></thead><tbody><tr><td>dcId</td><td>Yes</td><td>String</td><td><p>Data center ID.</p><p>You can call <a href="/pages/6NryHUpaL9ykwvihast7"><code>DescribeDataCenters</code></a> to get the latest data center list.</p></td></tr><tr><td>portType</td><td>Yes</td><td>String</td><td><p>Port specifications.</p><p>You can call <a href="/pages/YB0D6AxMsTqFWV4sZdvt"><code>DescribeDataCenterPortPrice</code></a> to get the latest port specification list.</p></td></tr><tr><td>buildCrossConnectWithAssisted</td><td>No</td><td>Boolean</td><td><p>Whether need <a href="https://docs.console.zenlayer.com/welcome/cloud-networking/get-started/create-a-port/create-a-cross-connect">Assisted Build</a> to build your cross connect.</p><p>If the value is <code>true</code>, the data center port price contains the cross connect fee and the one-time construction fee.</p><p>The default value is <code>false</code>, that is you need to build cross connect by yourself.</p></td></tr></tbody></table>

If the access point is a public cloud:

<table><thead><tr><th width="156.125732421875">Parameter Name</th><th width="105.04468177279136">Required</th><th width="107.324462890625">Type</th><th>Description</th></tr></thead><tbody><tr><td>dcId</td><td>Yes</td><td>String</td><td>Data center ID of the cloud connect.</td></tr><tr><td>cloudType</td><td>Yes</td><td>String</td><td><p>Cloud connect type.<br>Available values:</p><ul><li><code>AWS</code></li><li><code>TENCENT</code></li><li><code>GOOGLE</code></li><li><code>ALI_CLOUD</code></li><li><code>AZURE</code></li><li><code>HUAWEI_CLOUD</code></li></ul></td></tr><tr><td>vlanId</td><td>No</td><td>Integer</td><td>VLAN ID.</td></tr><tr><td>cloudRegionId</td><td>No</td><td>String</td><td>Region ID of public cloud.<br>Google Cloud requires no parameter passing.</td></tr><tr><td>bandwidthMbps</td><td>No</td><td>Integer</td><td>Bandwidth cap.<br>Default value: <code>10</code>.<br>Unit: Mbps.</td></tr></tbody></table>

## PrivateConnectEndpointPrice

Access point price of a Layer 2 private connect.

<table><thead><tr><th width="195.0504150390625">Parameter Name</th><th width="97.06123860677081">Type</th><th>Description</th></tr></thead><tbody><tr><td>price</td><td><a href="#price">Price</a></td><td>Price of access point.</td></tr><tr><td>stock</td><td>Integer</td><td>Stock of access points.</td></tr><tr><td>crossConnectPrice</td><td><a href="#price">Price</a></td><td>Price of a cross connect.<br>If the access point is a data center port and <a href="https://docs.console.zenlayer.com/welcome/cloud-networking/get-started/create-a-port/create-a-cross-connect">Assisted Build</a> is not supported for this data center, the value is empty.</td></tr><tr><td>crossConnectOneTimeConstructionPrice</td><td><a href="#price">Price</a></td><td><p>One-time construction fee of a cross connect.</p><p>If the access point is a data center port and <a href="https://docs.console.zenlayer.com/welcome/cloud-networking/get-started/create-a-port/create-a-cross-connect">Assisted Build</a> is not supported for the data center, the value is empty.</p></td></tr></tbody></table>

## MarketingOptions

Information on marketing campaigns.

<table><thead><tr><th width="170.63360595703125">Parameter Name</th><th width="112.4013671875">Type</th><th>Description</th></tr></thead><tbody><tr><td>discountCode</td><td>String</td><td><p>Promo Code.</p><p>If no Promo Code exists, the final discount will not apply.</p></td></tr><tr><td>usePocVoucher</td><td>Boolean</td><td><p>Whether to use POC voucher.</p><p>If no POC voucher exists, the related creation will fail.</p></td></tr></tbody></table>

## Tag <a href="#tag" id="tag"></a>

Information on a tag, including its key and value.

<table><thead><tr><th width="162.9801025390625">Parameter Name</th><th width="90.99078369140625">Type</th><th width="112.3018798828125">Required</th><th>Description</th></tr></thead><tbody><tr><td>key</td><td>String</td><td>Yes</td><td>Tag key. Length limit: 1 to 64 characters.</td></tr><tr><td>value</td><td>String</td><td>No</td><td>Tag value. Length limit: 1 to 64 characters.</td></tr></tbody></table>

## TagAssociation <a href="#tagassociation" id="tagassociation"></a>

Information on tags bound to resources, including their keys and values.

<table><thead><tr><th width="163.77557373046875">Parameter Name</th><th width="117.10369873046875">Type</th><th width="111.38067626953125">Required</th><th>Description</th></tr></thead><tbody><tr><td>tags</td><td>Array of <a href="#tag">Tag​</a></td><td>Yes</td><td>List of tags.</td></tr></tbody></table>

## Tags <a href="#tags" id="tags"></a>

Information on tags, including their keys and values.

<table><thead><tr><th width="167.14276123046875">Parameter Name</th><th width="120.95526123046875">Type</th><th>Description</th></tr></thead><tbody><tr><td>tags</td><td>Array of <a href="#tag">Tag​</a>​</td><td>List of tags.</td></tr></tbody></table>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.console.zenlayer.com/api-reference/networking/sdn/datastructure.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.