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

# 数据结构

## 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, DescribeAWSRegions, DescribeOracleRegions, DescribeGoogleRegions

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

## CloudRegion

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

被如下接口引用：DescribeAliCloudRegions, DescribeAzureRegions, DescribeHuaweiCloudRegions, DescribeBytePlusRegions, DescribeTencentRegions, 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

云厂商类型。

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

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

## ConnectivityStatus

链路连通性状态。

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

| 值        | 值说明     |
| -------- | ------- |
| 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>                      |

## 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)       | 否  | 云连接高可用类型。                                           |
| 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

| 参数名称        | 类型     | 描述          |
| ----------- | ------ | ----------- |
| 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        | 远程 IP 隧道边界网关接入点。 |
| PORT          | 数据中心端口接入点。       |
| OTHER\_PORT   | 第三方数据中心端口接入点。    |
| KEY\_PORT     | Key Port 接入点。    |
| GOOGLE        | 谷歌云接入点。          |
| TENCENT       | 腾讯云接入点。          |
| ALICLOUD      | 阿里云接入点。          |
| AZURE         | Azure 接入点。       |
| AWS           | AWS 接入点。         |
| VIRTUAL\_EDGE | 边缘网关接入点。         |
| ORACLE        | Oracle 接入点。      |
| HUAWEI        | 华为云接入点。          |
| BYTEPLUS      | 火山引擎接入点。         |

## EndpointType

连接点类型。

被如下接口引用：DescribePrivateConnects

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

## HaType

主备类型。

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

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

## HaTypeInfo

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

被如下接口引用：DescribeAWSRegions

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

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

## InternetType

网络计费方式。

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

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

## LoaStatus

LOA上传状态。

被如下接口引用：DescribePorts

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

## MarketingInfo

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

被如下接口引用：CreatePort, 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)                             | 数据中心端口关联的标签。                    |

## PortPrice

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

被如下接口引用：DescribeDataCenterPortPrice

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

## PriceCategory

描述价格类型。

被如下接口引用：DescribeDataCenterPortPrice

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

## PriceItem

描述价格的信息。

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

| 参数名称                    | 类型                               | 描述                                                                                                                         |
| ----------------------- | -------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
| 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="/pages/XlOIfVI4iGunGXfp6eNf">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="/pages/vdB3HPVa1upxtt2gzbql">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）。 |
| ORACLE           | 甲骨文云（Oracle）。   |

## StepPrice

描述阶梯价格的信息。

被如下接口引用：DescribeDataCenterPortPrice

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

## Tag

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

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

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

## TagAssociation

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

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

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

## Tags

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

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

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

## TrafficData

描述带宽的数据点信息。

被如下接口引用：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<span data-gb-custom-inline data-tag="emoji" data-code="1f1f2-1f1f2">🇲🇲</span>ssZ。</p> |
