DescribeEips

DescribeEips

1. 接口描述

本接口用于查询一台或多台指定EIP的信息。用户可以根据 EIP ID、EIP 名称等信息来搜索EIP信息

2. 请求参数

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

参数名称
必选
类型
描述

eipIds

Array of String

一个或多个待操作的EIP ID

regionId

String

节点ID

name

String

EIP的名称 支持模糊查询

status

String

isDefault

Boolean

EIP是否默认

pageSize

Integer

返回的分页大小。

默认为20,最大为1000。

pageNum

Integer

返回的分页数。

默认为1。

3. 响应结果

参数名称
类型
描述

requestId

String

唯一请求 ID。

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

dataSet

Array of EipInfo

EipInfo结果集

totalCount

Integer

符合条件的数据总数

4. 代码示例

1. 分页查询EIP列表

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

Request:
{
  "eipIds": ["xxx"],
  "regionId": "asia-east-1",
  "pageSize": 10,
  "pageNum": 1
}

Response:
{
  "requestId": "TBFC01FCF-6439-4530-ADBC-16809F0C3E8F",
  "response": {
    "requestId": "TBFC01FCF-6439-4530-ADBC-16809F0C3E8F",
    "totalCount": 10,
    "dataSet": [
      {
        "eipId": "xxx",
        "name": "xxx",
        "regionId": "xxx",
        "isDefault": true,
        "status": "BINDED",
        "eipNetworkType""BGP_LINE",
        "internetChargeType": "PackageBandwidth",
        "nicId": "xxx",
        "flowPackage": 1,
        "bandwidth": 2,
        "createTime": "xxx",
        "expiredTime": "xxx",
        "resourceGroupId": "xxx",
        "resourceGroupName": "xxx"
      }
    ]
  }
}

5. 开发者工具

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

6. 错误码

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

最后更新于