> 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/ipt/datastructure.md). # Data Types ## AsnInfo Available ASN information. Referenced by：DescribeIPTransitAvailableAsns | Parameter Name | Type | Description | | -------------- | ------------------------------------- | ------------------------------------------------------------- | | asn | String | ASN value. | | asnType | [IPTransitAsnType](#iptransitasntype) | ASN type (PUBLIC for public ASN, PRIVATE for private AS-SET). | ## BFDConfig BFD configuration. Referenced by：ModifyIPTransitConfig, DescribeIPTransits, CreateIPTransit | Parameter Name | Type | Required | Description | | -------------- | ------- | -------- | ------------------------------------------------------------------------------------------------------- | | bfdTxInterval | Integer | No |

Transmit interval.

Unit: ms.

Value range: 100-60000.

Value range: \[100, 6000]

| | bfdRxInterval | Integer | No |

Receive interval.

Unit: ms.

Value range: 100-60000.

Value range: \[100, 6000]

| | bfdMultiplier | Integer | No |

Detection multiplier.

Value range: 3-20.

Value range: \[3, 20]

| ## BgpConfigParam BGP configuration change parameters. Referenced by：ModifyIPTransitConfig | Parameter Name | Type | Required | Description | | -------------- | ----------------------------------------------- | -------- | ------------------------------------------------------------------------------------- | | routeType | [IPTransitBgpRouteType](#iptransitbgproutetype) | No |

BGP inbound route type.

Required when type is BGP\_ROUTE\_TYPE.

| | asnList | Array of Integer | No |

List of ASNs.

Effective when type is BGP\_ASN\_AS\_SET.

| | asSetList | Array of String | No |

List of AS-SETs.

Effective when type is BGP\_ASN\_AS\_SET.

| | password | String | No |

BGP MD5 password (8-64 characters).

Required when type is BGP\_PASSWORD.

| ## CidrBlock Available CIDR block information. Referenced by：DescribeIPTransitAvailableCidrBlocks | Parameter Name | Type | Description | | -------------- | ------------------------------------------------- | ------------------------------------------------------------------ | | netmask | Integer |

Netmask length.

IPv4 range: 24-32. IPv6 range: 48-64.

