> 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/compute/traffic/datastructure.md). # Data Types ## BandwidthClusterAreaInfo The location information of the bandwidth cluster. Referenced by：DescribeBandwidthClusterAreas | Parameter Name | Type | Description | | -------------- | -------------------------------------- | -------------------------------------------- | | areaCode | String | Location code of bandwidth cluster. | | areaName | String | Location name of bandwidth cluster. | | networkTypes | Array of [NetworkType](#networktype) | The network type supported in the location. | | products | Array of [ProductRange](#productrange) | The service types supported in the location. | ## BandwidthClusterInfo Information on a bandwidth cluster. Referenced by：DescribeBandwidthClusters | Parameter Name | Type | Description | | -------------------------------- | ----------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | | bandwidthClusterId | String | Bandwidth cluster ID. | | bandwidthClusterName | String | Bandwidth cluster name. | | networkType \[Deprecated] | [NetworkType](#networktype) | IP network type. | | networkLineType | [NetworkLineType](#networklinetype) | IP network type information. | | product | [ProductRange](#productrange) | Service type covered by bandwidth cluster. | | areaCode | String | Location code of bandwidth cluster. | | internetChargeType | [InternetChargeType](#internetchargetype) | Network billing method. | | commitBandwidthMbps | Integer |

Bandwidth commitment.

Unit: Mbps.

| | internationalCommitBandwidthMbps | Integer |

International bandwidth commitment.

Unit: Mbps.

Only returned for PathBasedBandwidth bandwidth clusters.

| | location | String | Location of bandwidth cluster. | | createTime | String |

Creation time.

Format: YYYY-MM-ddTHH:mm:ssZ.

