> 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/compute/traffic/datastructure.md).

# 数据结构

## BandwidthClusterAreaInfo

描述带宽包的区域信息。

被如下接口引用：DescribeBandwidthClusterAreas

| 参数名称         | 类型                                     | 描述            |
| ------------ | -------------------------------------- | ------------- |
| areaCode     | String                                 | 带宽包区域代码。      |
| areaName     | String                                 | 带宽包区域名称。      |
| networkTypes | Array of [NetworkType](#networktype)   | 该地区支持的IP网络类型。 |
| products     | Array of [ProductRange](#productrange) | 该地区支持的产品线。    |

## BandwidthClusterInfo

共享带宽包的基本信息。

被如下接口引用：DescribeBandwidthClusters

| 参数名称                             | 类型                                        | 描述                                                             |
| -------------------------------- | ----------------------------------------- | -------------------------------------------------------------- |
| bandwidthClusterId               | String                                    | 共享带宽包唯一ID。                                                     |
| bandwidthClusterName             | String                                    | 共享带宽包显示名称。                                                     |
| networkType \[已废弃]               | [NetworkType](#networktype)               | <p>IP 网络类型。</p><p>请使用<code>ipNetworkType</code>。</p>           |
| networkLineType                  | [NetworkLineType](#networklinetype)       | 网络线路类型。                                                        |
| product                          | [ProductRange](#productrange)             | 产品范围。                                                          |
| areaCode                         | String                                    | 区域代号。                                                          |
| internetChargeType               | [InternetChargeType](#internetchargetype) | 带宽计费方式。                                                        |
| commitBandwidthMbps              | Integer                                   | <p>保底带宽。</p><p>单位：Mbps。</p>                                    |
| internationalCommitBandwidthMbps | Integer                                   | <p>国际保底带宽。</p><p>单位：Mbps。</p><p>仅 PathBasedBandwidth 类型返回。</p> |
| location                         | String                                    | 所属区域。                                                          |
| createTime                       | String                                    | <p>创建时间。</p><p>格式为：YYYY-MM-ddTHH:mm:ssZ。</p>                   |
| resourceNumber                   | Integer                                   | 带宽包内的资源数量。                                                     |
| cities                           | Array of [CityInfo](#cityinfo)            | 城市信息。                                                          |
| tags                             | [Tags](#tags)                             | 共享带宽包关联的标签。                                                    |
| resourceGroup                    | [ResourceGroupInfo](#resourcegroupinfo)   | 共享带宽包所属的资源组。                                                   |

## BandwidthClusterResource

描述带宽包里的资源信息。

被如下接口引用：DescribeBandwidthClusterResources

| 参数名称         | 类型                            | 描述    |
| ------------ | ----------------------------- | ----- |
| resourceId   | String                        | 资源ID。 |
| resourceType | [ResourceType](#resourcetype) | 资源类型。 |

## BandwidthClusterTrafficData

共享带宽包带宽数据点。

被如下接口引用：DescribeBandwidthClusterTraffic

| 参数名称       | 类型      | 描述                                           |
| ---------- | ------- | -------------------------------------------- |
| internetRX | Integer | <p>入口带宽。</p><p>单位：bps。</p>                   |
| internetTX | Integer | <p>出口带宽。</p><p>单位：bps。</p>                   |
| time       | String  | <p>数据时间。</p><p>格式为：YYYY-MM-ddTHH:mm:ssZ。</p> |

## BandwidthClusterUsageData

带宽用量数据。

被如下接口引用：DescribeBandwidthClusterUsage

| 参数名称       | 类型                                                                   | 描述                                                                   |
| ---------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
| time       | String                                                               | <p>时间。</p><p>95计费时间为月（格式yyyy-MM）。</p><p>日峰值计费时间为日（格式yyyy-MM-dd）。</p> |
| value      | Float                                                                | <p>带宽值。</p><p>单位：Mbps。</p>                                           |
| typeValues | Array of [TrafficTypeValue](#traffictypevalue)                       | <p>分类型带宽值列表。</p><p>仅 PathBasedBandwidth 类型填充。</p>                    |
| details    | Array of [BandwidthClusterUsageDetail](#bandwidthclusterusagedetail) | 带宽详情列表。                                                              |

## BandwidthClusterUsageDetail

带宽用量详情数据。

被如下接口引用：DescribeBandwidthClusterUsage

| 参数名称       | 类型                                             | 描述                                                |
| ---------- | ---------------------------------------------- | ------------------------------------------------- |
| cityName   | String                                         | 城市名称。                                             |
| cityCode   | String                                         | 城市代码。                                             |
| product    | [ProductRange](#productrange)                  | 产品来源。                                             |
| value      | Float                                          | <p>带宽值。</p><p>单位：Mbps。</p>                        |
| typeValues | Array of [TrafficTypeValue](#traffictypevalue) | <p>分类型带宽值列表。</p><p>仅 PathBasedBandwidth 类型填充。</p> |

## BandwidthTrafficType

带宽组的流量类型。

被如下接口引用：DescribeBandwidthClusterUsage, DescribeBandwidthClusterTraffic

| 值             | 值说明   |
| ------------- | ----- |
| LOCAL         | 本地流量。 |
| INTERNATIONAL | 国际流量。 |

## CityInfo

描述城市的基本信息。

被如下接口引用：DescribeBandwidthClusters

| 参数名称     | 类型     | 描述       |
| -------- | ------ | -------- |
| cityName | String | 城市名称。    |
| cityCode | String | 城市三字码代号。 |

## InternetChargeType

描述网络的计费类型。

被如下接口引用：InquiryBandwidthClusterPrice, CreateBandwidthCluster, DescribeBandwidthClusters

| 值                         | 值说明      |
| ------------------------- | -------- |
| MonthlyPercent95Bandwidth | 月95带宽计费。 |
| DayPeakBandwidth          | 日峰值带宽计费。 |

## NetworkLineType

描述IP网络类型的方式。

被如下接口引用：CreateBandwidthCluster, DescribeBandwidthClusters

| 值                  | 值说明                             |
| ------------------ | ------------------------------- |
| PremiumBGP         | <p>精品 BGP。</p><p>高性能网络。</p>     |
| StandardBGP        | <p>标准 BGP。</p><p>通用网络，成本优化。</p> |
| CN2                | 回国优化线路。                         |
| PathBasedBandwidth | 多路径带宽。                          |
| CMI                | 中国移动。                           |
| CUG                | 中国联通。                           |
| CTG                | 中国电信。                           |

## NetworkType

描述IP网络类型的方式。另详见`NetworkLineType`。

被如下接口引用：InquiryBandwidthClusterPrice, DescribeBandwidthClusterAreas, CreateBandwidthCluster, DescribeBandwidthClusters

| 值                  | 值说明     |
| ------------------ | ------- |
| BGP                | BGP。    |
| Cogent             | Cogent。 |
| CN2                | 回国优化线路。 |
| PathBasedBandwidth | 多路径带宽。  |
| CMI                | 中国移动。   |
| CUG                | 中国联通。   |
| CTG                | 中国电信。   |

## PriceCategory

描述价格类型。

被如下接口引用：InquiryBandwidthClusterPrice

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

## PriceItem

描述价格的信息。

被如下接口引用：InquiryBandwidthClusterPrice

| 参数名称                    | 类型                               | 描述                                                                                                                            |
| ----------------------- | -------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
| 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>后付费模式使用，可取值范围：</p><p>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)  | 价格所属类别。                                                                                                                       |

## ProductRange

产品范围。

被如下接口引用：InquiryBandwidthClusterPrice, DescribeBandwidthClusterAreas, CreateBandwidthCluster, DescribeBandwidthClusterUsage, DescribeBandwidthClusters

| 值          | 值说明                                |
| ---------- | ---------------------------------- |
| AllProduct | <p>全算力产品范围。</p><p>该范围可能会在未来移除。</p> |
| BMC        | 裸金属产品范围。                           |
| ZEC        | 弹性算力产品凡范围。                         |
| VM         | 虚拟机产品范围。                           |
| OFFLINE    | 线下产品范围。                            |

## ResourceGroupInfo

描述资源所在资源组的相关信息，包括资源组名称和ID。

被如下接口引用：DescribeBandwidthClusters

| 参数名称              | 类型     | 描述     |
| ----------------- | ------ | ------ |
| resourceGroupId   | String | 资源组ID。 |
| resourceGroupName | String | 资源组名称。 |

## ResourceType

描述资源类型的值。

被如下接口引用：DescribeBandwidthClusterResources

| 值                   | 值说明       |
| ------------------- | --------- |
| VM\_INSTANCE        | 虚拟机实例。    |
| BMC\_INSTANCE       | 裸金属实例。    |
| ZEC\_EIP\_INSTANCE  | 弹性算力IP。   |
| ZEC\_IPV6\_INSTANCE | 弹性算力IPv6。 |
| OTHERS              | 其他资源。     |

## StepPrice

描述阶梯价格的信息。

被如下接口引用：InquiryBandwidthClusterPrice

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

## Tag

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

被如下接口引用：CreateBandwidthCluster, DescribeBandwidthClusters

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

## TagAssociation

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

被如下接口引用：CreateBandwidthCluster

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

## Tags

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

被如下接口引用：DescribeBandwidthClusters

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

## TrafficTypeValue

分类型带宽值。

被如下接口引用：DescribeBandwidthClusterUsage

| 参数名称        | 类型                                            | 描述                                            |
| ----------- | --------------------------------------------- | --------------------------------------------- |
| trafficType | [BandwidthTrafficType](#bandwidthtraffictype) | <p>流量类型。</p><p>LOCAL：本地；INTERNATIONAL：国际。</p> |
| value       | Float                                         | <p>带宽值。</p><p>单位：Mbps。</p>                    |
