# 数据结构

## PortInfo

描述端口基本信息，包括名称、商业实体名称、数据中心相关等。

| 名称                 | 类型                                                                                                    | 描述                                                        |
| ------------------ | ----------------------------------------------------------------------------------------------------- | --------------------------------------------------------- |
| portId             | String                                                                                                | 端口 的Id。                                                   |
| portName           | String                                                                                                | 端口 的名称。                                                   |
| portRemarks        | String                                                                                                | 端口 的备注。                                                   |
| portType           | String                                                                                                | <p>端口 规格。<br>取值范围：1G\10G\40G</p>                          |
| connectionStatus   | [ConnectionStatus](#connectionstatus)                                                                 | 端口 连通性的状态。                                                |
| portStatus         | [PortStatus](#portstatus)                                                                             | 端口 业务状态。                                                  |
| dcId               | String                                                                                                | 数据中心 的Id。                                                 |
| dcName             | String                                                                                                | 数据中心 的名称。                                                 |
| cityName           | String                                                                                                | 城市 的名称。                                                   |
| areaName           | String                                                                                                | 区域 的名称。                                                   |
| loaStatus          | [LOAStatus](#loastatus)                                                                               | LOA 的状态。                                                  |
| loaDownloadUrl     | String                                                                                                | LOA 的下载地址。                                                |
| createdTime        | [Timestamp](https://docs.console.zenlayer.com/api-reference/cn/api-introduction/instruction/datatype) | <p>创建时间。</p><p>格式为：<code>YYYY-MM-DDThh:mm:ssZ</code>。</p> |
| expiredTime        | [Timestamp](https://docs.console.zenlayer.com/api-reference/cn/api-introduction/instruction/datatype) | <p>到期时间。</p><p>格式为：<code>YYYY-MM-DDThh:mm:ssZ</code>。</p> |
| portChargeType     | String                                                                                                | <p>端口计费类型。</p><p>PREPAID：预付费，即包年包月。 POSTPAID：后付费。</p>     |
| period             | Integer                                                                                               | <p>购买端口的时长。</p><p>单位：月。</p><p>后付费实例该字段为null。</p>          |
| businessEntityName | String                                                                                                | 商业实体的名称。用于LOA                                             |
| tags               | [Tags](#tags)                                                                                         | 该端口关联的标签。                                                 |

## ConnectionStatus

网络连通性的状态。

| 状态值    | 状态说明 |
| ------ | ---- |
| ACTIVE | 连通   |
| DOWN   | 不连通  |

## PortStatus

端口的业务状态。

<table><thead><tr><th width="321.5">状态值</th><th>状态说明</th></tr></thead><tbody><tr><td>CREATING</td><td>创建中</td></tr><tr><td>UPDATING</td><td>更新中</td></tr><tr><td>DELETING</td><td>终止中</td></tr><tr><td>DESTROYING</td><td>销毁中</td></tr><tr><td>RECOVERING</td><td>恢复中</td></tr><tr><td>RUNNING</td><td>正常运行中</td></tr><tr><td>RECYCLED</td><td>已入回收站</td></tr><tr><td>DESTROYED</td><td>已销毁</td></tr><tr><td>CREATING_FAILED</td><td>创建失败</td></tr><tr><td>UPDATING_FAILED</td><td>更新失败</td></tr><tr><td>DELETING_FAILED</td><td>终止失败</td></tr><tr><td>DESTROYING_FAILED</td><td>销毁失败</td></tr><tr><td>RECOVERING_FAILED</td><td>恢复失败</td></tr></tbody></table>

## PortPrice

描述端口的规格及价格信息。

| 名称        | 类型              | 描述                                |
| --------- | --------------- | --------------------------------- |
| dcId      | String          | 数据中心 的Id，如SIN1。                   |
| portType  | String          | <p>端口 的规格。<br>取值范围：1G\10G\40G</p> |
| portPrice | [Price](#price) | 端口价格。                             |

## LOAStatus

LOA的业务状态。

| 状态值              | 状态说明 |
| ---------------- | ---- |
| LOA\_NOT\_UPLOAD | 未上传  |
| LOA\_UPLOADED    | 已上传  |

## PortTrafficInfo

描述端口流量信息。

| 名称      | 类型                                   | 描述              |
| ------- | ------------------------------------ | --------------- |
| unit    | String                               | 流量的单位。取值范围: bps |
| records | Array of [TrafficData](#trafficdata) | 带宽明细。           |
| inMax   | Double                               | in方向 最大值。       |
| inMin   | Double                               | in方向 最小值。       |
| inAvg   | Double                               | in方向 均值。        |
| outMax  | Double                               | out方向 最大值。      |
| outMin  | Double                               | out方向 最小值。      |
| outAvg  | Double                               | out方向 均值。       |

## DatacenterInfo

描述数据中心的信息 。

<table><thead><tr><th>名称</th><th width="148.33333333333331">类型</th><th>描述</th></tr></thead><tbody><tr><td>dcId</td><td>String</td><td>数据中心ID。</td></tr><tr><td>dcName</td><td>String</td><td>数据中心名称。</td></tr><tr><td>dcAddress</td><td>String</td><td>数据中心地址。</td></tr><tr><td>cityName</td><td>String</td><td>城市名称。</td></tr><tr><td>countryName</td><td>String</td><td>国家名称。</td></tr><tr><td>areaName</td><td>String</td><td>地区名称。</td></tr><tr><td>latitude</td><td>Float</td><td>数据中心所在地理位置的维度。</td></tr><tr><td>longitude</td><td>Float</td><td>数据中心所在地理位置的经度。</td></tr><tr><td>isPortAvailable</td><td>Boolean</td><td>数据中心是否支持物理端口。<br>该字段仅在 <a href="common/describedatacenters">DescribeDatacenters</a> 可取值。</td></tr><tr><td>availableBandwidth</td><td>Integer</td><td><p>数据中心最大可用的带宽。</p><p>单位：Mbps。</p><p>该字段仅在 <a href="common/describevirtualedgedatacenters">DescribeVirtualEdgeDatacenters</a> 可取值。</p></td></tr><tr><td>regionId</td><td>String</td><td><p>节点ID。</p><p>该字段仅在 <a href="common/describebordergatewaydatacenters">DescribeBorderGatewayDatacenters</a> 和 <a href="common/describevpcdatacenters">DescribeVPCDatacenters</a> 中可取值。</p></td></tr></tbody></table>

## PrivateConnect

描述二层专线网络的信息。包括ID, 连通性， 两端（A/Z）的端点信息。

<table><thead><tr><th width="229">名称</th><th width="240.33333333333331">类型</th><th>描述</th></tr></thead><tbody><tr><td>privateConnectId</td><td>String</td><td>二层专线网络ID。</td></tr><tr><td>privateConnectName</td><td>String</td><td>二层专线网络名称</td></tr><tr><td>connectivityStatus</td><td>String</td><td>连通性状态。<br>可用值见：<a href="#connectionstatus">ConnectionStatus</a></td></tr><tr><td>endpointA</td><td><a href="#privateconnectendpoint">PrivateConnectEndpoint</a></td><td>连接点A的基本信息。</td></tr><tr><td>endpointZ</td><td><a href="#privateconnectendpoint">PrivateConnectEndpoint</a></td><td>连接点Z的基本信息。</td></tr><tr><td>privateConnectStatus</td><td>String</td><td>专线的业务状态。<br>可用值见：<a href="#privateconnectstatus">PrivateConnectStatus</a></td></tr><tr><td>bandwidthMbps</td><td>Long</td><td>二层专线网络的最大带宽限速。</td></tr><tr><td>resourceGroupId</td><td>String</td><td>所属的资源组ID。</td></tr><tr><td>resourceGroupName</td><td>String</td><td>所属的资源组名称。</td></tr><tr><td>createTime</td><td><a href="../../api-introduction/instruction/datatype">Timestamp</a></td><td>创建时间。</td></tr><tr><td>expiredTime</td><td><a href="../../api-introduction/instruction/datatype">Timestamp</a></td><td>过期时间。<br>预付费资源可用。</td></tr><tr><td>recycledTime</td><td><a href="../../api-introduction/instruction/datatype">Timestamp</a></td><td>回收时间。</td></tr><tr><td>tags</td><td><a href="#tags">Tags</a></td><td>该二层专线网络关联的标签。</td></tr></tbody></table>

## PrivateConnectEndpoint

二层网络中连接点的基本信息。

<table><thead><tr><th width="224.5168884339816">名称</th><th width="178.33333333333331">类型</th><th>描述</th></tr></thead><tbody><tr><td>endpointId</td><td>String</td><td>连接点的ID。</td></tr><tr><td>endpointName</td><td>String</td><td>连接点的名称。</td></tr><tr><td>cloudRegionId</td><td>String</td><td>公有云区域ID。<br>有且为Google, Tencent, AWS 类型的接入点可取到值。</td></tr><tr><td>cloudAccountId</td><td>String</td><td>云接入的账号。<br>有且为Google, Tencent, AWS 类型的接入点可取到值。</td></tr><tr><td>endpointType</td><td>String</td><td>连接点的类型。</td></tr><tr><td>dataCenter</td><td><a href="#datacenterinfo">DataCenterInfo</a></td><td>连接点所属的数据中心信息。</td></tr><tr><td>vlanId</td><td>Integer</td><td>连接点的VLAN ID。<br>范围 1～4096。</td></tr><tr><td>connectivityStatus</td><td><a href="#portconnectionstatus">ConnectionStatus</a></td><td>连接点的连通性状态。</td></tr></tbody></table>

## PrivateConnectStatus

<table><thead><tr><th width="321.5">状态值</th><th>状态说明</th></tr></thead><tbody><tr><td>CREATING</td><td>创建中</td></tr><tr><td>UPDATING</td><td>更新中</td></tr><tr><td>DELETING</td><td>终止中</td></tr><tr><td>DESTROYING</td><td>销毁中</td></tr><tr><td>RECOVERING</td><td>恢复中</td></tr><tr><td>RUNNING</td><td>正常运行中</td></tr><tr><td>RECYCLED</td><td>已入回收站</td></tr><tr><td>DESTROYED</td><td>已销毁</td></tr><tr><td>CREATING_FAILED</td><td>创建失败</td></tr><tr><td>UPDATING_FAILED</td><td>更新失败</td></tr><tr><td>DELETING_FAILED</td><td>终止失败</td></tr><tr><td>DESTROYING_FAILED</td><td>销毁失败</td></tr><tr><td>RECOVERING_FAILED</td><td>恢复失败</td></tr></tbody></table>

## CloudRouterStatus

<table><thead><tr><th width="321.5">状态值</th><th>状态说明</th></tr></thead><tbody><tr><td>CREATING</td><td>创建中</td></tr><tr><td>UPDATING</td><td>更新中</td></tr><tr><td>DELETING</td><td>终止中</td></tr><tr><td>DESTROYING</td><td>销毁中</td></tr><tr><td>RECOVERING</td><td>恢复中</td></tr><tr><td>RUNNING</td><td>正常运行中</td></tr><tr><td>RECYCLED</td><td>已入回收站</td></tr><tr><td>DESTROYED</td><td>已销毁</td></tr><tr><td>CREATING_FAILED</td><td>创建失败</td></tr><tr><td>UPDATING_FAILED</td><td>更新失败</td></tr><tr><td>DELETING_FAILED</td><td>终止失败</td></tr><tr><td>DESTROYING_FAILED</td><td>销毁失败</td></tr><tr><td>RECOVERING_FAILED</td><td>恢复失败</td></tr></tbody></table>

## CreateEndpointParam

创建二层网络的连接点信息。连接点类型分为 AWS, Google, Tencent, Azure 等，不同的连接点所需要的信息不同。

**数据中心端口参数信息。**

<table><thead><tr><th width="163">名称</th><th width="112.33333333333331">类型</th><th width="76">必选</th><th>描述</th></tr></thead><tbody><tr><td>portId</td><td>String</td><td>是</td><td>数据中心端口的ID。</td></tr><tr><td>vlanId</td><td>Integer</td><td>是。</td><td>VLAN ID。<br>可以通过<a href="port/describeportusablevlan">DescribePortUsableVlan</a> 获取到当前端口可用的VLAN ID。</td></tr></tbody></table>

**腾讯云 / AWS / Google / AliCloud / Azure / Oracle / HuaweiCloud / BytePlus 作为接入点所需要参数信息。**

| 名称                 | 类型                        | 必选 | 描述                                                                                                                                                                                                            |
| ------------------ | ------------------------- | -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| cloudAccountId     | String                    | 是  | <p>云平台账号。<br>Google 云此处为Pairing Key，如何获取请参考<a href="https://docs.console.zenlayer.com/welcome/cloud-networking/get-started/validate-connection-in-public-cloud/google-cloud-configuration">Google云配置</a>。</p> |
| cloudType          | String                    | 是  | <p>云连接类型。可选值：</p><ul><li>AWS</li><li>TENCENT</li><li>GOOGLE</li><li>AZURE</li><li>ALI\_CLOUD</li><li>HUAWEI\_CLOUD</li><li>BYTE\_PLUS</li><li>ORACLE</li></ul>                                                |
| cloudRegionId      | String                    | 否  | <p>公有云区域ID。<br>Google云无需传参</p>                                                                                                                                                                                |
| dcId               | String                    | 是  | 连接云接入点的数据中心ID。                                                                                                                                                                                                |
| vlanId             | Integer                   | 是  | VLAN ID。                                                                                                                                                                                                      |
| haType             | [HATypeEnum](#hatypeenum) | 否  | <p>高可用类型。</p><p>如果CloudType是AZURE，则此字段为必传。</p>                                                                                                                                                                |
| cloudBandwidthMbps | Integer                   | 否  | <p>云连接带宽限速。</p><p>如果该字段为空，云连接的带宽将根据骨干带宽自动调整至最接近的阶梯。<br>如需自定义云连接带宽限速，该字段必须匹配带宽的阶梯，可以通过调用<a href="cloud/describecloudavailablebandwidthtiers">DescribeCloudAvailableBandwidthTiers</a>接口查询到可用的带宽阶梯。</p>         |

## TrafficData

带宽数据。

<table><thead><tr><th width="240">名称</th><th width="204.33333333333331">类型</th><th>描述</th></tr></thead><tbody><tr><td>internetRX</td><td>Integer</td><td>入口带宽。单位：bps。</td></tr><tr><td>internetTX</td><td>Integer</td><td>出口带宽。单位：bps。</td></tr><tr><td>time</td><td><a href="../../api-introduction/instruction/datatype">Timestamp</a></td><td><p>数据时间。</p><p>格式为：<code>YYYY-MM-DDThh:mm:ssZ</code>。</p></td></tr></tbody></table>

## EndpointType

端点类型。描述了连接二层网络专线A/Z两端的类型。

| 枚举值           | 枚举说明            |
| ------------- | --------------- |
| SUBNET        | 子网云连接点          |
| GOOGLE        | Google 云连接点     |
| TENCENT       | Tencent 云连接点    |
| AZURE         | Azure 云连接点      |
| ALI\_CLOUD    | Aliyun 连接点      |
| HUAWEI\_CLOUD | Huawei 云连接点     |
| AWS           | AWS 云连接点        |
| ORACLE        | ORACLE 云连接点     |
| BYTE\_PLUS    | BytePlus 云连接点   |
| PORT          | 数据中心端口连接点（客户独享） |
| Ript          | IP Transit      |
| OTHER\_PORT   | 数据中心端口连接点（客户共享） |

## Price

价格。描述了购买资源的预付费或后付费价格信息。

<table><thead><tr><th width="233">名称</th><th width="187.33333333333331">类型</th><th>描述</th></tr></thead><tbody><tr><td>originalPrice</td><td>Float</td><td><p>预付费的原价。</p><p>预付费模式使用，后付费该值为 null。</p></td></tr><tr><td>discountPrice</td><td>Float</td><td><p>预付费的折扣价。</p><p>预付费模式使用，后付费该值为 null。</p></td></tr><tr><td>discount</td><td>Float</td><td>折扣大小。<br>如80.0代表8折。</td></tr><tr><td>unitPrice</td><td>Float</td><td>后付费的单元原始价格。<br>后付费模式使用，如果价格为阶梯价格，该项为null。</td></tr><tr><td>discountUnitPrice</td><td>Float</td><td><p>后付费的单元折后价格。</p><p>后付费模式使用，如果价格为阶梯价格，该项为null。</p></td></tr><tr><td>chargeUnit</td><td>String</td><td>后付费计价单元。<br>后付费模式使用，可取值范围：<br>HOUR: 表示计价单元是按每小时来计算。<br>DAY: 表示计价单元是按天来计算。<br>MONTH: 表示计价单元是按月来计算，95计费则是这种。</td></tr><tr><td>excessUnitPrice</td><td>Float</td><td>超量原始价格。</td></tr><tr><td>excessDiscountUnitPrice</td><td>Float</td><td>超量折扣后价格。</td></tr><tr><td>excessAmountUnit</td><td>String</td><td>超量单位。</td></tr><tr><td>stepPrices</td><td>Array of <a href="#stepprice">StepPrice</a></td><td>后付费阶梯价格。<br>后付费模式使用，如果非阶梯价格，该项为null。</td></tr></tbody></table>

## StepPrice

后付费阶梯价格。描述了价格的一个阶梯的信息。

<table><thead><tr><th>名称</th><th width="181.33333333333331">类型</th><th>描述</th></tr></thead><tbody><tr><td>stepStart</td><td>Float</td><td>阶梯用量的开始。</td></tr><tr><td>stepEnd</td><td>Float</td><td>阶梯用量的结束。</td></tr><tr><td>unitPrice</td><td>Float</td><td>当前阶梯的单元原始价格。<br>后付费模式使用。</td></tr><tr><td>discountUnitPrice</td><td>Float</td><td>当前阶梯的单元折后价格。<br>后付费模式使用。</td></tr></tbody></table>

## CreateCloudRouterEdgePoint

创建三层网络的连接点信息。根据连接点的类型不同，连接点的参数也是不同的。

### CreateVpcEdgePoint

创建三层网络加入VPC 连接点所需要的信息。

<table><thead><tr><th width="185">名称</th><th width="108">类型</th><th width="94.27022375215147">必选</th><th>描述</th></tr></thead><tbody><tr><td>vpcId</td><td>String</td><td>是</td><td>裸金属产品内VPC ID。<br>可以通过<a href="router/describecloudrouteravailablevpcs">DescribeCloudRouterAvailableVpcs</a>接口来获取可以使用的VPC。<br>一个VPC 只能加入一个三层网络。</td></tr><tr><td>bandwidthMbps</td><td>Integer</td><td>否</td><td>接入的带宽大小。<br>单位： Mbps<br>默认值为10。</td></tr></tbody></table>

### CreateZBGEdgePoint

创建三层网络加入ZBG 连接点所需要的信息。

<table><thead><tr><th width="185">名称</th><th width="108">类型</th><th width="94.27022375215147">必选</th><th>描述</th></tr></thead><tbody><tr><td>zbgId</td><td>String</td><td>是</td><td>弹性算力产品内边界网关 ID。<br>可以通过<a href="../../compute/zec/vpc-network/border-gateway/describebordergateways">DescribeBorderGateways</a>接口来获取可以使用的ZBG。</td></tr><tr><td>bandwidthMbps</td><td>Integer</td><td>否</td><td>接入的带宽大小。<br>单位： Mbps<br>默认值为10。</td></tr></tbody></table>

### CreateDcPortEdgePoint

创建三层网络加入物理端口所需要的信息。

<table><thead><tr><th width="191">名称</th><th width="171">类型</th><th width="90">必选</th><th>描述</th></tr></thead><tbody><tr><td>portId</td><td>String</td><td>是</td><td>物理端口ID。<br>可以通过接口<a href="router/describecloudrouteravailableports-1">DescribeCloudRouterAvailablePorts</a>来获取支持三层网络的物理端口。</td></tr><tr><td>vlanId</td><td>Integer</td><td>是</td><td>VLAN ID。<br>查询端口可用的vlan范围， 可以根据<a href="port/describeportusablevlan">DescribePortUsableVlan</a>获取<br>范围：2-4000</td></tr><tr><td>ipAddress</td><td>String</td><td>是</td><td>IP地址信息。</td></tr><tr><td>bandwidthMbps</td><td>Integer</td><td>否</td><td>接入的带宽大小。<br>单位： Mbps<br>默认值：10 Mbps。</td></tr><tr><td>bgpConnection</td><td><a href="#bgpconnection">BGPConnection</a></td><td>否</td><td>BGP连接配置信息。<br>BGP和静态路由配置二者二选其一。</td></tr><tr><td>staticRoutes</td><td>Array of <a href="#iproute">IpRoute</a></td><td>否</td><td>静态路由配置信息。<br>BGP和静态路由配置二者二选其一。</td></tr></tbody></table>

### CreateCloudEdgePoint

创建三层网络加入云（AWS/Tencent/Google/AliCloud/Azure/HuaweiCloud/Oracle/BytePlus) 接入点所需要的信息。

| 名称                 | 类型                              | 必选 | 描述                                                                                                                                                                                                                                                                                                                                                                                                          |
| ------------------ | ------------------------------- | -- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| cloudType          | String                          | 是  | <p>云连接类型。可选值：</p><ul><li>AWS</li><li>TENCENT</li><li>GOOGLE</li><li>AZURE</li><li>ALI\_CLOUD</li><li>HUAWEI\_CLOUD</li><li>BYTE\_PLUS</li><li>ORACLE</li></ul>                                                                                                                                                                                                                                              |
| cloudAccountId     | String                          | 是  | <p>云平台账号。<br>Google 云此处为Pairing Key，如何获取请参考<a href="https://docs.console.zenlayer.com/welcome/cloud-networking/get-started/validate-connection-in-public-cloud/google-cloud-configuration">Google云配置</a>。<br>Azure 云此处为Service Key。如何获取请参考<a href="https://docs.console.zenlayer.com/welcome/cloud-networking/get-started/validate-connection-in-public-cloud/google-cloud-configuration">Azure云配置</a>。</p> |
| edgePointName      | String                          | 否  | <p>接入点的名称。<br>长度范围为1～255个字符。</p>                                                                                                                                                                                                                                                                                                                                                                            |
| cloudRegionId      | String                          | 否  | <p>公有云区域ID。<br>Google云无需传参</p>                                                                                                                                                                                                                                                                                                                                                                              |
| dcId               | String                          | 是  | 连接云接入点的数据中心ID。                                                                                                                                                                                                                                                                                                                                                                                              |
| vlanId             | Integer                         | 是  | <p>VLAN ID。<br>查询端口可用的vlan范围， 可以根据<a href="port/describeportusablevlan">DescribePortUsableVlan</a>获取<br>范围：2-4000</p>                                                                                                                                                                                                                                                                                       |
| ipAddress          | String                          | 是  | IP地址信息。                                                                                                                                                                                                                                                                                                                                                                                                     |
| bandwidthMbps      | Integer                         | 否  | <p>接入的带宽大小。<br>单位： Mbps<br>默认值：10 Mbps。</p>                                                                                                                                                                                                                                                                                                                                                                 |
| bgpConnection      | [BGPConnection](#bgpconnection) | 否  | <p>BGP连接配置信息。<br>BGP和静态路由配置二者二选其一。</p>                                                                                                                                                                                                                                                                                                                                                                      |
| staticRoutes       | Array of [IpRoute](#iproute)    | 否  | <p>静态路由配置信息。<br>BGP和静态路由配置二者二选其一。</p>                                                                                                                                                                                                                                                                                                                                                                       |
| haType             | [HATypeEnum](#hatypeenum)       | 否  | <p>高可用类型。</p><p>如果cloudType是AZURE，则此字段为必传。</p>                                                                                                                                                                                                                                                                                                                                                              |
| cloudBandwidthMbps | Integer                         | 否  | <p>云连接带宽限速。</p><p>如果该字段为空，云连接的带宽将根据骨干带宽自动调整至最接近的阶梯<br>如需自定义云连接带宽限速，该字段必须匹配带宽的阶梯，可以通过调用<a href="cloud/describecloudavailablebandwidthtiers">DescribeCloudAvailableBandwidthTiers</a>接口查询到可用的带宽阶梯。</p>                                                                                                                                                                                                        |

### CreateIPSecEdgePoint

创建三层网络加入边缘网关(IPSec)接入点所需要的信息。

<table><thead><tr><th width="218.80120849609375">名称</th><th width="115.17791411042944">类型</th><th width="125">必选</th><th>描述</th></tr></thead><tbody><tr><td>edgePointName</td><td>String</td><td>否</td><td>接入点的名称。<br>长度范围为1～255个字符。</td></tr><tr><td>dcId</td><td>String</td><td>是</td><td><p>边缘网关的数据中心ID。</p><p>可以通过 <a href="common/describevirtualedgedatacenters">DescribeVirtualEdgeDatacenters</a> 获取。</p></td></tr><tr><td>bandwidthMbps</td><td>Integer</td><td>否</td><td>接入的带宽大小。<br>单位： Mbps<br>默认值：10 Mbps。</td></tr><tr><td>ipSecTunnel</td><td>String</td><td>是</td><td><p>IPSec隧道。可选值：</p><ul><li>FQDN</li><li>RemoteIP</li></ul><p>参考文档：<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>。</p></td></tr><tr><td>psk</td><td>String</td><td>是</td><td>预共享密钥。</td></tr><tr><td>customerPublicIP</td><td>String</td><td>否</td><td><p>您的公网IP地址。</p><p>当 ipSecTunnel 为 RemoteIP 时必传。</p></td></tr><tr><td>customerPrivateIP</td><td>String</td><td>是</td><td>您的内网IP地址。</td></tr><tr><td>virtualEdgePrivateIP</td><td>String</td><td>是</td><td>边缘网关内网IP地址。</td></tr><tr><td>enableHealthCheck</td><td>Boolean</td><td>否</td><td><p>是否启用健康检查。</p><p>默认值为 false 不开启。</p></td></tr><tr><td>ipSecBgpConnection</td><td><a href="#ipsecbgpconnection">IPSecBGPConnection</a></td><td>否</td><td>BGP连接配置信息。<br>BGP和静态路由配置二者二选其一。</td></tr><tr><td>ipSecStaticRoutes</td><td>Array of <a href="#ipsecstaticroute">IPSecStaticRoute</a></td><td>否</td><td>静态路由配置信息。<br>BGP和静态路由配置二者二选其一。</td></tr><tr><td>backupIpSec</td><td><a href="#backupipsecconfig">BackupIPSecConfig</a></td><td>否</td><td><p>备用IPSec配置。</p><p>传递该参数用以开启IPSec的高可用。请注意：只有在BGP的情况下才能启用备用IPSec。</p></td></tr></tbody></table>

## IPSecBGPConnection

IPSec BGP 连接的配置信息。

<table><thead><tr><th width="174">名称</th><th width="120">类型</th><th width="90">必选</th><th>描述</th></tr></thead><tbody><tr><td>customerAsn</td><td>Integer</td><td>是</td><td>您的 ASN。<br>范围为 1 - 4294967294 之间的整数。</td></tr><tr><td>virtualEdgeAsn</td><td>Integer</td><td>是</td><td>边缘网关的 ASN。<br>范围为 1 - 4294967294 之间的整数。</td></tr><tr><td>password</td><td>String</td><td>否</td><td><p>用于验证 BGP MD5 认证的对等体的共享密钥。</p><p>最多 64 个字符。</p></td></tr></tbody></table>

## BackupIPSecConfig

备IPSec 的配置信息。

<table><thead><tr><th width="220.4539794921875">名称</th><th width="120">类型</th><th width="90">必选</th><th>描述</th></tr></thead><tbody><tr><td>dcId</td><td>String</td><td>是</td><td>备IPSec接入点的数据中心ID。</td></tr><tr><td>psk</td><td>String</td><td>是</td><td>预共享密钥。</td></tr><tr><td>customerPrivateIP</td><td>String</td><td>是</td><td>您的内网IP地址。</td></tr><tr><td>virtualEdgePrivateIP</td><td>String</td><td>是</td><td>边缘网关内网IP地址。</td></tr><tr><td>password</td><td>String</td><td>否</td><td><p>用于验证 BGP MD5 认证的对等体的共享密钥。</p><p>最多 64 个字符。</p></td></tr></tbody></table>

## IPSecStaticRoute

IPSec 静态路由配置信息。

<table><thead><tr><th width="220.4539794921875">名称</th><th width="120">类型</th><th width="90">必选</th><th>描述</th></tr></thead><tbody><tr><td>cidr</td><td>String</td><td>是</td><td>静态路由目的地址子网。</td></tr></tbody></table>

## BGPConnection

BGP 连接的配置信息。

<table><thead><tr><th width="174">名称</th><th width="120">类型</th><th width="90">必选</th><th>描述</th></tr></thead><tbody><tr><td>peerIpAddress</td><td>String</td><td>是</td><td>BGP 对等体的 IP 地址。</td></tr><tr><td>peerAsn</td><td>Integer</td><td>是</td><td>远程 BGP 对等体的 ASN。<br>范围为 1 - 4294967294 之间的整数。</td></tr><tr><td>localAsn</td><td>Integer</td><td>否</td><td>本地 BGP 的 ASN。<br>范围为 1 - 4294967294 之间的整数。<br>配置物理端口、Tencent、Google、AWS连接点的配置信息时不可填，且值为 62610。</td></tr><tr><td>password</td><td>String</td><td>否</td><td><p>用于验证 BGP MD5 认证的对等体的共享密钥。</p><p>最多 32 个字符。</p></td></tr></tbody></table>

## IPRoute

静态路由的相关信息。

<table><thead><tr><th width="174">名称</th><th width="120">类型</th><th width="90">必选</th><th>描述</th></tr></thead><tbody><tr><td>prefix</td><td>String</td><td>是</td><td>用于路由到下一跳的 IPv4 前缀。</td></tr><tr><td>nextHop</td><td>String</td><td>否</td><td>下一跳IPv4地址。<br>配置物理端口、Tencent、Google、AWS、Azure、Aliyun连接点时该地址必填。</td></tr></tbody></table>

## CloudRouter

三层网络的信息。

<table><thead><tr><th width="236">名称</th><th width="220">类型</th><th>描述</th></tr></thead><tbody><tr><td>cloudRouterId</td><td>String</td><td>三层网络的ID。</td></tr><tr><td>cloudRouterName</td><td>Integer</td><td>三层网络的名称。</td></tr><tr><td>cloudRouterDescription</td><td>String</td><td>三层网络的描述信息。</td></tr><tr><td>edgePoints</td><td>Array of <a href="#cloudrouteredgepoint">CloudRouterEdgePoint</a></td><td>三层网络中边缘连接点的信息。</td></tr><tr><td>cloudRouterChargeType</td><td>String</td><td><p>三层网络的计费类型。</p><ul><li>PREPAID：预付费，即包年包月。</li><li>POSTPAID：后付费。</li></ul></td></tr><tr><td>createTime</td><td><a href="../../api-introduction/instruction/datatype">Timestamp</a></td><td>创建时间。</td></tr><tr><td>expiredTime</td><td><a href="../../api-introduction/instruction/datatype">Timestamp</a></td><td>到期时间。<br>后付费实例该字段取值为null。</td></tr><tr><td>recycledTime</td><td><a href="../../api-introduction/instruction/datatype">Timestamp</a></td><td>销毁的时间。<br>当删除三层网络后，将会在该时间进行资源的销毁。</td></tr><tr><td>period</td><td>Integer</td><td><p>购买三层网络的时长。</p><p>单位：月。</p><p>后付费实例该字段为null。</p></td></tr><tr><td>cloudRouterStatus</td><td><a href="#cloudrouterstatus">CloudRouterStatus</a></td><td>三层网络的状态。</td></tr><tr><td>connectivityStatus</td><td>String</td><td>三层网络的连通性状态。</td></tr><tr><td>resourceGroupId</td><td>String</td><td>三层网络所在资源组ID。</td></tr><tr><td>resourceGroupName</td><td>String</td><td>三层网络所在资源组名称</td></tr><tr><td>tags</td><td><a href="#tags">Tags</a></td><td>该三层网络关联的标签。</td></tr></tbody></table>

## CloudRouterEdgePoint

三层网络中边缘连接点的信息。

<table><thead><tr><th width="234">名称</th><th width="138.4152139461173">类型</th><th>描述</th></tr></thead><tbody><tr><td>edgePointId</td><td>String</td><td>边缘连接点的ID。</td></tr><tr><td>edgePointName</td><td>String</td><td>边缘连接点的名称。</td></tr><tr><td>connectivityStatus</td><td>String</td><td>边缘连接点的状态。</td></tr><tr><td>dataCenter</td><td><a href="#datacenterinfo">DataCenterInfo</a></td><td>边缘连接点所在的数据中心信息。</td></tr><tr><td>ipAddress</td><td>String</td><td>IP地址。</td></tr><tr><td>edgePointType</td><td>String</td><td><p>边缘连接点的类型。</p><ul><li>VPC: VPC</li><li>PORT: 物理端口(客户独享)</li><li>OTHER_PORT: 物理端口(客户共享)</li><li>GOOGLE: Google 云</li><li>TENCENT: 腾讯云</li><li>ALI_CLOUD：阿里云</li><li>AWS: AWS云</li><li>AZURE: AZURE云</li><li>VIRTUAL_EDGE: IP Sec</li><li>ZBG: ZBG</li></ul></td></tr><tr><td>vpcId</td><td>String</td><td>VPC边缘连接点的ID.<br>该字段仅当类型为<code>VPC</code>时不为null。</td></tr><tr><td>portId</td><td>String</td><td>物理端口的ID.<br>该字段仅当类型为<code>PORT</code>时不为null。</td></tr><tr><td>cloudRegionId</td><td>String</td><td>有且为Google, Tencent, AWS, Alibaba Cloud, Azure 类型的接入点可取到值。</td></tr><tr><td>cloudAccountId</td><td>String</td><td>云接入的账号。</td></tr><tr><td>vlanId</td><td>Integer</td><td>边缘连接点配置的VLAN ID。</td></tr><tr><td>bandwidthMbps</td><td>Integer</td><td>带宽大小。</td></tr><tr><td>bgpConnection</td><td><a href="#bgpconnection">BGPConnection</a></td><td>BGP连接配置信息。</td></tr><tr><td>staticRoutes</td><td>Array of <a href="#iproute">IPRoute</a></td><td>静态路由配置信息</td></tr><tr><td>createTime</td><td><a href="../../api-introduction/instruction/datatype">Timestamp</a></td><td>创建时间。</td></tr><tr><td>zbgId</td><td>String</td><td>边界网关的ID.<br>该字段仅当类型为<code>ZBG</code>时不为null。</td></tr></tbody></table>

## CloudRouterAvailableVpc

可用于加入三层网络的裸金属VPC信息

| 名称         | 类型                                | 描述          |
| ---------- | --------------------------------- | ----------- |
| vpcId      | String                            | VPC ID。     |
| vpcName    | String                            | VPC 名称      |
| dataCenter | [DataCenterInfo](#datacenterinfo) | vpc所在的数据中心。 |
| cidrBlock  | String                            | VPC 的 CIDR。 |

## CloudRegion

描述公有云连接的区域信息。

<table><thead><tr><th width="239">名称</th><th width="190.33333333333331">类型</th><th>描述</th></tr></thead><tbody><tr><td>cloudRegionId</td><td>String</td><td>公有云区域ID。</td></tr><tr><td>dataCenter</td><td><a href="#datacenterinfo">DataCenterInfo</a></td><td>云接入点所在的数据中心信息。</td></tr><tr><td>products</td><td>Array of String</td><td><p>当前云节点点支持的产品。<br>可用值：</p><ul><li>PrivateConnect: 二层网络</li><li>CloudRouter: 三层网络</li></ul></td></tr><tr><td>haTypes</td><td>Array of <a href="#hatype">HaType</a></td><td></td></tr></tbody></table>

### HAType

描述高可用类型的信息

| 名称     | 类型                        | 描述               |
| ------ | ------------------------- | ---------------- |
| haType | [HATypeEnum](#hatypeenum) | 高可用类型            |
| isUsed | Boolean                   | 是否被使用（如被使用则不可再用） |

### HATypeEnum

高可用类型枚举

| 值         | 说明 |
| --------- | -- |
| PRIMARY   | 主  |
| SECONDARY | 备  |

## InternetType

网络计费类型

| 值                     | 说明     |
| --------------------- | ------ |
| ByBandwidth           | 固定带宽计费 |
| ByInstanceBandwidth95 | 95带宽计费 |

## ServiceType

服务类型

| 值                | 说明     |
| ---------------- | ------ |
| AWS              | 亚马逊云   |
| TENCENT          | 腾讯云    |
| GOOGLE           | 谷歌云    |
| AZURE            | 微软云    |
| ALI\_CLOUD       | 阿里云    |
| HUAWEI\_CLOUD    | 华为云    |
| ORACLE           | 甲骨文云   |
| DATACENTER\_PORT | 数据中心端口 |

## DatacenterWithServiceInfo

描述带服务的数据中心信息

<table><thead><tr><th>名称</th><th width="136.33333333333331">类型</th><th>描述</th></tr></thead><tbody><tr><td>dcId</td><td>String</td><td>数据中心四字码</td></tr><tr><td>dcName</td><td>String</td><td>数据中心名称。</td></tr><tr><td>areaName</td><td>String</td><td>数据中心地区名称。</td></tr><tr><td>cityName</td><td>String</td><td>城市名称。</td></tr><tr><td>cloudRegionId</td><td>String</td><td>公有云区域ID。</td></tr><tr><td>serviceTypes</td><td>Array of <a href="#servicetype">ServiceType</a></td><td>数据中心支持的服务类型列表。</td></tr><tr><td>latitude</td><td>Float</td><td>数据中心所在地理位置的维度。</td></tr><tr><td>longitude</td><td>Float</td><td>数据中心所在地理位置的经度。</td></tr></tbody></table>

## DatacenterPortPrice

描述数据中心端口的价格信息。

<table><thead><tr><th width="257">名称</th><th width="221.33333333333331">类型</th><th>描述</th></tr></thead><tbody><tr><td>price</td><td><a href="#price">Price</a></td><td>数据中心端口价格。</td></tr><tr><td>crossConnectPrice</td><td><a href="#price">Price</a></td><td>CrossConnect价格。如果当前数据中心不支持Zenlayer协助建设CrossConnect，则该值为null。</td></tr><tr><td>crossConnectOneTimeConstructionPrice</td><td><a href="#price">Price</a></td><td>CrossConnect一次性建设费。如果当前数据中心不支持Zenlayer协助建设CrossConnect，则该值为null。</td></tr><tr><td>stock</td><td>Integer</td><td>数据中心端口的可用库存数量。</td></tr><tr><td>dcId</td><td>String</td><td>数据中心ID。</td></tr></tbody></table>

## PrivateConnectEndpointInfo

二层网络专线的连接点信息。根据连接点的类型不同，连接点的参数也是不同的。

如果类型为数据中心端口，则所需的参数为：

<table><thead><tr><th width="185">名称</th><th width="78.85864661654136">必选</th><th width="196">类型</th><th>描述</th></tr></thead><tbody><tr><td>dcId</td><td>是</td><td>String</td><td><p>数据中心ID。</p><p>具体取值可通过调用接口<a href="https://docs.console.zenlayer.com/api-reference/cn/cloud-networking/common/describedatacenters"><code>DescribeDataCenters</code></a>来获得最新的数据中心列表。</p></td></tr><tr><td>portType</td><td>是</td><td>String</td><td><p>端口规格。</p><p>具体取值可通过调用接口<a href="https://docs.console.zenlayer.com/api-reference/cn/cloud-networking/port/describedatacenterportprice"><code>DescribeDataCenterPortType</code></a>来获得最新的端口规格表。</p></td></tr><tr><td>buildCrossConnectWithAssisted</td><td>否</td><td>Boolean</td><td><p>是否需要<a href="https://docs.console.zenlayer.com/welcome/cloud-networking/get-started/create-a-port/create-a-cross-connect">Zenlayer协助建设CrossConnect</a>。</p><p>如果选择true，则价格将包含Cross Connect的跳线费用，以及一次性建设费。默认值为false，即用户需要自行建设CrossConnect。</p></td></tr></tbody></table>

如果类型为公有云，则所需的参数为：

<table><thead><tr><th width="185">名称</th><th width="78.85864661654136">必选</th><th width="196">类型</th><th>描述</th></tr></thead><tbody><tr><td>dcId</td><td>是</td><td>String</td><td>云连接的数据中心ID。</td></tr><tr><td>cloudType</td><td>是</td><td>String</td><td><p>云连接类型。可选值：</p><ul><li>AWS</li><li>TENCENT</li><li>GOOGLE</li><li>ALI_CLOUD</li><li>AZURE</li><li>HUAWEI_CLOUD</li></ul></td></tr><tr><td>vlanId</td><td>否</td><td>Integer</td><td>VLAN ID。</td></tr><tr><td>cloudRegionId</td><td>否</td><td>String</td><td><p>公有云区域ID。</p><p>Google云无需传参。</p></td></tr><tr><td>bandwidthMbps</td><td>否</td><td>Integer</td><td>云连接的最大带宽限制。<br>默认值是10，单位：Mbps。</td></tr></tbody></table>

## PrivateConnectEndpointPrice

描述二层网络专线连接点的价格信息。

<table><thead><tr><th width="257">名称</th><th width="221.33333333333331">类型</th><th>描述</th></tr></thead><tbody><tr><td>price</td><td><a href="#price">Price</a></td><td>连接点价格。</td></tr><tr><td>stock</td><td>Integer</td><td>可用库存数量。</td></tr><tr><td>crossConnectPrice</td><td><a href="#price">Price</a></td><td>CrossConnect价格。连接点类型为数据中心端口并且该数据中心支持Zenlayer协助建设CrossConnect时有值。</td></tr><tr><td>crossConnectOneTimeConstructionPrice</td><td><a href="#price">Price</a></td><td>CrossConnect一次性建设费。连接点类型为数据中心端口并且该数据中心支持Zenlayer协助建设CrossConnect时有值。</td></tr></tbody></table>

## MarketingOptions

市场营销活动相关信息

| 名称            | 类型      | 描述                                   |
| ------------- | ------- | ------------------------------------ |
| discountCode  | String  | 使用市场发放的折扣码。如果折扣码不存在，最终折扣将不会生效。       |
| usePocVoucher | Boolean | 是否使用POC代金券。 如果系统不存在POC代金券，相关创建流程会失败。 |

## Tag

描述一个标签键值对的信息。

| 参数名称  | 类型     | 必选 | 描述                               |
| ----- | ------ | -- | -------------------------------- |
| key   | String | 是  | <p>标签键。</p><p>长度限制：1～128个字符。</p> |
| value | String | 否  | <p>标签值。</p><p>长度限制：1～128个字符。</p> |

## TagAssociation

描述创建资源时同时绑定的标签对的信息。

| 参数名称 | 类型                   | 必选 | 描述     |
| ---- | -------------------- | -- | ------ |
| tags | Array of [Tag](#tag) | 是  | 标签对列表。 |

## Tags

描述资源关联的标签信息。

| 参数名称 | 类型                   | 描述     |
| ---- | -------------------- | ------ |
| tags | Array of [Tag](#tag) | 标签对列表。 |


---

# 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/cn/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.
