> 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/networking/ipt/datastructure.md). # Data Types ## BFDConfig BFD configuration. Referenced by：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]

| ## 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. | ## 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. | ## 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:mm: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. | | tags | [Tags](#tags) | Tags bound to the IP Transit. | ## 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 [RemoteIptAvailableRoutingType](#remoteiptavailableroutingtype) | 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). | ## IPTransitRouteType Describes the routing type enum values. Referenced by：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. | ## InternetType Network billing method. Referenced by：InquiryCreateIPTransitPrice, DescribeIPTransits, CreateIPTransit | Value | Description | | --------------------- | ------------------------------------ | | ByBandwidth | Billed by fixed bandwidth. | | ByInstanceBandwidth95 | Billed by 95th percentile bandwidth. | ## PriceCategory Describes the price category. Referenced by：InquiryCreateIPTransitPrice | Value | Description | | ---------- | ----------------- | | STANDARD | Standard price. | | CUSTOMIZED | Customized price. | ## PriceItem Describes pricing information. Referenced by：InquiryCreateIPTransitPrice | 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. | ## RemoteIptAvailableRoutingType Available routing type information. Referenced by：DescribeIPTransitDatacenters | Parameter Name | Type | Description | | -------------- | ----------------------------------------------- | -------------- | | routingType | [IPTransitRouteType](#iptransitroutetype) | Routing type. | | deliveryType | [IPTransitDeliveryType](#iptransitdeliverytype) | Delivery type. | ## RiptBgpConfig BGP configurations. Referenced by：DescribeIPTransits, CreateIPTransit | Parameter Name | Type | Required | Description | | -------------- | ------------------------------------- | -------- | ------------------------------------------- | | routeType | [RiptBgpRouteType](#riptbgproutetype) | No | Inbound route type. | | 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：InquiryCreateIPTransitPrice, CreateIPTransit | Value | Description | | ---------------------------------- | ------------------------------- | | ALL\_ROUTES | Full routes. | | ALL\_ROUTES\_WITH\_DEFAULT\_ROUTES | All routes with default routes. | | DEFAULT\_ROUTES | Default routes. | ## 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:mm:ssZ.

| --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.console.zenlayer.com/api-reference/networking/ipt/datastructure.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.