API文档>私有网络>公网IP相关>公网IP列表
  • 接口说明
  • 接口调试

公网IP列表

更新时间：2019-08-23 16:37:56

描述

查询用户自己购买的公网 IP 信息，可添加多个查询条件检索IP信息。

请求参数

参数名参数类型是否必填参数说明
Action String 是

操作方法
Region String 是

机房标识，取值参见地域列表
Offset Integer 否

偏移量，默认为0
Count Integer 否

查询数量，默认为全部
Eip.N String 否

公网IP地址，支持批量，N为自然数，格式：&Eip.0=xxx0&Eip.1=xxx1
Name String 否

名称
StartTime String 否

到期开始时间。 格式yyyy-MM-dd HH:mm:ss
EndTime String 否

到期结束时间。 格式yyyy-MM-dd HH:mm:ss
ProductStatus String 否

产品状态，取值范围：

  • NORMAL：正常
  • OVERTIMER：过期
  • ARREARAGE：欠费
PayType String 否

付费类型。取值范围：

  • PREPAID：包年包月

返回参数

名称 类型 说明
Action String 执行的操作
TaskId String 请求标识
EipSet EipItemType 由EipItemType组成的数组格式，返回公网IP信息
EipUsed Integer 已使用的IP数量

EipItemType 节点

公网IP信息的数据类型

名称 类型 说明
Id String 公网IP标识
Eip String 公网IP地址
Name String 名称
Bandwidth String 带宽
DeviceId String 设备ID
DeviceType String 设备类型，INSTANCE：云主机；ROUTER：路由器；LOADBALANCE：负载均衡器；IRONIC：裸机
DeviceName String 设备名称
Remark String 备注
ProductStatus String 产品状态，NORMAL：正常；OVERTIMER：过期；ARREARAGE：欠费
PayType String 支付类型，ONDEMAND：按量付费；PREPAID：包年包月；PROBATION：试用
CreateTime DateTime 创建时间
AllocateTime DateTime 购买时间
DueTime DateTime 到期时间
CloseTime DateTime 关闭时间
Type String 是否为主ip MASTER主ip, SLAVE 附属ip
RouterId String 路由器ID
BandwidthInfo BandwidthInfo IP所属的带宽信息

BandwidthInfo节点

IP所属的带宽信息

名称 类型 说明
Id String 宽带ID
Bandwidth integer IP带宽大小，单位：Mbps
PayType String 带宽支付类型 ONDEMAND：按量付费；PREPAID：包年包月；PROBATION 试用；DISCHARGE 按量计费
DueTime DateTime 带宽到期时间
ProductType String 线路类型 线路类型 ChinaTelecom(中国电信)，BGP，ChinaUnicom（中国联通），ChinaMobile（中国移动），Oversea（海外）
ChangedTime String 变更时间
CloseTime String 关闭时间
IpGroupId String 共享带宽IP组ID
IsCommonBandwidth Integer 是否共享带宽 0 否 1 是
CreateTime DateTime 带宽创建时间
UpdateTime DateTime 带宽更新时间

请求示例

https://api.chinac.com/v2/?Action=DescribeEips
&Region=cn-wuxi1
&<公共请求参数>

返回示例

{
    "code": 10000,
    "message": "",
    "data": {
        "TaskId": "mirrorx1311520170510090017634",
        "Action": "DescribeEips",
        "TotalCount": 3,
        "EipSet": [{
            "Id": "eip-1r9ih49e69589",
            "Eip": "172.16.29.83",
            "Status": "ASSIGNED",
            "Bandwidth": "3",
            "DeviceId": "i-719ih49e6c9p",
            "DeviceType": "INSTANCE",
            "NetworkId": "n-sssssflat",
            "SubnetId": "s-qwertyasdjkl",
            "UseReason": "CUSTOMER",
            "Remark": null,
            "Name": null,
            "DueTime": "2017-05-12T14:06:45 +0800",
            "CloseTime": "2017-05-12T15:06:45 +0800",
            "ProductStatus": "NORMAL",
            "SubnetName": "subnet-flat",
            "PayType": "PROBATION",
            "DeviceName": "cec1705099hXP",
            "CreateTime": "2017-02-08T11:36:19 +0800",
            "AllocateTime": "2017-05-09T14:06:45 +0800",
            "IsPublic": "0",
            "UserId": "18359229"
        }, {
            "Id": "eip-gz9ih3jj93187",
            "Eip": "172.16.29.47",
            "Status": "IDLE",
            "Bandwidth": "3",
            "DeviceId": null,
            "DeviceType": null,
            "NetworkId": "n-sssssflat",
            "SubnetId": "s-qwertyasdjkl",
            "UseReason": "CUSTOMER",
            "Remark": null,
            "Name": null,
            "DueTime": "2017-05-19T19:09:01 +0800",
            "CloseTime": "2017-05-19T19:09:01 +0800",
            "ProductStatus": "NORMAL",
            "SubnetName": "subnet-flat",
            "PayType": "PREPAID",
            "DeviceName": null,
            "CreateTime": "2017-02-08T11:36:18 +0800",
            "AllocateTime": "2017-04-19T19:09:01 +0800",
            "IsPublic": "0",
            "UserId": "18359229"
        }],
        "EipUsed": 1
    }
}
*
*