查詢公網IP列表

描述

查詢使用者自己購買的公網 IP 資訊，可新增多個查詢條件檢索IP資訊。

請求引數

引數名	引數型別	是否必填	引數說明
Action	String	是	操作方法：DescribeEips
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	支付型別，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	頻寬支付型別 PREPAID：包年包月
DueTime	DateTime	頻寬到期時間
ProductType	String	線路型別 線路型別 Oversea（海外）HKBGP（香港BGP）
ChangedTime	String	變更時間
CloseTime	String	關閉時間
IpGroupId	String	共享頻寬IP組ID
IsCommonBandwidth	Integer	是否共享頻寬 0 否 1 是
CreateTime	DateTime	頻寬建立時間
UpdateTime	DateTime	頻寬更新時間

請求示例

https://api.yunpanel.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
    }
}