查詢共享寬頻列表

描述

查詢共享寬頻資訊，可根據查詢條件檢索到多條記錄。

請求引數

引數名	引數型別	是否必填	引數說明
Region	String	是	機房標識，取值參見地域列表
Action	String	是	操作方法：ListCommonBandwidth
Id.N	String	否	共享寬頻Id，支援多個查詢，如Id.0=aa&Id.1=bb
Name.N	String	否	共享寬頻名稱，支援多個查詢，如Name.0=aa&Name.1=bb
Eip	String	否	IP地址
BeginTime	String	否	開始時間 格式yyyy-MM-dd HH:mm:ss
EndTime	String	否	結束時間 格式yyyy-MM-dd HH:mm:ss
ProductType	String	否	線路網路型別
ProductStatus	String	否	產品狀態，取值範圍： NORMAL：正常 OVERTIMER：過期 ARREARAGE：欠費
PayType	String	否	付費型別，取值範圍： PREPAID：包年包月 PROBATION：試用
Offset	Integer	否	記錄偏移量，不指定取0
Count	Integer	否	記錄數量，不指定為全部

返回引數

名稱	型別	說明
Action	String	執行的操作
TaskId	String	請求標識
TotalCount	Integer	過濾條件下總共記錄數
CommonBandwidth	CommonBandwidth	由CommonBandwidth組成的陣列格式，返回共享寬頻的資訊

CommonBandwidth

共享寬頻資訊的資料型別

名稱	型別	說明
Id	String	共享寬頻標識
Name	String	名稱
ProductModelId	integer	型號ID
ProductType	string	網路型別
ProductStatus	String	產品狀態。取值範圍：NORMAL-正常; OVERTIMER-過期; ARREARAGE-欠費
BandwidthSize	integer	寬頻大小
PayType	String	支付型別 PREPAID：包年包月
Remark	String	描述
BandwidthSize	integer	寬頻大小
CreateTime	integer	建立時間，時間戳
UpdateTime	integer	更新時間，時間戳
DueTime	integer	到期時間，時間戳
CloseTime	integer	關閉時間，時間戳
ChangedTime	integer	變更時間，時間戳
IsCommonBandwidth	integer	是否共享寬頻，目前是1
EipList	EipList	由EipList組成的陣列格式，返回加入共享寬頻的IP資訊

EipList

入共享寬頻的IP資訊

名稱	型別	說明
Id	String	IP的ID
IpAddress	String	IP地址
ProductModelId	integer	IP型號ID
ProductType	string	IP網路型別
CreateTime	integer	建立時間，時間戳
UpdateTime	integer	更新時間，時間戳
DueTime	integer	到期時間，時間戳
AllocateTime	integer	分配時間，時間戳
DeviceId	string	公網ID繫結的裝置ID
DeviceType	string	公網ID繫結的裝置型別，INSTANCE：雲主機；ROUTER：路由器；LOADBALANCE：負載均衡器；IRONIC：裸機
DeviceId	string	IP所屬的路由器ID

請求示例

https://api.yunpanel.com/v2/?Action=ListCommonBandwidth
&Region=cn-wuxi
&Id.0=xxx
&<公共請求引數>

返回示例

{
    "code": 10000,
    "message": "",
    "data": {
        "TaskId": "yvk7320190823131446315",
        "Action": "ListCommonBandwidth",
        "TotalCount": 1,
        "CommonBandwidth": [{
            "Id": "b-tq73j7la0719f",
            "Name": "csbw-nc73j7la0719e",
            "ProductModelId": 802021,
            "ProductType": "ChinaTelecom",
            "ProductStatus": "NORMAL",
            "BandwidthSize": 20,
            "PayType": "PREPAID",
            "Remark": "aaa",
            "CreateTime": 1566355003000,
            "UpdateTime": 1566355995000,
            "DueTime": 1569292603000,
            "CloseTime": 1569296203000,
            "ChangedTime": 1569296203000,
            "IsCommonBandwidth": 1,
            "EipList": [{
                "Id": "eip-ne73j7la048",
                 "IpAddress": "30.30.17.63",
                 "ProductModelId": 179,
                 "ProductType": "ChinaTelecom",
                 "ProductStatus": "NORMAL",
                 "PayType": "PREPAID",
                 "Type": "MASTER",
                 "CreateTime": 1562730328000,
                 "UpdateTime": 1566355995000,
                 "DueTime": 1569292564000,
                 "AllocateTime": 1566354964000,
                 "DeviceId": "i-rq73j7la0782z",
                 "DeviceType": "INSTANCE",
                 "RouterId": "r-2073j6age842t"
            }, {
                "Id": "eip-ne73j7la048",
                 "IpAddress": "30.30.17.63",
                 "ProductModelId": 179,
                 "ProductType": "ChinaTelecom",
                 "ProductStatus": "NORMAL",
                 "PayType": "PREPAID",
                 "Type": "MASTER",
                 "CreateTime": 1562730328000,
                 "UpdateTime": 1566355995000,
                 "DueTime": 1569292564000,
                 "AllocateTime": 1566354964000,
                 "DeviceId": "i-rq73j7la0782z",
                 "DeviceType": "INSTANCE",
                 "RouterId": "r-2073j6age842t"
            }]
        }]
    }
}