查询指定地域已创建的EIP

查询指定地域已创建的EIP。调用此接口可查询指定地域已创建的弹性公网IP（Elastic IP Address，简称EIP）。

请求参数

Body 参数application/json

regionID

string

资源池ID

必需

clientToken

string

可选

客户端存根，用于保证订单幂等性。要求单个云平台账户内唯一（实际用不到）

projectID

string

可选

企业项目 ID，默认为"0"

page

integer <int32>

分页参数

可选

pageSize

integer <int32>

可选

每页数据量大小，取值 1-50

ids

array[string]

可选

是 Array 类型，里面的内容是 String

ipType

string

可选

ip类型 ipv4 / ipv6

eipType

string

可选

eip类型 normal(非cn2的所有eip)/cn2（资源池支持的枚举值可通过/v4/eip/EIPGroup/findEIPName/接口查询）

status

string

可选

绑定网卡状态 DOWN 未绑定, ACTIVE 绑定

resourceId

string

可选

资源id(差异点说明：2.0该参数为eip绑定资源的id，同时公有云文档无此参数)

示例

{
    "clientToken": "",
    "regionID": "TestRegionID"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

currentCount

integer <int32>

当前页个数

必需

description

string

失败时的错误描述

必需

errorCode

string

具体错误码标志

必需

message

string

失败时的错误信息

必需

returnObj

object

返回参数

必需

eips

array [object {14}]

eip列表

必需

statusCode

integer <int32>

必需

返回状态码(800为成功，900为失败)

totalCount

integer <int32>

总数量

必需

totalPage

integer <int32>

总页数

必需

示例

{
    "currentCount": 1,
    "description": "成功",
    "errorCode": "SUCCESS",
    "message": "success",
    "returnObj": {
        "eips": [
            {
                "ID": "eip-mkn8xmxejh",
                "associationID": "natgw-n568kypw2g",
                "associationType": "NAT",
                "bandwidth": 10,
                "createdAt": "2023-07-28T07:03:31Z",
                "description": null,
                "eipAddress": "100.124.4.3",
                "expiredAt": null,
                "name": "eip-100.124.4.3",
                "privateIpAddress": null,
                "resourceId": "6c2e1f27e8cf4bc6b9b40e9ef02e83e7",
                "status": "ACTIVE",
                "tags": null,
                "updatedAt": "2023-08-29T07:38:12Z"
            }
        ]
    },
    "statusCode": 800,
    "totalCount": 1,
    "totalPage": 1
}