| | resourceNumber | Integer | Resource quantity in the bandwidth cluster. | | cities | Array of [CityInfo](#cityinfo) | City information of the bandwidth cluster. | | tags | [Tags](#tags) | The tags associated with the shared bandwidth package. | | resourceGroup | [ResourceGroupInfo](#resourcegroupinfo) | The resource group to which the shared bandwidth package belongs. | ## BandwidthClusterResource Information on resources in a bandwidth cluster. Referenced by：DescribeBandwidthClusterResources | Parameter Name | Type | Description | | -------------- | ----------------------------- | -------------- | | resourceId | String | Resource ID. | | resourceType | [ResourceType](#resourcetype) | Resource type. | ## BandwidthClusterTrafficData Bandwidth information on a bandwidth cluster. Referenced by：DescribeBandwidthClusterTraffic | Parameter Name | Type | Description | | -------------- | ------- | -------------------------------------------------------- | | internetRX | Integer | Inbound bandwidth. Unit: bps. | | internetTX | Integer | Out bound bandwidth. Unit: bps. | | time | String |

Time of data.

Format: YYYY-MM-ddTHH:mm:ssZ.

| ## BandwidthClusterUsageData Bandwidth usage data. Referenced by：DescribeBandwidthClusterUsage | Parameter Name | Type | Description | | -------------- | -------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | | time | String |

Time.

Monthly Burstable 95th. Format: yyyy-MM.

Daily Peak. Format: yyyy-MM-dd.

| | value | Float |

Bandwidth value.

Unit: Mbps.

| | typeValues | Array of [TrafficTypeValue](#traffictypevalue) |

List of bandwidth values by traffic type.

Only populated for PathBasedBandwidth bandwidth clusters.

| | details | Array of [BandwidthClusterUsageDetail](#bandwidthclusterusagedetail) | List of bandwidth usage details. | ## BandwidthClusterUsageDetail Bandwidth usage details data. Referenced by：DescribeBandwidthClusterUsage | Parameter Name | Type | Description | | -------------- | ---------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | | cityName | String | City name. | | cityCode | String | City code. | | product | [ProductRange](#productrange) | Product source. | | value | Float |

Bandwidth value.

Unit: Mbps.

| | typeValues | Array of [TrafficTypeValue](#traffictypevalue) |

List of bandwidth values by traffic type.

Only populated for PathBasedBandwidth bandwidth clusters.

| ## BandwidthTrafficType Traffic type of the bandwidth cluster. Referenced by：DescribeBandwidthClusterUsage, DescribeBandwidthClusterTraffic | Value | Description | | ------------- | ---------------------- | | LOCAL | Domestic traffic. | | INTERNATIONAL | International traffic. | ## CityInfo Information about city. Referenced by：DescribeBandwidthClusters | Parameter Name | Type | Description | | -------------- | ------ | ------------- | | cityName | String | Name of city. | | cityCode | String | Code of city. | ## InternetChargeType Network billing method of the bandwidth cluster. Referenced by：InquiryBandwidthClusterPrice, CreateBandwidthCluster, DescribeBandwidthClusters | Value | Description | | ------------------------- | -------------------------------------- | | MonthlyPercent95Bandwidth | Monthly Burstable 95th billing method. | | DayPeakBandwidth | Daily Peak billing method. | ## NetworkLineType IP network type information. Referenced by：CreateBandwidthCluster, DescribeBandwidthClusters | Value | Description | | ------------------ | ---------------------------------------------------- | | PremiumBGP | Premium BGP for optimized network performance. | | StandardBGP | Standard BGP for general use with cost optimization. | | CN2 | China Telecom Next Carrier Network. | | PathBasedBandwidth | Multi-path bandwidth. | | CMI | China Mobile. | | CUG | China Unicom. | | CTG | China Telecom. | ## NetworkType IP network type information. Referenced by：InquiryBandwidthClusterPrice, DescribeBandwidthClusterAreas, CreateBandwidthCluster, DescribeBandwidthClusters | Value | Description | | ------------------ | ----------------------------------- | | BGP | BGP network. | | Cogent | Cogent network. | | CN2 | China Telecom Next Carrier Network. | | PathBasedBandwidth | Multi-path bandwidth. | | CMI | China Mobile network. | | CUG | China Unicom network. | | CTG | China Telecom network. | ## PriceCategory Describes the price category. Referenced by：InquiryBandwidthClusterPrice | Value | Description | | ---------- | ----------------- | | STANDARD | Standard pricing. | | CUSTOMIZED | Fixed price. | ## PriceItem Pricing information. Referenced by：InquiryBandwidthClusterPrice | Parameter Name | Type | Description | | ----------------------- | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | discount | Float |

Discount.

For example, 80.0 means 20% off.

| | discountPrice | Float |

Discount price of postpaid resources.

Only used in pay-as-you-go model. For tiered billing, the value is empty.

| | originalPrice | Float |

Original price of prepaid resources.

Only used in subscription model. For pay-as-you-go model, the value is empty.

| | unitPrice | Float |

Original unit price of postpaid resources.

Only used in pay-as-you-go model. For tiered billing, the value is empty.

| | discountUnitPrice | Float |

Discount unit price of postpaid resources.

Only used in pay-as-you-go model. For tiered billing, the value is empty.

| | chargeUnit | String |

Unit of postpaid billing.

Only used in pay-as-you-go model.

Value range:

HOUR: you will be billed by hour.

DAY: you will be billed by day.

MONTH: you will be billed by month. For example, the burstable 95th pricing model.

| | stepPrices | Array of [StepPrice](#stepprice) |

Tiered price of postpaid billing.

Only used in pay-as-you-go model. If it is not tiered price, the value is empty.

| | amountUnit | String |

Unit of usage, such as Mbps, LCU, and etc.

If the value is empty, it means there is no unit.

| | excessUnitPrice | Float | Original unit price of overages. | | excessDiscountUnitPrice | Float | Discount unit price of overages. | | excessAmountUnit | String |

Unit of overage usage.

If the value is empty, it means there is no unit.

| | category | [PriceCategory](#pricecategory) | The category to which the price belongs. | ## ProductRange Information on service types covered by the bandwidth cluster. Referenced by：InquiryBandwidthClusterPrice, DescribeBandwidthClusterAreas, CreateBandwidthCluster, DescribeBandwidthClusterUsage, DescribeBandwidthClusters | Value | Description | | ---------- | ------------------------------------------------------------------------------------- | | AllProduct |

All compute services.

This service type maybe unavailable in the future.

| | BMC | Bare metal service. | | ZEC | Elastic compute service. | | VM | Virtual machine service. | | OFFLINE | Offline serveice. | ## ResourceGroupInfo Describes the information about the resource group to which the resource belongs, including the resource group name and ID. Referenced by：DescribeBandwidthClusters | Parameter Name | Type | Description | | ----------------- | ------ | ------------------------ | | resourceGroupId | String | The resource group ID. | | resourceGroupName | String | The resource group name. | ## ResourceType Information on resource types. Referenced by：DescribeBandwidthClusterResources | Value | Description | | ------------------- | ------------------------------------- | | VM\_INSTANCE | Virtual machine instances. | | BMC\_INSTANCE | Bare metal instances. | | ZEC\_EIP\_INSTANCE | Elastic compute elastic IP addresses. | | ZEC\_IPV6\_INSTANCE | Elastic compute IPv6 addresses. | | OTHERS | Other resources. | ## StepPrice Describe a tier of the tiered price . Referenced by：InquiryBandwidthClusterPrice | Parameter Name | Type | Description | | ----------------- | ----- | --------------------------------------------------------------------------------- | | stepStart | Float | First price range of a tiered price. | | stepEnd | Float | Last price range of a tiered price.If the value is empty, it means the last tier. | | unitPrice | Float | Original unit price of current price range. | | discountUnitPrice | Float | Discount unit price of current price range. | ## Tag Information on a tag, including its key and value. Referenced by：CreateBandwidthCluster, DescribeBandwidthClusters | Parameter Name | Type | Required | Description | | -------------- | ------ | -------- | ------------------------------------------------------------- | | key | String | Yes |

The tag key.

Length limit: 1 to 64 characters.

| | value | String | No |

The tag value.

Length limit: 1 to 64 characters.

| ## TagAssociation Information on tags bound to resources, including their keys and values. Referenced by：CreateBandwidthCluster | Parameter Name | Type | Required | Description | | -------------- | -------------------- | -------- | ------------- | | tags | Array of [Tag](#tag) | Yes | List of tags. | ## Tags Describes the tag information associated with the resource. Referenced by：DescribeBandwidthClusters | Parameter Name | Type | Description | | -------------- | -------------------- | ------------- | | tags | Array of [Tag](#tag) | List of tags. | ## TrafficTypeValue Bandwidth value by traffic type. Referenced by：DescribeBandwidthClusterUsage | Parameter Name | Type | Description | | -------------- | --------------------------------------------- | ------------------------------------------------------------------------- | | trafficType | [BandwidthTrafficType](#bandwidthtraffictype) |

Traffic type.

LOCAL: domestic; INTERNATIONAL: international.

| | value | Float |

Bandwidth value.

Unit: Mbps.

|