> 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/cn/sdn/datastructure.md).

# 数据结构

## BFDConfig

BFD配置。

被如下接口引用：ModifyInternetConfig, CreateInternet, DescribeInternets

| 参数名称          | 类型      | 必选 | 描述                                                                      |
| ------------- | ------- | -- | ----------------------------------------------------------------------- |
| bfdTxInterval | Integer | 否  | <p>发送间隔。</p><p>单位：ms。</p><p>取值范围：100～6000。</p><p>可选值范围：\[100, 6000]</p> |
| bfdRxInterval | Integer | 否  | <p>接收间隔。</p><p>单位：ms</p><p>取值范围：100～6000。</p><p>可选值范围：\[100, 6000]</p>  |
| bfdMultiplier | Integer | 否  | <p>本地检测倍数。</p><p>取值范围：3～20。</p><p>可选值范围：\[3, 20]</p>                    |

## BGPConnection

BGP 连接的配置信息。

被如下接口引用：CreateCloudRouter, DescribeCloudRouters, ModifyCloudRouterEdgePoint

| 参数名称          | 类型      | 必选 | 描述                                              |
| ------------- | ------- | -- | ----------------------------------------------- |
| peerIpAddress | String  | 是  | 对端互联 IP 地址及掩码。                                  |
| peerAsn       | Integer | 是  | <p>对端 BGP ASN。</p><p>可选值范围：\[1, 4294967294]</p> |
| password      | String  | 否  | <p>BGP 会话的 MD5 密码。</p><p>长度不超过 32 字符。</p>       |
| localAsn      | Integer | 否  | 本端 BGP ASN。                                     |

## BackupIPSecConfig

IPSec 备份隧道的配置信息。

被如下接口引用：CreateCloudRouter

| 参数名称                 | 类型     | 必选 | 描述                                          |
| -------------------- | ------ | -- | ------------------------------------------- |
| dcId                 | String | 否  | 备份 IPSec 隧道所在数据中心的 ID。                      |
| password             | String | 否  | <p>备份 IPSec 隧道的认证密码。</p><p>长度 8-64 个字符。</p> |
| customerPrivateIP    | String | 否  | 备份 IPSec 隧道客户侧私网 IP 地址。                     |
| virtualEdgePrivateIP | String | 否  | 备份 IPSec 隧道 Virtual Edge 侧私网 IP 地址。         |
| psk                  | String | 否  | 备份 IPSec 隧道的预共享密钥（PSK）。                     |

## BusinessSource

业务来源。

被如下接口引用：DescribeCloudRouters, DescribePrivateConnects

| 值       | 值说明            |
| ------- | -------------- |
| CONSOLE | Console 控制台创建。 |
| OSS     | 线下工单流程创建。      |

## BusinessStatus

业务状态。

被如下接口引用：DescribePorts, DescribeCloudRouters, DescribePrivateConnects

| 值                  | 值说明   |
| ------------------ | ----- |
| CREATING           | 创建中。  |
| UPDATING           | 变更中。  |
| DELETING           | 删除中。  |
| DESTROYING         | 销毁中。  |
| RECOVERING         | 恢复中。  |
| RUNNING            | 正常。   |
| NOT\_ACCEPT        | 未接收。  |
| RECYCLED           | 已回收。  |
| DESTROYED          | 已销毁。  |
| CREATING\_FAILED   | 创建失败。 |
| UPDATING\_FAILED   | 变更失败。 |
| DELETING\_FAILED   | 删除失败。 |
| DESTROYING\_FAILED | 销毁失败。 |
| RECOVERING\_FAILED | 恢复失败。 |

## CloudProduct

产品类型。

被如下接口引用：DescribeAliCloudRegions, DescribeAzureRegions, DescribeHuaweiCloudRegions, DescribeBytePlusRegions, DescribeTencentRegions, DescribeVolcengineRegions, DescribeAWSRegions, DescribeOracleRegions, DescribeGoogleRegions

| 值              | 值说明   |
| -------------- | ----- |
| PrivateConnect | 二层网络。 |
| CloudRouter    | 三层网络。 |

## CloudRegion

描述公有云接入区域及其支持的产品、高可用类型信息。

被如下接口引用：DescribeAliCloudRegions, DescribeAzureRegions, DescribeHuaweiCloudRegions, DescribeBytePlusRegions, DescribeTencentRegions, DescribeVolcengineRegions, DescribeAWSRegions, DescribeOracleRegions, DescribeGoogleRegions

