查询弹性公网IP列表

最近更新时间:2017-12-18 15:10:56

1. 接口描述

域名: eip.api.qcloud.com
接口名: DescribeEip

查询弹性公网IP。

2. 输入参数

参数名称 必选 类型 描述
eipIds.n String EIP实例ID列表,列表下标从0开始
eips.n String EIP列表,列表下标从0开始
unInstanceIds.n String 服务器实例ID列表,列表下标从0开始,可通过DescribeInstances接口返回字段中的unInstanceId获取
networkInterfaceIds.n String 弹性网卡唯一ID列表,列表下标从0开始,可通过DescribeNetworkInterfaces接口返回字段中的networkInterfaceId获取
privateIpAddress String 服务器内网IP
searchKey String EIP实例名称,模糊匹配
status.n Int 状态列表,列表下标从0开始
0:创建中; 1:绑定中; 2:已绑定; 3:解绑中; 4:未绑定; 6:下线中; 9:创建失败
type Int 0:CVM;1:NAT网关
limit Int 返回EIP数量,默认 20, 最大值 100
offset Int 偏移量,默认为0
orderBy String 排序字段,支持: eipId, eip, ispId, status, unInstanceId, arrears, createdAt
orderType Int 1倒序,0顺序,默认倒序

查询接口中单次查询一般都有一个默认最大返回记录数,要遍历所有资源,需要使用 limit,offset进行分页查询;比如我想查询第110~149 这40条记录,则可以设置 offset=110,limit=40。

3. 输出参数

参数名称 类型 描述
code Int 公共错误码。0表示成功,其他值表示失败。详见错误码页面的公共错误码
message String 模块错误信息描述,与接口相关。详见错误码页面的模块错误码
totalCount Int 返回符合过滤条件的EIP数量;假如指定limit,offset,该值有可能大于data列表中的数量
data Array 返回列表

Data结构

参数名称 类型 描述
data.eipSet Array 返回EIP信息列表
data.eipSet.eipId String EIP实例ID
data.eipSet.eipName String EIP名称
data.eipSet.eip String EIP地址
data.eipSet.ispId Int 运营商ID
0:电信; 1:联通; 2:移动; 3:教育网; 4:盈科; 5:BGP; 6:香港
data.eipSet.status Int 状态
0:创建中; 1:绑定中; 2:已绑定; 3:解绑中; 4:未绑定; 6:下线中; 9:创建失败
data.eipSet.type Int 类型
0:CVM; 1:NAT网关
data.eipSet.arrears Int 是否欠费隔离
1: 欠费隔离; 0: 正常。处在欠费隔离情况下的EIP不能进行任何管理操作。
data.eipSet.unInstanceId String EIP所绑定的服务器实例ID,未绑定则为空
data.eipSet.networkInterfaceId String 弹性网卡唯一ID
data.eipSet.privateIpAddress String 服务器内网IP
data.eipSet.createdAt String 创建时间
data.eipSet.updatedAt String 更新时间
data.eipSet.freeSecond Int EIP未绑定服务器时长(单位:秒)

4. 示例

输入


  https://eip.api.qcloud.com/v2/index.php?
  &<公共请求参数>

输出


{
    "code": 0,
    "message": "",
    "codeDesc": "Success",
    "data": {
        "eipSet": [
            {
                "eipId": "eip-co9m2t7k",
                "eipName": "",
                "eip": "119.29.239.140",
                "ispId": 5,
                "status": 2,
                "arrears": 0,
                "unInstanceId": "ins-pjrzryru",
                "createdAt": "2016-07-11 21:23:35",
                "updatedAt": "2016-07-11 21:23:35",
                "freeSecond": 0,
                "type": 0,
                "privateIpAddress": "10.104.211.58",
                "networkInterfaceId": ""
            }
        ]
    },
    "totalCount": 1
}