| | ipNetworkType | [IPTransitIpNetworkType](#iptransitipnetworktype) | IP network type. | ## ConnectivityStatus Connectivity status of the link. Referenced by：DescribeIPTransits | Value | Description | | -------- | ------------------------------- | | ACTIVE | The link is connected normally. | | DOWN | The link is down. | | ABNORMAL | The link is partially abnormal. | ## DatacenterInfo Information on a data center. Referenced by：DescribeIPTransitDatacenters, DescribeIPTransits | Parameter Name | Type | Description | | -------------- | ------ | ----------------------------- | | dcId | String | Data center ID. | | dcName | String | Data center name. | | dcAddress | String | Data center location. | | cityName | String | City name. | | countryName | String | Country name. | | areaName | String | Region name. | | latitude | Float | Latitude of the data center. | | longitude | Float | Longitude of the data center. | ## HaLink HA sub-link information. Referenced by：DescribeIPTransits | Parameter Name | Type | Description | | ------------------ | ----------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | isPrimary | Boolean |

Whether this is currently the primary link.

In ACTIVE\_STANDBY mode, this dynamically reflects the primary/secondary switchover state. In ACTIVE\_ACTIVE mode, the value is null.

| | iptStatus | [IPTransitStatus](#iptransitstatus) | State of the sub-link. | | connectivityStatus | [ConnectivityStatus](#connectivitystatus) | Connectivity status of the sub-link. | | privateConnectId | String | ID of the associated VLL. | | privateConnectName | String | Name of the associated VLL. | | peerPortId | String | Peer port ID. | | peerPortName | String | Peer port name. | | peerDataCenter | [DatacenterInfo](#datacenterinfo) | Data center of the port. | | peerPortVlan | Integer | VLAN ID. | | interconnect | [Interconnect](#interconnect) | Interconnect IP configuration. | ## IPAddress Describes IP information. Referenced by：DescribeIPTransits | Parameter Name | Type | Description | | ---------------- | ------- | ------------------- | | ipAddress | String | IP address. | | netmask | Integer | Netmask. | | gatewayIpAddress | String | Gateway IP address. | ## IPPrice IP price information. Referenced by：InquiryCreateIPTransitPrice | Parameter Name | Type | Description | | -------------- | ------------------------------------------------- | --------------------------------- | | price | [PriceItem](#priceitem) | Price information of the IP CIDR. | | netmask | Integer | IP CIDR netmask. | | qty | Integer | Number of IP CIDRs. | | ipNetworkType | [IPTransitIpNetworkType](#iptransitipnetworktype) | IP network type. | ## IPTransit Describes information on an IP Transit resource, including associated port, resource group, and etc. Referenced by：DescribeIPTransits | Parameter Name | Type | Description | | ------------------- | -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | | iptId | String | IP Transit ID. | | iptName | String | IP Transit name. | | iptDescription | String | IP Transit description. | | dataCenter | [DatacenterInfo](#datacenterinfo) | Data center of the IP Transit. | | peerPortId | String | Connected port ID. | | peerPortName | String | Connected port name. | | peerDataCenter | [DatacenterInfo](#datacenterinfo) | Data center of the port side. | | deliveryType | [IPTransitDeliveryType](#iptransitdeliverytype) | Delivery type. | | resourceGroupId | String | Resource group ID of the IP Transit. | | resourceGroupName | String | Resource group name of the IP Transit. | | createTime | String |

Creation time.

Format: YYYY-MM-ddTHH🇲🇲ssZ.

| | routingType | [IPTransitRouteType](#iptransitroutetype) | Routing type. | | internetType | [InternetType](#internettype) | Bandwidth billing method. | | bandwidth | Integer |

Bandwidth cap.

Unit: Mbps.

| | commitBandwidth | Integer |

Committed bandwidth.

Only available when bandwidth billing method is ByInstanceBandwidth95.

| | bfd | [BFDConfig](#bfdconfig) | BFD configuration. | | bgp | [RiptBgpConfig](#riptbgpconfig) | BGP configurations. | | interconnect | [Interconnect](#interconnect) | Interconnect IP address information. | | privateConnectId | String | Private connect ID associated with the IP Transit. | | privateConnectName | String | Name of the private connect associated with the IP Transit. | | publicIpv4Addresses | Array of [IPAddress](#ipaddress) | Public IP information. | | iptStatus | [IPTransitStatus](#iptransitstatus) | IP Transit state. | | connectivityStatus | [ConnectivityStatus](#connectivitystatus) | Link connectivity status. | | tags | [Tags](#tags) | Tags bound to the IP Transit. | | publicIpAddresses | Array of [IPTransitIpAddress](#iptransitipaddress) | List of public IP addresses. | | haMode | [IPTransitHaMode](#iptransithamode) | HA mode. | | zbgRegionId | String |

ZBG region ID.

Returned for IP Transits in ZBG scenarios.

| | peerPortType | [IPTransitPeerPortType](#iptransitpeerporttype) | Peer port type. | | haLinks | Array of [HaLink](#halink) |

List of HA sub-links.

Null for non-HA mode. Contains two sub-link objects for HA mode.

| ## IPTransitAsnType BGP ASN type. Referenced by：DescribeIPTransitAvailableAsns | Value | Description | | ------- | ------------- | | ASN | A single ASN. | | AS\_SET | AS-SET. | ## IPTransitAvailableRoutingType Available routing type information. Referenced by：DescribeIPTransitDatacenters | Parameter Name | Type | Description | | -------------------------- | ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | routingType | [IPTransitRouteType](#iptransitroutetype) | Routing type. | | availableBgpRouteTypes | Array of [RiptBgpRouteType](#riptbgproutetype) |

List of available BGP route types.

Only available when routingType is BGP.

| | availableBgpTiers | Array of [RiptBgpTier](#riptbgptier) |

Available BGP tiers.

Only available when routingType is BGP.

| | peerAsns | Array of [RiptPeerAsn](#riptpeerasn) |

Zenlayer-side (peer) AS numbers for each BGP tier, used to configure the BGP neighbor on your local router.

Only available when routingType is BGP.

| | deliveryType | [IPTransitDeliveryType](#iptransitdeliverytype) | Delivery type. | | publicInterconnectNetmasks | Array of Integer |

List of available IPv4 public interconnect netmasks.

Currently only 30 / 31 are supported.

| ## IPTransitBgpRouteType BGP inbound route type. Referenced by：ModifyIPTransitConfig | Value | Description | | ---------------------------------- | ------------------------------- | | ALL\_ROUTES | Full routes. | | ALL\_ROUTES\_WITH\_DEFAULT\_ROUTES | All routes with default routes. | | DEFAULT\_ROUTES | Default routes. | ## IPTransitConfigType IP Transit configuration change type. Referenced by：ModifyIPTransitConfig, InquiryModifyIPTransitPrice | Value | Description | | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | | BANDWIDTH | Bandwidth. | | BFD | BFD switch. | | BGP\_ROUTE\_TYPE | BGP route type. | | BGP\_ASN\_AS\_SET | BGP ASN/AS-SET. | | BGP\_PASSWORD | BGP password. | | ADD\_CIDR\_BLOCK |

Add a public IP address block.

Not supported for instances with the Standard BGP tier (bgp.tier=STANDARD).

| | DEL\_CIDR\_BLOCK | Delete a public IP address block. | | EXPAND\_CIDR\_BLOCK | Expand a public IP address block. | | SHRINK\_CIDR\_BLOCK | Shrink a public IP address block. | | HA\_SWITCH\_PRIMARY | HA primary/secondary switchover. | | HA\_SWITCH\_MODE | HA mode switch. | ## IPTransitDatacenter Describes data center information supporting IP Transit, including basic data center information and supported routing types. Referenced by：DescribeIPTransitDatacenters | Parameter Name | Type | Description | | --------------------- | ------------------------------------------------------------------------ | -------------------------------------- | | dataCenter | [DatacenterInfo](#datacenterinfo) | Data center information. | | availableRoutingTypes | Array of [IPTransitAvailableRoutingType](#iptransitavailableroutingtype) | Supported routing type configurations. | ## IPTransitDeliveryType Describes the delivery type enum values. Referenced by：DescribeIPTransitDatacenters, DescribeIPTransits | Value | Description | | ------ | ------------------------------------------------------ | | Auto | Automated delivery (Usually completed within minutes). | | Manual | Manual delivery. (Usually completed within 3 days). | ## IPTransitHaConfig HA configuration information of the IP Transit. Referenced by：InquiryCreateIPTransitPrice, CreateIPTransit | Parameter Name | Type | Required | Description | | ------------------- | ----------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------- | | haMode | [IPTransitHaMode](#iptransithamode) | Yes | HA operating mode. | | secondaryPortId | String | Yes |

Access port ID of the secondary link.

Must be in the same city as but a different data center from the top-level peerPortId.

| | secondaryPortVlanId | Integer | Yes | VLAN ID of the secondary link port. | ## IPTransitHaMode HA mode. Referenced by：InquiryCreateIPTransitPrice, DescribeIPTransits | Value | Description | | --------------- | ------------------------------------------------------------------------------- | | ACTIVE\_STANDBY |

Active/standby mode.

Only the primary link forwards traffic.

| | ACTIVE\_ACTIVE |

Active/active mode.

Both sub-links forward traffic simultaneously.

| ## IPTransitIpAddress Public IP address information of the IP Transit. Referenced by：DescribeIPTransits | Parameter Name | Type | Description | | ---------------- | ------------------------------------------------- | ------------------------------------------------------------------------------------------- | | ipUuid | String |

IP block UUID.

Passed as ipUuid when modifying (expanding/shrinking/deleting).

| | ipAddress | String | IP address (in CIDR notation, e.g., 192.0.2.0/30). | | netmask | Integer | Netmask length. | | gatewayIpAddress | String | Gateway IP. | | ipType | [IPTransitIpType](#iptransitiptype) | IP type (IPV4 / IPV6). | | ipNetworkType | [IPTransitIpNetworkType](#iptransitipnetworktype) | IP network type (BGP\_IP / LOCAL\_IP). | ## IPTransitIpNetworkType IP Transit IP network type. Referenced by：DescribeIPTransitAvailableCidrBlocks, ModifyIPTransitConfig, InquiryCreateIPTransitPrice, InquiryModifyIPTransitPrice, DescribeIPTransits | Value | Description | | --------- | ----------- | | BGP\_IP | Regular IP. | | LOCAL\_IP | Native IP. | ## IPTransitIpPriceItem CIDR block price information. Referenced by：InquiryModifyIPTransitPrice | Parameter Name | Type | Description | | -------------- | ------------------------------------------------- | -------------------------------------- | | price | [PriceItem](#priceitem) | Price information. | | netmask | Integer | CIDR netmask length. | | amount | Integer | Quantity. | | ipNetworkType | [IPTransitIpNetworkType](#iptransitipnetworktype) | IP network type (BGP\_IP / LOCAL\_IP). | ## IPTransitIpRequest Public IP allocation request. Referenced by：InquiryCreateIPTransitPrice, CreateIPTransit | Parameter Name | Type | Required | Description | | -------------- | ------------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------- | | netmask | Integer | Yes |

CIDR netmask length.

Valid IPv4 range: 24-30. Valid IPv6 range: 48-64.

| | ipType | [IPTransitIpType](#iptransitiptype) | Yes | IP type (IPV4 / IPV6). | | ipNetworkType | [IPTransitIpNetworkType](#iptransitipnetworktype) | No |

IP network type.

Default: BGP\_IP (allocated from the IP pool).

LOCAL\_IP indicates a native IP.

| | amount | Integer | No |

Purchase quantity.

Specifies the number of IP blocks with the same netmask length. Default: 1.

| ## IPTransitIpType IP protocol type. Referenced by：InquiryCreateIPTransitPrice, DescribeIPTransits | Value | Description | | ----- | ----------- | | IPV4 | IPv4. | | IPV6 | IPv6. | ## IPTransitPeerPortType Peer port type of the IP Transit. Referenced by：DescribeIPTransits | Value | Description | | --------- | -------------------------- | | PORT | Data center physical port. | | KEY\_PORT | Key Port. | | ZBG | Border gateway (ZBG). | ## IPTransitRouteType Describes the routing type enum values. Referenced by：DescribeIPTransitAvailableCidrBlocks, DescribeIPTransitDatacenters, InquiryCreateIPTransitPrice, DescribeIPTransits, CreateIPTransit | Value | Description | | ------- | -------------------------------------- | | BGP | BGP. (Currently not supported via API) | | Static | Static routing. | | Gateway | Gateway mode. | ## IPTransitStatus Describes the state of an IP Transit. Referenced by：DescribeIPTransits | Value | Description | | ------------------ | ----------------- | | CREATING | Creating. | | UPDATING | Updating. | | DELETING | Deleting. | | DESTROYING | Releasing. | | RECOVERING | Restoring. | | RUNNING | Running. | | RECYCLED | Recycled. | | DESTROYED | Released. | | CREATING\_FAILED | Creating failed. | | UPDATING\_FAILED | Updating failed. | | DELETING\_FAILED | Deleting failed. | | DESTROYING\_FAILED | Releasing failed. | | RECOVERING\_FAILED | Restoring failed. | ## Interconnect Describes IP Transit interconnect IP address information. Referenced by：DescribeIPTransits | Parameter Name | Type | Description | | ------------------- | ------ | ---------------------------------------- | | vendorIpv4Address | String | Vendor-side IPv4 address. | | customerIpv4Address | String | Customer-side IPv4 address. | | vendorIpv6Address | String | Zenlayer-side IPv6 interconnect address. | | customerIpv6Address | String | Customer-side IPv6 interconnect address. | ## InternetType Network billing method. Referenced by：InquiryCreateIPTransitPrice, DescribeIPTransits, CreateIPTransit | Value | Description | | --------------------- | ------------------------------------ | | ByBandwidth | Billed by fixed bandwidth. | | ByInstanceBandwidth95 | Billed by 95th percentile bandwidth. | ## MarketingInfo Describes marketing activity information. Referenced by：ModifyIPTransitConfig, InquiryModifyIPTransitPrice | Parameter Name | Type | Required | Description | | -------------- | ------- | -------- | -------------------------------------------------------------------------------------------------------------------------- | | discountCode | String | No |

Discount code issued by marketing.

If the discount code does not exist, the final discount will not apply.

| | usePocVoucher | Boolean | No |

Whether to use a POC voucher.

If no POC voucher exists in the system, the related creation process will fail.

| ## PriceCategory Describes the price category. Referenced by：InquiryCreateIPTransitPrice | Value | Description | | ---------- | ----------------- | | STANDARD | Standard price. | | CUSTOMIZED | Customized price. | ## PriceItem Describes pricing information. Referenced by：InquiryCreateIPTransitPrice, InquiryModifyIPTransitPrice | Parameter Name | Type | Description | | ----------------------- | -------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | discount | Float |

Discount.

For example, 80.0 means 20% off.

| | discountPrice | Float |

Discount unit price of pay-as-you-go resources.

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

| | originalPrice | Float |

Original price of subscription resources.

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

| | unitPrice | Float |

Original unit price of pay-as-you-go resources.

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

| | discountUnitPrice | Float |

Discount unit price of pay-as-you-go resources.

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

| | chargeUnit | String |

Unit of pay-as-you-go 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 pay-as-you-go billing.

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

| | amountUnit | String |

Usage unit, such as Mbps, LCU, etc.

If null, the value is not available.

| | excessUnitPrice | Float | Original excess unit price. | | excessDiscountUnitPrice | Float | Discounted excess unit price. | | excessAmountUnit | String |

Excess usage unit.

If null, the value is not available.

| | category | [PriceCategory](#pricecategory) | Price category. | ## RiptBgpConfig BGP configurations. Referenced by：DescribeIPTransits, CreateIPTransit | Parameter Name | Type | Required | Description | | -------------- | ------------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | routeType | [RiptBgpRouteType](#riptbgproutetype) | Yes | Inbound route type. | | tier | [RiptBgpTier](#riptbgptier) | No |

BGP tier.

STANDARD: Standard BGP. PREMIUM: Premium BGP.

Defaults to PREMIUM if not specified (consistent with the behavior before the tier split).

| | asn | Integer | No | ASN for announcing outbound routes. | | password | String | No | Authentication key. | | asnList | Array of Integer | No | ASN list for announcing outbound routes. | | asSetList | Array of String | No | AS-SET list for announcing outbound routes. | ## RiptBgpRouteType BGP inbound route type. Referenced by：DescribeIPTransitDatacenters, InquiryCreateIPTransitPrice, CreateIPTransit | Value | Description | | ---------------------------------- | ------------------------------- | | ALL\_ROUTES | Full routes. | | ALL\_ROUTES\_WITH\_DEFAULT\_ROUTES | All routes with default routes. | | DEFAULT\_ROUTES | Default routes. | ## RiptBgpTier IP Transit BGP tier. Referenced by：DescribeIPTransitDatacenters, InquiryCreateIPTransitPrice, CreateIPTransit | Value | Description | | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | STANDARD |

Standard BGP.

Available only in some data centers. It supports fixed bandwidth billing only, and the bandwidth must be one of the fixed tier levels of that data center.

| | PREMIUM |

Premium BGP.

A low-latency line directly connected to the backbone. This is the default tier. Existing instances created before the tier split uniformly return this tier.

| ## RiptPeerAsn Describes the mapping between a BGP tier and the Zenlayer-side (peer) AS number. Referenced by：DescribeIPTransitDatacenters | Parameter Name | Type | Description | | -------------- | --------------------------- | ------------------------------------------------ | | tier | [RiptBgpTier](#riptbgptier) | BGP tier. | | asn | Integer | The Zenlayer-side (peer) AS number of this tier. | ## StepPrice Tiered price of pay-as-you-go billing. Describes a tier of the price. Referenced by：InquiryCreateIPTransitPrice | Parameter Name | Type | Description | | ----------------- | ----- | ------------------------------------------------------------------------------------------ | | stepStart | Float | First price range of a tiered price. | | stepEnd | Float | Last price range of a tiered price. | | unitPrice | Float |

Original unit price of current price range.

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

| | discountUnitPrice | Float |

Discount unit price of current price range.

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

| ## Tag Describes tag key-value pair information. Referenced by：DescribeIPTransits, CreateIPTransit | Parameter Name | Type | Required | Description | | -------------- | ------ | -------- | ------------------------------------------------------- | | key | String | Yes |

Tag key.

Length limit: 1-128 characters.

| | value | String | No |

Tag value.

Length limit: 1-128 characters.

| ## TagAssociation Information on tags bound to resources, including their keys and values. Referenced by：CreateIPTransit | Parameter Name | Type | Required | Description | | -------------- | -------------------- | -------- | ------------------ | | tags | Array of [Tag](#tag) | Yes | List of tag pairs. | ## Tags Describes tag information associated with a resource. Referenced by：DescribeIPTransits | Parameter Name | Type | Description | | -------------- | -------------------- | ------------- | | tags | Array of [Tag](#tag) | List of tags. | ## TrafficData Information on bandwidth. Referenced by：DescribeIPTransitTraffic | Parameter Name | Type | Description | | -------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------- | | internetRX | Integer |

Inbound bandwidth.

Unit: bps.

| | internetTX | Integer |

Outbound bandwidth.

Unit: bps.

| | time | String |

Data time.

Format: YYYY-MM-DDThh🇲🇲ssZ.

| ## TrafficStatistic Statistical method of traffic data. Referenced by：DescribeIPTransitTraffic | Value | Description | | ------- | -------------- | | Average | Average value. | | Maximum | Maximum value. |