| 参数名称          | 类型                                     | 描述                                                 |
| ------------- | -------------------------------------- | -------------------------------------------------- |
| cloudRegionId | String                                 | 公有云区域 ID。                                          |
| dataCenter    | [DatacenterInfo](#datacenterinfo)      | 接入点数据中心信息。                                         |
| products      | Array of [CloudProduct](#cloudproduct) | 该区域支持的产品列表：PrivateConnect(二层网络)、CloudRouter(三层网络)。 |
| haTypes       | Array of [HaTypeInfo](#hatypeinfo)     | 该区域支持的高可用类型列表。                                     |

## CloudRouter

三层网络的详细信息。

被如下接口引用：DescribeCloudRouters

| 参数名称                   | 类型                                                     | 描述             |
| ---------------------- | ------------------------------------------------------ | -------------- |
| cloudRouterId          | String                                                 | 三层网络的 ID。      |
| cloudRouterName        | String                                                 | 三层网络的名称。       |
| cloudRouterDescription | String                                                 | 三层网络的描述信息。     |
| createTime             | String                                                 | 三层网络的创建时间。     |
| expiredTime            | String                                                 | 三层网络的过期时间。     |
| recycledTime           | String                                                 | 三层网络的回收时间。     |
| edgePoints             | Array of [CloudRouterEdgePoint](#cloudrouteredgepoint) | 三层网络的边缘连接点列表。  |
| cloudRouterStatus      | [BusinessStatus](#businessstatus)                      | 三层网络的业务状态。     |
| connectivityStatus     | [ConnectivityStatus](#connectivitystatus)              | 三层网络的连通性状态。    |
| resourceGroupId        | String                                                 | 三层网络所属的资源组 ID。 |
| resourceGroupName      | String                                                 | 三层网络所属的资源组名称。  |
| period                 | Integer                                                | 三层网络的购买时长（月）。  |
| source                 | [BusinessSource](#businesssource)                      | 三层网络的业务来源。     |
| tags                   | [Tags](#tags)                                          | 三层网络关联的标签。     |

## CloudRouterAvailableVpc

可加入三层网络的 VPC 信息。

被如下接口引用：DescribeCloudRouterAvailableVpcs

| 参数名称       | 类型                                | 描述             |
| ---------- | --------------------------------- | -------------- |
| vpcId      | String                            | VPC 的 ID。      |
| vpcName    | String                            | VPC 的名称。       |
| dataCenter | [DatacenterInfo](#datacenterinfo) | VPC 所在的数据中心信息。 |
| cidrBlock  | String                            | VPC 的 CIDR 网段。 |

## CloudRouterEdgePoint

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

被如下接口引用：DescribeCloudRouters

| 参数名称               | 类型                                        | 描述                                                                  |
| ------------------ | ----------------------------------------- | ------------------------------------------------------------------- |
| bandwidthMbps      | Integer                                   | <p>连接点的骨干带宽限速。</p><p>单位 Mbps。</p><p>可选值范围：\[10, +)</p><p>默认值：10</p> |
| edgePointId        | String                                    | 连接点的 ID。                                                            |
| edgePointName      | String                                    | 连接点的名称。                                                             |
| connectivityStatus | [ConnectivityStatus](#connectivitystatus) | 连接点的连通性状态。                                                          |
| dataCenter         | [DatacenterInfo](#datacenterinfo)         | 连接点所在的数据中心信息。                                                       |
| edgePointType      | [EdgePointType](#edgepointtype)           | 连接点的类型。                                                             |
| cloudType          | [CloudType](#cloudtype)                   | 云连接点的云厂商类型。                                                         |
| cloudAccountId     | String                                    | 云连接点的云账号 ID。                                                        |
| cloudRegionId      | String                                    | 云连接点的云地域 ID。                                                        |
| vpcId              | String                                    | VPC 连接点的 VPC ID。                                                    |
| zbgId              | String                                    | ZBG 连接点的 ZBG ID。                                                    |
| zbgRegionId        | String                                    | ZBG 连接点所属的region。                                                   |
| portId             | String                                    | 数据中心端口连接点的端口 ID。                                                    |
| sharedChannelId    | String                                    | <p>共享通道ID。</p><p>公有云接入点对应的云侧连接标识，仅公有云类型接入点时有值。</p>                  |
| vlanId             | Integer                                   | <p>连接点的 VLAN ID。</p><p>取值范围 2-4000。</p><p>可选值范围：\[2, 4000]</p>      |
| bgpConnection      | [BGPConnection](#bgpconnection)           | 连接点的 BGP 连接配置。                                                      |
| staticRoutes       | Array of [IPRoute](#iproute)              | 连接点的静态路由配置。                                                         |
| createTime         | String                                    | 连接点的创建时间。                                                           |
| ipAddress          | String                                    | 连接点的互联 IP 地址。                                                       |

## CloudType

云厂商类型。

被如下接口引用：InquiryCreatePrivateConnectPrice, DescribeCloudAvailableBandwidthTiers, CreateCloudRouter, DescribeCloudRouters, QueryCloudOnrampPrice, QueryPrivateConnectPrice

| 值             | 值说明                |
| ------------- | ------------------ |
| AWS           | 亚马逊云。              |
| TENCENT       | 腾讯云。               |
| GOOGLE        | 谷歌云。               |
| AZURE         | 微软 Azure。          |
| ALI\_CLOUD    | 阿里云。               |
| HUAWEI\_CLOUD | 华为云。               |
| BYTE\_PLUS    | BytePlus（字节跳动海外云）。 |
| VOLCENGINE    | 火山引擎。              |
| ORACLE        | 甲骨文云（Oracle）。      |

## ConnectivityStatus

链路连通性状态。

被如下接口引用：DescribePorts, DescribeCloudRouters, DescribePrivateConnects, DescribeInternets

| 值        | 值说明     |
| -------- | ------- |
| ACTIVE   | 链路正常连通。 |
| DOWN     | 链路断开。   |
| ABNORMAL | 链路部分异常。 |

## CreateCloudRouterEdgePoint

创建三层网络边缘连接点的配置信息。

被如下接口引用：CreateCloudRouter, AddCloudRouterEdgePoints

| 参数名称                 | 类型                                             | 必选 | 描述                                                                  |
| -------------------- | ---------------------------------------------- | -- | ------------------------------------------------------------------- |
| bandwidthMbps        | Integer                                        | 是  | <p>连接点的骨干带宽限速。</p><p>单位 Mbps。</p><p>可选值范围：\[10, +)</p><p>默认值：10</p> |
| edgePointName        | String                                         | 否  | <p>连接点的名称。</p><p>仅支持字母、数字和短横线，长度不超过 100 字符。</p>                     |
| vpcId                | String                                         | 否  | VPC 连接点的 VPC ID。                                                    |
| zbgId                | String                                         | 否  | ZBG 连接点的 ZBG ID。                                                    |
| portId               | String                                         | 否  | 数据中心端口连接点的端口 ID。                                                    |
| cloudType            | [CloudType](#cloudtype)                        | 否  | 云连接点的云厂商类型。                                                         |
| cloudAccountId       | String                                         | 否  | 云连接点的云账号 ID。                                                        |
| dcId                 | String                                         | 否  | 连接点所在的数据中心 ID。                                                      |
| cloudRegionId        | String                                         | 否  | 云连接点的云地域 ID。                                                        |
| haType               | [HaType](#hatype)                              | 否  | 云连接点的高可用类型。                                                         |
| vlanId               | Integer                                        | 否  | <p>连接点的 VLAN ID。</p><p>取值范围 2-4000。</p><p>可选值范围：\[2, 4000]</p>      |
| cloudBandwidthMbps   | Integer                                        | 否  | <p>云连接点的云侧带宽限速。</p><p>单位 Mbps。</p><p>可选值范围：\[10, +)</p>             |
| ipAddress            | String                                         | 否  | 连接点的互联 IP 地址及掩码。                                                    |
| bgpConnection        | [BGPConnection](#bgpconnection)                | 否  | <p>连接点的 BGP 连接配置。</p><p>与静态路由二选一。</p>                               |
| staticRoutes         | Array of [IPRoute](#iproute)                   | 否  | <p>连接点的静态路由配置。</p><p>与 BGP 连接二选一。</p>                               |
| ipSecTunnel          | String                                         | 否  | <p>IPSec 隧道类型。</p><p>取值 FQDN 或 RemoteIP。</p>                        |
| customerPublicIP     | String                                         | 否  | IPSec 客户侧公网 IP 地址。                                                  |
| customerPrivateIP    | String                                         | 否  | IPSec 客户侧私网 IP 地址。                                                  |
| virtualEdgePrivateIP | String                                         | 否  | IPSec Virtual Edge 侧私网 IP 地址。                                       |
| psk                  | String                                         | 否  | IPSec 预共享密钥（PSK）。                                                   |
| enableHealthCheck    | Boolean                                        | 否  | <p>是否开启健康检查。</p><p>默认不开启。</p><p>默认值：false</p>                       |
| backupIpSec          | [BackupIPSecConfig](#backupipsecconfig)        | 否  | IPSec 备份隧道配置。                                                       |
| ipSecBgpConnection   | [IPSecBGPConnection](#ipsecbgpconnection)      | 否  | <p>IPSec 的 BGP 连接配置。</p><p>与 IPSec 静态路由二选一。</p>                     |
| ipSecStaticRoutes    | Array of [IPSecStaticRoute](#ipsecstaticroute) | 否  | <p>IPSec 的静态路由配置。</p><p>与 IPSec BGP 连接二选一。</p>                      |
| marketingInfo        | [MarketingInfo](#marketinginfo)                | 否  | 市场活动相关信息，含是否使用 POC 代金券。                                             |

## CreateEndpointParam

创建二层网络专线时连接点的参数。

被如下接口引用：InquiryCreatePrivateConnectPrice, CreatePrivateConnect

| 参数名称               | 类型                      | 必选 | 描述                                                                                                                           |
| ------------------ | ----------------------- | -- | ---------------------------------------------------------------------------------------------------------------------------- |
| portId             | String                  | 否  | <p>数据中心端口 ID。</p><p>连接点为数据中心端口时使用。</p>                                                                                       |
| vlanId             | Integer                 | 否  | <p>VLAN ID。</p><p>可选值范围：\[1, +)</p>                                                                                          |
| cloudRegionId      | String                  | 否  | <p>云地域 ID。</p><p>连接点为云连接时使用。</p>                                                                                             |
| cloudAccountId     | String                  | 否  | <p>云账号 ID。</p><p>连接点为云连接时使用。</p>                                                                                             |
| haType             | [HaType](#hatype)       | 否  | <p>云连接高可用类型。</p><p>连接点为 Azure 云连接时必传，取值需为该数据中心实际支持的类型，可通过 <code>DescribeAzureRegions</code> 返回的 <code>haTypes</code> 获取。</p> |
| cloudBandwidthMbps | Integer                 | 否  | <p>云连接带宽限制。</p><p>单位：Mbps。</p><p>可选值范围：\[10, +)</p>                                                                          |
| dcId               | String                  | 否  | 数据中心 ID。                                                                                                                     |
| cloudType          | [CloudType](#cloudtype) | 否  | 云厂商类型。                                                                                                                       |
| endpointName       | String                  | 否  | <p>连接点名称。</p><p>仅允许字母、数字和连字符。</p>                                                                                            |

## DataCenterAssemble

描述数据中心的基本信息，包括位置、坐标及数据中心端口可用带宽等。

被如下接口引用：DescribeBorderGatewayDatacenters, DescribeVPCDatacenters, DescribeDatacenters, DescribeVirtualEdgeDatacenters

| 参数名称               | 类型      | 描述            |
| ------------------ | ------- | ------------- |
| dcId               | String  | 数据中心 ID。      |
| dcName             | String  | 数据中心名称。       |
| dcAddress          | String  | 数据中心地址。       |
| cityName           | String  | 所在城市名称。       |
| countryName        | String  | 所在国家名称。       |
| areaName           | String  | 所在大区名称。       |
| latitude           | Float   | 纬度。           |
| longitude          | Float   | 经度。           |
| isPortAvailable    | Boolean | 是否支持新建数据中心端口。 |
| availableBandwidth | Integer | 可用带宽（Mbps）。   |
| regionId           | String  | 节点 ID。        |

## DataCenterWithServiceResponse

带服务类型信息的数据中心详情。

被如下接口引用：DescribeDatacentersWithService

| 参数名称          | 类型                                   | 描述         |
| ------------- | ------------------------------------ | ---------- |
| dcId          | String                               | 数据中心 ID。   |
| dcName        | String                               | 数据中心名称。    |
| dcAddress     | String                               | 数据中心地址。    |
| cityName      | String                               | 所在城市名称。    |
| countryName   | String                               | 所在国家名称。    |
| areaName      | String                               | 所在大区名称。    |
| latitude      | Float                                | 纬度。        |
| longitude     | Float                                | 经度。        |
| cloudRegionId | String                               | 公有云区域 ID。  |
| serviceTypes  | Array of [ServiceType](#servicetype) | 支持的服务类型集合。 |

## DatacenterInfo

数据中心的基本信息。

被如下接口引用：DescribeCloudRouters, DescribePrivateConnects, DescribeAWSRegions, DescribeCloudRouterAvailableVpcs, DescribeInternetDatacenters, DescribeInternets

| 参数名称        | 类型     | 描述          |
| ----------- | ------ | ----------- |
| dcId        | String | 数据中心ID。     |
| dcName      | String | 数据中心名称。     |
| dcAddress   | String | 数据中心地址。     |
| cityName    | String | 数据中心所在城市名称。 |
| countryName | String | 数据中心所在国家名称。 |
| areaName    | String | 数据中心所在区域名称。 |
| latitude    | Float  | 数据中心所在地纬度。  |
| longitude   | Float  | 数据中心所在地经度。  |

## DatacenterPortPrice

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

被如下接口引用：QueryDataCenterPortPrices

| 参数名称                                 | 类型                      | 描述                                                             |
| ------------------------------------ | ----------------------- | -------------------------------------------------------------- |
| crossConnectPrice                    | [PriceItem](#priceitem) | <p>交叉连接价格。</p><p>如果当前数据中心不支持Zenlayer协助建设交叉连接，则该值为null。</p>     |
| crossConnectOneTimeConstructionPrice | [PriceItem](#priceitem) | <p>交叉连接一次性建设费。</p><p>如果当前数据中心不支持Zenlayer协助建设交叉连接，则该值为null。</p> |
| dcId                                 | String                  | 数据中心ID。                                                        |
| price                                | [PriceItem](#priceitem) | 价格信息。                                                          |
| stock                                | Integer                 | 可用库存数量。                                                        |

## DiversityZone

高可用部署分区（红区/蓝区）。

被如下接口引用：DescribeCloudAvailableBandwidthTiers

| 值    | 值说明                                 |
| ---- | ----------------------------------- |
| RED  | <p>红区。</p><p>用于高可用部署时与蓝区互为对端分区。</p> |
| BLUE | <p>蓝区。</p><p>用于高可用部署时与红区互为对端分区。</p> |

## EdgePointType

接入点类型。

被如下接口引用：DescribeCloudRouters

| 值             | 值说明               |
| ------------- | ----------------- |
| VPC           | VPC 接入点。          |
| ZBG           | 边界网关接入点。          |
| IptZBG        | Internet 边界网关接入点。 |
| PORT          | 数据中心端口接入点。        |
| OTHER\_PORT   | 第三方数据中心端口接入点。     |
| KEY\_PORT     | Key Port 接入点。     |
| GOOGLE        | 谷歌云接入点。           |
| TENCENT       | 腾讯云接入点。           |
| ALICLOUD      | 阿里云接入点。           |
| AZURE         | Azure 接入点。        |
| AWS           | AWS 接入点。          |
| VIRTUAL\_EDGE | 边缘网关接入点。          |
| ORACLE        | Oracle 接入点。       |
| HUAWEI        | 华为云接入点。           |
| BYTEPLUS      | BytePlus 接入点。     |
| VOLCENGINE    | 火山引擎接入点。          |

## EndpointType

连接点类型。

被如下接口引用：DescribePrivateConnects

| 值             | 值说明           |
| ------------- | ------------- |
| GOOGLE        | 谷歌云连接点。       |
| TENCENT       | 腾讯云连接点。       |
| AZURE         | Azure 连接点。    |
| ALI\_CLOUD    | 阿里云连接点。       |
| AWS           | AWS 连接点。      |
| HUAWEI\_CLOUD | 华为云连接点。       |
| ORACLE        | Oracle 连接点。   |
| BYTE\_PLUS    | BytePlus 连接点。 |
| VOLCENGINE    | 火山引擎连接点。      |
| PORT          | 数据中心端口连接点。    |
| Ript          | Internet连接点。  |
| OTHER\_PORT   | 第三方数据中心端口连接点。 |

## HaType

主备类型。

被如下接口引用：InquiryCreatePrivateConnectPrice, CreateCloudRouter, DescribeAWSRegions

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

## HaTypeInfo

描述区域内某高可用类型及其使用情况。

被如下接口引用：DescribeAWSRegions

| 参数名称   | 类型                | 描述            |
| ------ | ----------------- | ------------- |
| haType | [HaType](#hatype) | 高可用类型。        |
| isUsed | Boolean           | 该高可用类型是否已被使用。 |

## IPAddress

描述IP信息。

被如下接口引用：DescribeInternets

| 参数名称             | 类型      | 描述      |
| ---------------- | ------- | ------- |
| ipAddress        | String  | IP地址。   |
| netmask          | Integer | 掩码。     |
| gatewayIpAddress | String  | 网关IP地址。 |

## IPRoute

静态路由的配置信息。

被如下接口引用：CreateCloudRouter, DescribeCloudRouters, ModifyCloudRouterEdgePoint

| 参数名称    | 类型     | 必选 | 描述               |
| ------- | ------ | -- | ---------------- |
| prefix  | String | 是  | 静态路由的目的网段（CIDR）。 |
| nextHop | String | 是  | 静态路由的下一跳 IP 地址。  |

## IPSecBGPConnection

IPSec 的 BGP 连接配置信息。

被如下接口引用：CreateCloudRouter

| 参数名称           | 类型      | 必选 | 描述                                     |
| -------------- | ------- | -- | -------------------------------------- |
| customerAsn    | Integer | 是  | 客户侧 BGP ASN。                           |
| virtualEdgeAsn | Integer | 是  | Virtual Edge 侧 BGP ASN。                |
| password       | String  | 否  | <p>BGP 会话的认证密码。</p><p>长度 8-64 个字符。</p> |

## IPSecStaticRoute

IPSec 的静态路由配置信息。

被如下接口引用：CreateCloudRouter

| 参数名称 | 类型     | 必选 | 描述                               |
| ---- | ------ | -- | -------------------------------- |
| cidr | String | 是  | <p>静态路由的目的网段。</p><p>CIDR 格式。</p> |

## Internet

Internet信息。

被如下接口引用：DescribeInternets

| 参数名称                | 类型                                               | 描述                                                    |
| ------------------- | ------------------------------------------------ | ----------------------------------------------------- |
| internetId          | String                                           | Internet ID。                                          |
| internetName        | String                                           | Internet名称。                                           |
| internetDescription | String                                           | Internet描述。                                           |
| dataCenter          | [DatacenterInfo](#datacenterinfo)                | Internet所在数据中心。                                       |
| peerPortId          | String                                           | 对端数据中心端口 ID。                                          |
| peerPortName        | String                                           | 对端数据中心端口名称。                                           |
| peerDataCenter      | [DatacenterInfo](#datacenterinfo)                | 对端数据中心端口所在数据中心。                                       |
| deliveryType        | [InternetDeliveryType](#internetdeliverytype)    | 开通方式。                                                 |
| resourceGroupId     | String                                           | 资源组 ID。                                               |
| resourceGroupName   | String                                           | 资源组名称。                                                |
| createTime          | String                                           | 创建时间。                                                 |
| routingType         | [InternetRouteType](#internetroutetype)          | 路由模式。                                                 |
| internetType        | [InternetType](#internettype)                    | 网络计费方式。                                               |
| bandwidth           | Integer                                          | 带宽（Mbps）。                                             |
| commitBandwidth     | Integer                                          | 保底带宽（Mbps）。                                           |
| bfd                 | [BFDConfig](#bfdconfig)                          | BFD 配置。                                               |
| bgp                 | [InternetBgpConfig](#internetbgpconfig)          | BGP 相关配置。                                             |
| interconnect        | [InternetInterconnect](#internetinterconnect)    | 互联地址配置。                                               |
| privateConnectId    | String                                           | 关联的 VLL ID。                                           |
| privateConnectName  | String                                           | 关联的 VLL 名称。                                           |
| publicIpv4Addresses | Array of [IPAddress](#ipaddress)                 | 公网 IPv4 地址列表。                                         |
| internetStatus      | [InternetStatus](#internetstatus)                | 业务状态。                                                 |
| connectivityStatus  | [ConnectivityStatus](#connectivitystatus)        | 链路连通性状态。                                              |
| tags                | [Tags](#tags)                                    | 该 Internet 关联的标签。                                     |
| publicIpAddresses   | Array of [InternetIpAddress](#internetipaddress) | 公网 IP 地址列表。                                           |
| haMode              | [InternetHaMode](#internethamode)                | 高可用模式。                                                |
| zbgRegionId         | String                                           | <p>ZBG 区域 ID。</p><p>ZBG 场景下的 Internet 将返回此字段。</p>     |
| peerPortType        | [InternetPeerPortType](#internetpeerporttype)    | 对端数据中心端口类型。                                           |
| haLinks             | Array of [InternetHaLink](#internethalink)       | <p>HA 子链路列表。</p><p>非 HA 模式下为 null；HA 模式下含两个子链路对象。</p> |

## InternetAsnInfo

可用 ASN 信息。

被如下接口引用：DescribeInternetAvailableAsns

| 参数名称    | 类型                                  | 描述      |
| ------- | ----------------------------------- | ------- |
| asn     | String                              | ASN 值。  |
| asnType | [InternetAsnType](#internetasntype) | ASN 类型。 |

## InternetAsnType

BGP ASN 类型。

被如下接口引用：DescribeInternetAvailableAsns

| 值       | 值说明      |
| ------- | -------- |
| ASN     | 单个 ASN。  |
| AS\_SET | AS\_SET。 |

## InternetAvailableRoutingType

Internet可用路由模式信息。

被如下接口引用：DescribeInternetDatacenters

| 参数名称                       | 类型                                                                 | 描述                                                                                                   |
| -------------------------- | ------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------- |
| routingType                | [InternetRouteType](#internetroutetype)                            | 路由模式。                                                                                                |
| availableBgpRouteTypes     | Array of [InternetBgpConfigRouteType](#internetbgpconfigroutetype) | <p>可选的 BGP 路由通告类型列表。</p><p>仅 <code>routingType</code> 为 BGP 时有值。</p>                                 |
| availableBgpTiers          | Array of [InternetBgpTier](#internetbgptier)                       | <p>可选的 BGP 档位列表。</p><p>仅 <code>routingType</code> 为 BGP 时有值。</p>                                     |
| peerAsns                   | Array of [InternetPeerAsn](#internetpeerasn)                       | <p>各 BGP 档位对应的 Zenlayer 侧（对端）AS 号，供客户本地路由器 BGP 邻居配置。</p><p>仅 <code>routingType</code> 为 BGP 时有值。</p> |
| deliveryType               | [InternetDeliveryType](#internetdeliverytype)                      | 开通方式。                                                                                                |
| publicInterconnectNetmasks | Array of Integer                                                   | <p>IPv4 公网互联可选掩码列表。</p><p>目前仅 30 / 31。</p>                                                           |

## InternetBgpConfig

BGP相关配置

被如下接口引用：CreateInternet, DescribeInternets

| 参数名称      | 类型                                                        | 必选 | 描述                                                                            |
| --------- | --------------------------------------------------------- | -- | ----------------------------------------------------------------------------- |
| routeType | [InternetBgpConfigRouteType](#internetbgpconfigroutetype) | 是  | 入站路由类型。                                                                       |
| tier      | [InternetBgpTier](#internetbgptier)                       | 否  | <p>BGP 档位。</p><p>STANDARD-普通 BGP，PREMIUM-优质 BGP。</p><p>不传默认优质档（与拆分前行为一致）。</p> |
| asn       | Integer                                                   | 否  | 宣告出站路由的ASN号。                                                                  |
| password  | String                                                    | 否  | 加密认证秘钥。                                                                       |
| asnList   | Array of Integer                                          | 否  | 宣告出站路由的ASN号列表。                                                                |
| asSetList | Array of String                                           | 否  | 宣告出站路由的AS-SET列表。                                                              |

## InternetBgpConfigParam

BGP 变配参数。

被如下接口引用：ModifyInternetConfig

| 参数名称      | 类型                                            | 必选 | 描述                                                                                                           |
| --------- | --------------------------------------------- | -- | ------------------------------------------------------------------------------------------------------------ |
| routeType | [InternetBgpRouteType](#internetbgproutetype) | 否  | <p>BGP inbound 路由类型。</p><p>type=BGP\_ROUTE\_TYPE 时必填。</p>                                                    |
| asnList   | Array of Integer                              | 否  | <p>ASN 列表。</p><p>type=BGP\_ASN\_AS\_SET 时与 <code>asSetList</code> 二选一。</p><p><code>asn</code> 创建后不支持修改。</p>  |
| asSetList | Array of String                               | 否  | <p>AS-SET 列表。</p><p>type=BGP\_ASN\_AS\_SET 时与 <code>asnList</code> 二选一。</p><p><code>asn</code> 创建后不支持修改。</p> |
| password  | String                                        | 否  | <p>BGP MD5 密码（长度 8–64）。</p><p>type=BGP\_PASSWORD 时必填。</p>                                                    |

## InternetBgpConfigRouteType

BGP 接收路由类型。

被如下接口引用：DescribeInternetDatacenters, CreateInternet, InquiryCreateInternetPrice

| 值                                  | 值说明       |
| ---------------------------------- | --------- |
| ALL\_ROUTES                        | 全路由。      |
| ALL\_ROUTES\_WITH\_DEFAULT\_ROUTES | 全路由+默认路由。 |
| DEFAULT\_ROUTES                    | 默认路由。     |

## InternetBgpRouteType

BGP 接收路由类型。

被如下接口引用：ModifyInternetConfig

| 值                                  | 值说明       |
| ---------------------------------- | --------- |
| ALL\_ROUTES                        | 全路由。      |
| ALL\_ROUTES\_WITH\_DEFAULT\_ROUTES | 全路由+默认路由。 |
| DEFAULT\_ROUTES                    | 默认路由。     |

## InternetBgpTier

Internet BGP 档位。

被如下接口引用：DescribeInternetDatacenters, CreateInternet, InquiryCreateInternetPrice

| 值        | 值说明                                                         |
| -------- | ----------------------------------------------------------- |
| STANDARD | <p>普通 BGP。</p><p>仅在部分数据中心开放，仅支持固定带宽计费，带宽只能取该数据中心的固定档位值。</p> |
| PREMIUM  | <p>优质 BGP。</p><p>骨干直连低时延线路，为档位缺省值；档位拆分前创建的存量实例统一返回该档位。</p>  |

## InternetCidrBlock

可用 CIDR 块信息。

被如下接口引用：DescribeInternetAvailableCidrBlocks

| 参数名称          | 类型                                              | 描述                                              |
| ------------- | ----------------------------------------------- | ----------------------------------------------- |
| netmask       | Integer                                         | <p>掩码长度。</p><p>IPv4 范围 24–32，IPv6 范围 48–64。</p> |
| ipNetworkType | [InternetIpNetworkType](#internetipnetworktype) | IP 网络类型。                                        |

## InternetConfigType

Internet配置变更类型。

被如下接口引用：InquiryModifyInternetPrice, ModifyInternetConfig

| 值                   | 值说明                                                                        |
| ------------------- | -------------------------------------------------------------------------- |
| BANDWIDTH           | 带宽。                                                                        |
| BFD                 | BFD 开关。                                                                    |
| BGP\_ROUTE\_TYPE    | BGP 路由类型。                                                                  |
| BGP\_ASN\_AS\_SET   | BGP ASN/AS-SET。                                                            |
| BGP\_PASSWORD       | BGP 密码。                                                                    |
| ADD\_CIDR\_BLOCK    | <p>新增公网 IP 地址段。</p><p>普通 BGP 档位（<code>bgp.tier=STANDARD</code>）的实例不支持。</p> |
| DEL\_CIDR\_BLOCK    | 删除公网 IP 地址段。                                                               |
| EXPAND\_CIDR\_BLOCK | 扩容公网 IP 地址段。                                                               |
| SHRINK\_CIDR\_BLOCK | 缩容公网 IP 地址段。                                                               |
| HA\_SWITCH\_PRIMARY | HA 主备切换。                                                                   |
| HA\_SWITCH\_MODE    | HA 模式切换。                                                                   |

## InternetDatacenter

可连接数据中心信息。

被如下接口引用：DescribeInternetDatacenters

| 参数名称                  | 类型                                                                     | 描述              |
| --------------------- | ---------------------------------------------------------------------- | --------------- |
| dataCenter            | [DatacenterInfo](#datacenterinfo)                                      | 数据中心信息。         |
| availableRoutingTypes | Array of [InternetAvailableRoutingType](#internetavailableroutingtype) | 该数据中心可用的路由模式列表。 |

## InternetDeliveryType

Internet开通方式。

被如下接口引用：DescribeInternetDatacenters, DescribeInternets

| 值      | 值说明   |
| ------ | ----- |
| Auto   | 自动开通。 |
| Manual | 人工开通。 |

## InternetHaConfig

Internet HA配置信息。

被如下接口引用：CreateInternet, InquiryCreateInternetPrice

| 参数名称                | 类型                                | 必选 | 描述                                                     |
| ------------------- | --------------------------------- | -- | ------------------------------------------------------ |
| haMode              | [InternetHaMode](#internethamode) | 是  | HA 运行模式。                                               |
| secondaryPortId     | String                            | 是  | <p>备链路接入数据中心端口 ID。</p><p>与顶层 peerPortId 必须同城不同 DC。</p> |
| secondaryPortVlanId | Integer                           | 是  | 备链路数据中心端口 VLAN ID。                                     |

## InternetHaLink

HA 子链路信息。

被如下接口引用：DescribeInternets

| 参数名称               | 类型                                            | 描述                                                                            |
| ------------------ | --------------------------------------------- | ----------------------------------------------------------------------------- |
| isPrimary          | Boolean                                       | <p>当前是否为主线。</p><p>ACTIVE\_STANDBY 模式下动态反映主备切换状态；ACTIVE\_ACTIVE 模式下为 null。</p> |
| internetStatus     | [InternetStatus](#internetstatus)             | 子链路业务状态。                                                                      |
| connectivityStatus | [ConnectivityStatus](#connectivitystatus)     | 子链路连通性状态。                                                                     |
| privateConnectId   | String                                        | 所属 VLL ID。                                                                    |
| privateConnectName | String                                        | 所属 VLL 名称。                                                                    |
| peerPortId         | String                                        | 对端数据中心端口 ID。                                                                  |
| peerPortName       | String                                        | 对端数据中心端口名称。                                                                   |
| peerDataCenter     | [DatacenterInfo](#datacenterinfo)             | 数据中心端口所在数据中心。                                                                 |
| peerPortVlan       | Integer                                       | VLAN ID。                                                                      |
| interconnect       | [InternetInterconnect](#internetinterconnect) | 互联 IP 配置。                                                                     |

## InternetHaMode

HA 主备模式。

被如下接口引用：InquiryCreateInternetPrice, DescribeInternets

| 值               | 值说明                               |
| --------------- | --------------------------------- |
| ACTIVE\_STANDBY | <p>主备模式。</p><p>仅主链路转发流量。</p>      |
| ACTIVE\_ACTIVE  | <p>负载均衡模式。</p><p>两条子链路同时转发流量。</p> |

## InternetInterconnect

互联地址配置。

被如下接口引用：DescribeInternets

| 参数名称                | 类型     | 描述                    |
| ------------------- | ------ | --------------------- |
| vendorIpv4Address   | String | Zenlayer 侧 IPv4 互联地址。 |
| customerIpv4Address | String | 客户侧 IPv4 互联地址。        |
| vendorIpv6Address   | String | Zenlayer 侧 IPv6 互联地址。 |
| customerIpv6Address | String | 客户侧 IPv6 互联地址。        |

## InternetIpAddress

Internet公网 IP 地址信息。

被如下接口引用：DescribeInternets

| 参数名称             | 类型                                              | 描述                                               |
| ---------------- | ----------------------------------------------- | ------------------------------------------------ |
| ipUuid           | String                                          | <p>IP 块 UUID。</p><p>变更（升降级/删除）时作为 ipUuid 传入。</p> |
| ipAddress        | String                                          | IP 地址（CIDR 表示法，如 192.0.2.0/30）。                  |
| netmask          | Integer                                         | 掩码长度。                                            |
| gatewayIpAddress | String                                          | 网关 IP。                                           |
| ipType           | [InternetIpType](#internetiptype)               | IP 类型（IPV4 / IPV6）。                              |
| ipNetworkType    | [InternetIpNetworkType](#internetipnetworktype) | IP 网络类型（BGP\_IP / LOCAL\_IP）。                    |

## InternetIpNetworkType

Internet IP 网络类型。

被如下接口引用：InquiryModifyInternetPrice, ModifyInternetConfig, DescribeInternetAvailableCidrBlocks, InquiryCreateInternetPrice, DescribeInternets

| 值         | 值说明    |
| --------- | ------ |
| BGP\_IP   | 普通 IP。 |
| LOCAL\_IP | 原生 IP。 |

## InternetIpPrice

IP 价格信息。

被如下接口引用：InquiryCreateInternetPrice

| 参数名称          | 类型                                              | 描述       |
| ------------- | ----------------------------------------------- | -------- |
| price         | [PriceItem](#priceitem)                         | 价格详情。    |
| netmask       | Integer                                         | 掩码长度。    |
| qty           | Integer                                         | 数量。      |
| ipNetworkType | [InternetIpNetworkType](#internetipnetworktype) | IP 网络类型。 |

## InternetIpPriceItem

CIDR 块价格信息。

被如下接口引用：InquiryModifyInternetPrice

| 参数名称          | 类型                                              | 描述                            |
| ------------- | ----------------------------------------------- | ----------------------------- |
| price         | [PriceItem](#priceitem)                         | 价格信息。                         |
| netmask       | Integer                                         | CIDR 掩码长度。                    |
| amount        | Integer                                         | 数量。                           |
| ipNetworkType | [InternetIpNetworkType](#internetipnetworktype) | IP 网络类型（BGP\_IP / LOCAL\_IP）。 |

## InternetIpRequest

公网 IP 分配请求。

被如下接口引用：CreateInternet, InquiryCreateInternetPrice

| 参数名称          | 类型                                              | 必选 | 描述                                                                 |
| ------------- | ----------------------------------------------- | -- | ------------------------------------------------------------------ |
| netmask       | Integer                                         | 是  | <p>CIDR 掩码长度。</p><p>IPv4 有效范围 24–30，IPv6 有效范围 48–64。</p>           |
| ipType        | [InternetIpType](#internetiptype)               | 是  | IP 类型（IPV4 / IPV6）。                                                |
| ipNetworkType | [InternetIpNetworkType](#internetipnetworktype) | 否  | <p>IP 类型。</p><p>默认 BGP\_IP（从 IP 池分配）。</p><p>LOCAL\_IP 表示原生 IP。</p> |
| amount        | Integer                                         | 否  | <p>购买数量。</p><p>指定相同掩码长度的 IP 块数量，默认为 1。</p>                         |

## InternetIpType

IP 协议类型。

被如下接口引用：InquiryCreateInternetPrice, DescribeInternets

| 值    | 值说明   |
| ---- | ----- |
| IPV4 | IPv4。 |
| IPV6 | IPv6。 |

## InternetPeerAsn

BGP 档位与 Zenlayer 侧（对端）AS 号的对应关系。

被如下接口引用：DescribeInternetDatacenters

| 参数名称 | 类型                                  | 描述                         |
| ---- | ----------------------------------- | -------------------------- |
| tier | [InternetBgpTier](#internetbgptier) | BGP 档位。                    |
| asn  | Integer                             | 该档位对应的 Zenlayer 侧（对端）AS 号。 |

## InternetPeerPortType

Internet对端数据中心端口类型。

被如下接口引用：DescribeInternets

| 值         | 值说明        |
| --------- | ---------- |
| PORT      | 数据中心端口。    |
| KEY\_PORT | Key Port。  |
| ZBG       | 边界网关（ZBG）。 |

## InternetRouteType

Internet路由模式。

被如下接口引用：DescribeInternetAvailableCidrBlocks, DescribeInternetDatacenters, CreateInternet, InquiryCreateInternetPrice, DescribeInternets

| 值       | 值说明       |
| ------- | --------- |
| BGP     | BGP 路由模式。 |
| Static  | 静态路由模式。   |
| Gateway | 网关路由模式。   |

## InternetStatus

Internet业务状态。

被如下接口引用：DescribeInternets

| 值                  | 值说明   |
| ------------------ | ----- |
| CREATING           | 创建中。  |
| UPDATING           | 更新中。  |
| DELETING           | 删除中。  |
| DESTROYING         | 销毁中。  |
| RECOVERING         | 恢复中。  |
| RUNNING            | 运行中。  |
| RECYCLED           | 已回收。  |
| DESTROYED          | 已销毁。  |
| CREATING\_FAILED   | 创建失败。 |
| UPDATING\_FAILED   | 更新失败。 |
| DELETING\_FAILED   | 删除失败。 |
| DESTROYING\_FAILED | 销毁失败。 |
| RECOVERING\_FAILED | 恢复失败。 |

## InternetType

网络计费方式。

被如下接口引用：QueryPrivateConnectBandwidthPrice, InquiryCreatePrivateConnectPrice, CreateInternet, QueryPrivateConnectPrice, InquiryCreateInternetPrice, DescribeInternets

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

## LagInfo

数据中心端口归属的 LAG 信息。

被如下接口引用：DescribePorts

| 参数名称    | 类型     | 描述      |
| ------- | ------ | ------- |
| lagId   | String | LAG ID。 |
| lagName | String | LAG 名称。 |

## LoaStatus

LOA上传状态。

被如下接口引用：DescribePorts

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

## MarketingInfo

描述市场活动的相关信息。

被如下接口引用：CreatePort, InquiryModifyInternetPrice, ModifyInternetConfig, CreateCloudRouter, CreatePrivateConnect

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

## PortCategory

数据中心端口类别。

被如下接口引用：DescribeDataCenterPortPrice

| 值         | 值说明                                |
| --------- | ---------------------------------- |
| STANDARD  | <p>标准数据中心端口。</p><p>按固定带宽规格计费。</p>  |
| UNLIMITED | <p>不限量数据中心端口。</p><p>按实际使用流量计费。</p> |

## PortInfo

描述数据中心端口的详细信息。

被如下接口引用：DescribePorts, DescribeCloudRouterAvailablePorts, DescribePrivateConnectAvailablePorts

| 参数名称                    | 类型                                        | 描述                                                                                              |
| ----------------------- | ----------------------------------------- | ----------------------------------------------------------------------------------------------- |
| portId                  | String                                    | 数据中心端口 ID。                                                                                      |
| portName                | String                                    | 数据中心端口名称。                                                                                       |
| portRemarks             | String                                    | 数据中心端口备注信息。                                                                                     |
| portType                | String                                    | 数据中心端口规格。                                                                                       |
| dcId                    | String                                    | 数据中心ID。                                                                                         |
| dcName                  | String                                    | 数据中心名称。                                                                                         |
| cityName                | String                                    | 城市名称。                                                                                           |
| areaName                | String                                    | 所在大区名称。                                                                                         |
| businessEntityName      | String                                    | <p>商业实体名称。</p><p>用于 LOA 抬头。</p>                                                                 |
| connectionStatus        | [ConnectivityStatus](#connectivitystatus) | 数据中心端口连接状态。                                                                                     |
| portStatus              | [BusinessStatus](#businessstatus)         | 数据中心端口业务状态。                                                                                     |
| loaStatus               | [LoaStatus](#loastatus)                   | LOA 状态。                                                                                         |
| loaDownloadUrl          | String                                    | LOA 下载地址。                                                                                       |
| createdTime             | String                                    | 创建时间。                                                                                           |
| expiredTime             | String                                    | 到期时间。                                                                                           |
| period                  | Integer                                   | <p>购买时长。</p><p>单位月。</p>                                                                         |
| isCreateBusinessAllowed | Boolean                                   | 是否允许在该数据中心端口上开通业务。                                                                              |
| tags                    | [Tags](#tags)                             | 数据中心端口关联的标签。                                                                                    |
| lag                     | [LagInfo](#laginfo)                       | <p>数据中心端口归属的 LAG。</p><p>端口未加入 LAG 时为空。</p><p>端口加入 LAG 后只能使用该 LAG 创建业务，不能再单独使用 LAG 的成员口创建业务。</p> |

## PortPrice

描述数据中心端口的类型、类别及价格信息。

被如下接口引用：DescribeDataCenterPortPrice

| 参数名称         | 类型                            | 描述          |
| ------------ | ----------------------------- | ----------- |
| dcId         | String                        | 数据中心ID。     |
| portType     | String                        | 数据中心端口规格。   |
| portCategory | [PortCategory](#portcategory) | 数据中心端口类别。   |
| portPrice    | [PriceItem](#priceitem)       | 数据中心端口价格信息。 |
| stock        | Integer                       | 库存数量。       |

## PriceCategory

描述价格类型。

被如下接口引用：QueryCloudOnrampPrice

| 值          | 值说明   |
| ---------- | ----- |
| STANDARD   | 标准价格。 |
| CUSTOMIZED | 一口价格。 |

## PriceItem

描述价格的信息。

被如下接口引用：QueryPrivateConnectBandwidthPrice, QueryDataCenterPortPrice, InquiryModifyInternetPrice, InquiryCreatePrivateConnectPrice, QueryDataCenterPortPrices, QueryCloudRouterBandwidthPrice, DescribeDataCenterPortPrice, QueryCloudOnrampPrice, QueryPrivateConnectPrice, InquiryCreateInternetPrice

| 参数名称                    | 类型                               | 描述                                                                                                                         |
| ----------------------- | -------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
| discount                | Float                            | <p>折扣大小。</p><p>如80.0代表8折。</p>                                                                                              |
| discountPrice           | Float                            | <p>后付费的单元折后价格。</p><p>后付费模式使用，如果价格为阶梯价格，该项为null。</p>                                                                        |
| originalPrice           | Float                            | <p>预付费的原价。</p><p>预付费模式使用，后付费该值为 null。</p>                                                                                  |
| unitPrice               | Float                            | <p>后付费的单元原始价格。</p><p>后付费模式使用，如果价格为阶梯价格，该项为null。</p>                                                                        |
| discountUnitPrice       | Float                            | <p>后付费的单元折后价格。</p><p>后付费模式使用，如果价格为阶梯价格，该项为null。</p>                                                                        |
| chargeUnit              | String                           | <p>后付费计价单元。</p><p>后付费模式使用，可取值范围：<br>HOUR: 表示计价单元是按每小时来计算。</p><p>DAY: 表示计价单元是按天来计算。</p><p>MONTH: 表示计价单元是按月来计算，95计费则是这种。</p> |
| stepPrices              | Array of [StepPrice](#stepprice) | <p>后付费阶梯价格。</p><p>后付费模式使用，如果非阶梯价格，该项为null。</p>                                                                             |
| amountUnit              | String                           | <p>用量单位。</p><p>比如Mbps, LCU等。</p><p>如果为null, 代表取不到值。</p>                                                                    |
| excessUnitPrice         | Float                            | 超量原始价格。                                                                                                                    |
| excessDiscountUnitPrice | Float                            | 超量折扣后价格。                                                                                                                   |
| excessAmountUnit        | String                           | <p>超量用量单位。</p><p>如果为null, 代表取不到值。</p>                                                                                      |
| category                | [PriceCategory](#pricecategory)  | 价格所属类别。                                                                                                                    |

## PrivateConnect

二层网络专线的详细信息。

被如下接口引用：DescribePrivateConnects

| 参数名称                 | 类型                                                | 描述                            |
| -------------------- | ------------------------------------------------- | ----------------------------- |
| privateConnectId     | String                                            | 二层网络专线 ID。                    |
| privateConnectName   | String                                            | 二层网络专线名称。                     |
| connectivityStatus   | [ConnectivityStatus](#connectivitystatus)         | 连通性状态。                        |
| privateConnectStatus | [BusinessStatus](#businessstatus)                 | 二层网络专线业务状态。                   |
| bandwidthMbps        | Integer                                           | <p>最大带宽限制。</p><p>单位：Mbps。</p> |
| resourceGroupId      | String                                            | 资源组 ID。                       |
| resourceGroupName    | String                                            | 资源组名称。                        |
| createTime           | String                                            | 创建时间。                         |
| expiredTime          | String                                            | 到期时间。                         |
| recycledTime         | String                                            | 回收时间。                         |
| endpointA            | [PrivateConnectEndpoint](#privateconnectendpoint) | 二层网络专线一端的连接点（A）。              |
| endpointZ            | [PrivateConnectEndpoint](#privateconnectendpoint) | 二层网络专线另一端的连接点（Z）。             |
| source               | [BusinessSource](#businesssource)                 | 业务来源。                         |
| tags                 | [Tags](#tags)                                     | 关联的标签。                        |

## PrivateConnectEndpoint

二层网络专线连接点的详细信息。

被如下接口引用：DescribePrivateConnects

| 参数名称               | 类型                                        | 描述                                                 |
| ------------------ | ----------------------------------------- | -------------------------------------------------- |
| endpointId         | String                                    | 连接点 ID。                                            |
| endpointName       | String                                    | 连接点名称。                                             |
| endpointType       | [EndpointType](#endpointtype)             | 连接点类型。                                             |
| connectivityStatus | [ConnectivityStatus](#connectivitystatus) | 连通性状态。                                             |
| vlanId             | Integer                                   | VLAN ID。                                           |
| dataCenter         | [DatacenterInfo](#datacenterinfo)         | 数据中心信息。                                            |
| cloudRegionId      | String                                    | <p>云地域 ID。</p><p>连接点为云连接时返回。</p>                   |
| cloudAccountId     | String                                    | <p>云账号 ID。</p><p>连接点为云连接时返回。</p>                   |
| sharedChannelId    | String                                    | <p>共享通道ID。</p><p>公有云接入点对应的云侧连接标识，仅公有云类型接入点时有值。</p> |

## PrivateConnectEndpointInfo

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

被如下接口引用：QueryPrivateConnectPrice

| 参数名称                          | 类型                      | 必选 | 描述                                                                                                                                                                                                 |
| ----------------------------- | ----------------------- | -- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| dcId                          | String                  | 是  | <p>数据中心ID。</p><p>具体取值可通过调用接口<a href="https://docs.console.zenlayer.com/api-reference/cn/sdn/location/describedatacenters.md">DescribeDataCenters</a>来获得最新的数据中心列表。</p>                              |
| cloudType                     | [CloudType](#cloudtype) | 否  | 云连接类型。                                                                                                                                                                                             |
| bandwidthMbps                 | Integer                 | 否  | <p>云连接的最大带宽限制。</p><p>默认值是10，单位：Mbps。</p><p>可选值范围：\[10, +)</p><p>默认值：10</p>                                                                                                                         |
| vlanId                        | Integer                 | 否  | <p>VLAN ID。</p><p>可选值范围：\[2, 4000]</p>                                                                                                                                                             |
| cloudRegionId                 | String                  | 否  | <p>公有云区域ID。</p><p>Google云无需传参。</p>                                                                                                                                                                 |
| portType                      | String                  | 否  | <p>数据中心端口规格。</p><p>具体取值可通过调用接口<a href="https://docs.console.zenlayer.com/api-reference/cn/sdn/data-center-port/describedatacenterportprice.md">DescribeDataCenterPortPrice</a>来获得最新的数据中心端口规格表。</p> |
| buildCrossConnectWithAssisted | Boolean                 | 否  | <p>是否需要Zenlayer协助建设交叉连接。</p><p>如果选择true，则价格将包含交叉连接的跳线费用，以及一次性建设费。</p><p>默认值为false，即用户需要自行建设交叉连接。</p><p>默认值：false</p>                                                                               |

## PrivateConnectEndpointPrice

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

被如下接口引用：QueryPrivateConnectPrice

| 参数名称                                 | 类型                      | 描述                                                                 |
| ------------------------------------ | ----------------------- | ------------------------------------------------------------------ |
| crossConnectPrice                    | [PriceItem](#priceitem) | <p>交叉连接价格。</p><p>连接点类型为数据中心端口并且该数据中心支持Zenlayer协助建设交叉连接时有值。</p>     |
| crossConnectOneTimeConstructionPrice | [PriceItem](#priceitem) | <p>交叉连接一次性建设费。</p><p>连接点类型为数据中心端口并且该数据中心支持Zenlayer协助建设交叉连接时有值。</p> |
| price                                | [PriceItem](#priceitem) | 价格信息。                                                              |
| stock                                | Integer                 | 可用库存数量。                                                            |

## ProtectionType

专线保护类型。

被如下接口引用：QueryPrivateConnectBandwidthPrice

| 值                   | 值说明                               |
| ------------------- | --------------------------------- |
| SINGLE\_PROTECTED   | <p>单路径保护型。</p><p>提供线路保护/冗余能力。</p> |
| SINGLE\_UNPROTECTED | <p>单路径非保护型。</p><p>不提供线路保护。</p>    |

## ServiceType

服务类型。

被如下接口引用：DescribeDatacentersWithService

| 值                | 值说明                |
| ---------------- | ------------------ |
| AWS              | 亚马逊云。              |
| TENCENT          | 腾讯云。               |
| GOOGLE           | 谷歌云。               |
| AZURE            | 微软 Azure。          |
| ALI\_CLOUD       | 阿里云。               |
| HUAWEI\_CLOUD    | 华为云。               |
| DATACENTER\_PORT | 数据中心端口（非云服务）。      |
| BYTE\_PLUS       | BytePlus（字节跳动海外云）。 |
| VOLCENGINE       | 火山引擎。              |
| ORACLE           | 甲骨文云（Oracle）。      |

## StepPrice

描述阶梯价格的信息。

被如下接口引用：QueryCloudOnrampPrice

| 参数名称              | 类型    | 描述                                  |
| ----------------- | ----- | ----------------------------------- |
| stepStart         | Float | 阶梯的起始值。                             |
| stepEnd           | Float | <p>阶梯的到达值。</p><p>为null代表最后一级阶梯。</p> |
| unitPrice         | Float | 阶梯单价。                               |
| discountUnitPrice | Float | 阶梯折后价。                              |

## Tag

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

被如下接口引用：CreatePort, DescribePorts, DescribeCloudRouters, DescribePrivateConnects, DescribeInternets

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

## TagAssociation

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

被如下接口引用：CreatePort, CreateCloudRouter, CreatePrivateConnect, CreateInternet

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

## Tags

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

被如下接口引用：DescribePorts, DescribeCloudRouters, DescribePrivateConnects, DescribeInternets

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

## TrafficData

描述带宽的数据点信息。

被如下接口引用：DescribeInternetTraffic, DescribePrivateConnectTraffic, DescribeCloudRouterEdgePointTraffic, DescribePortTraffic, DescribeCloudRouterDCToDCTraffic

| 参数名称       | 类型      | 描述                                                                          |
| ---------- | ------- | --------------------------------------------------------------------------- |
| internetRX | Integer | <p>入方向带宽值。</p><p>单位：bps。</p>                                                |
| internetTX | Integer | <p>出方向带宽值。</p><p>单位：bps。</p>                                                |
| time       | String  | <p>数据时间。</p><p>按照ISO8601标准表示，并且使用UTC时间。</p><p>格式为：YYYY-MM-ddTHH:mm:ssZ。</p> |

## TrafficStatistic

流量数据的统计方式。

被如下接口引用：DescribeInternetTraffic, DescribePrivateConnectTraffic, DescribeCloudRouterEdgePointTraffic, DescribePortTraffic, DescribeCloudRouterDCToDCTraffic

| 值       | 值说明  |
| ------- | ---- |
| Average | 平均值。 |
| Maximum | 最大值。 |
