DescribeIPTransits

1. 接口描述

本接口用于查询IP Transit资源列表。

2. 请求参数

以下请求参数列表仅列出了接口中需要的请求参数

参数名称

是否必选

类型

描述

iptIds

否

Array of String

IP Transit ID列表。

最大支持长度为100。

iptDcId

否

String

数据中心ID。

具体取值可通过调用接口DescribeDataCenters来获得最新的数据中心列表。

iptName

否

String

IPT 名称。支持模糊搜索。

peerPortId

否

String

端口ID。通过该字段可以筛选与指定端口有关的IP Transit。

resourceGroupId

否

String

资源组ID。

pageNum

否

Integer

返回的分页数。

默认为1。

pageSize

否

Integer

返回的分页大小。默认为20，最大为1000。

3. 响应结果

参数名称

类型

描述

requestId

String

唯一请求 ID。

每次请求都会返回。定位问题时需要提供该次请求的 requestId。

totalCount

Integer

符合条件的数据总数。

dataSet

Array of IPTransit

IP Transit列表结果集。

4. 代码示例

1.查询IP Transit 列表

POST /api/v2/ipt HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: DescribeIPTransits
<Common Request Params>

Request: 
{
    "iptIds": ["1218415745478697618"]
}

Response: 

{
    "requestId": "TEC2801F6-9FB4-4DE2-8BCD-1C59655495C5",
    "response": {
        "requestId": "TEC2801F6-9FB4-4DE2-8BCD-1C59655495C5",
        "totalCount": 1,
        "dataSet": [
            {
                "iptId": "the-ipt-id",
                "bfd": {
                    "bfdRxInterval": 100,
                    "bfdTxInterval": 100,
                    "bfdMultiplier": 10
                },
                "resourceGroupName": "Default Resource Group",
                "dataCenter": {
                    "dcId": "822b9bd9-44f0-4279-a64d-568f5bc4a77b",
                    "cityName": "Amsterdam",
                    "areaName": "Europe",
                    "dcName": "Equinix AM3",
                    "latitude": 52.35501600,
                    "dcAddress": "Science Park 610, 1098 XH Amsterdam, Netherlands",
                    "countryName": "Netherlands",
                    "longitude": 4.96093800
                },
                "bandwidth": 50,
                "iptStatus": "CREATING",
                "iptDescription": "test_ipt_desc",
                "privateConnectName": "PrivateConnect-Los Angeles-Amsterdam",
                "deliveryType": "Manual",
                "chargeType": "POSTPAID",
                "peerPortName": "MIA1-10G",
                "bgp": null,
                "iptName": "MIA1-10G",
                "peerPortId": "your-port-id",
                "interconnect": {
                    "customerIpv4Address": null,
                    "vendorIpv4Address": null
                },
                "peerDataCenter": {
                    "dcId": "40eb37d8-0f65-4108-bd2c-a2577498f6eb",
                    "cityName": "Los Angeles",
                    "areaName": "North America",
                    "dcName": "Coresite LA2",
                    "latitude": 34.05829500,
                    "dcAddress": "900 Alameda St., Suite 200 Los Angeles, CA 90012",
                    "countryName": "United States",
                    "longitude": -118.23467300
                },
                "createTime": "2024-01-01T00:00:00Z",
                "routingType": "Static",
                "commitBandwidth": null,
                "resourceGroupId": "5a4f6519-2977-47cb-b3fc-150fd2b4de71",
                "internetType": "ByBandwidth",
                "privateConnectId": "your-private-connect-id",
                "publicIpv4Addresses": [
                    {
                        "netmask": 25,
                        "gatewayIpAddress": null,
                        "ipAddress": null
                    }
                ]
            }
        ]
    }
}

5. 开发者工具

Zenlayer Cloud API 2.0 提供了配套的开发工具集（SDK），未来会陆续支持更多开发语言，方便快速接入和使用Zenlayer的产品和服务。

6. 错误码

下面包含业务逻辑中遇到的错误码，其他错误码见公共错误码

HTTP状态码

错误码

说明

端口未找到。

最后更新于6个月前