跳到主要内容

查詢路由器資訊

查詢路由器資訊。

請求引數

引數名引數型別是否必填引數說明
ActionString操作方法:DescribeRouters
RegionString機房標識,取值參見地域列表
OffsetString記錄偏移量,不指定取 0
CountString記錄數量,不指定為全部
Id.NString路由器 ID,支援多個查詢,如Id.0=aa&Id.1=bb
Name.NString路由器名稱,支援多個查詢,如Name.0=aa&Name.1=bb
EipString路由器外部 IP 地址
StartTimeString到期開始時間 格式yyyy-MM-dd HH:mm:ss
EndTimeString到期結束時間 格式yyyy-MM-dd HH:mm:ss
ProductStatusString產品狀態:
  • NORMAL:正常
  • OVERTIMER:過期
  • ARREARAGE:欠費
  • PayTypeString付費型別,取值範圍:
  • PREPAID:包年包月
  • PROBATION:試用
  • 返回引數

    名稱型別說明
    ActionString執行的操作
    TaskIdString請求標識
    TotalCountInteger過濾條件下總共記錄數
    RouterSetRouterItemType由RouterItemType組成的陣列格式,返回例項資訊

    RouterItemType

    名稱型別說明
    IdString路由器 ID
    NameString名稱
    DescriptionString描述
    FirewallString防火牆
    FirewallNameString防火牆名稱
    StatusString狀態
    EipString繫結在路由器上的外部 IP 地址
    CreateTimeDateTime建立時間
    DueTimeDateTime到期時間
    CloseTimeDateTime關閉時間
    PayTypeString支付型別 PREPAID:包年包月;PROBATION 試用。
    ProductStatusString產品狀態,正常:NORMAL 過期:OVERTIMER 欠費:ARREARAGE
    InterfaceSetInterfaceItemType由InterfaceItemType組成的陣列格式,返回網絡卡資訊
    EipAssociationSetEipItemType外部 IP 關聯列表,描述外部 IP 地址和私有網路 IP 地址的關聯資訊。
    UserIdString所屬使用者ID
    LockedBoolean是否鎖定

    InterfaceItemType

    名稱型別說明
    IdString路由器 ID
    NameString名稱
    DescriptionString描述
    FirewallString防火牆
    FirewallNameString防火牆名稱
    StatusString狀態
    EipString繫結在路由器上的外部 IP 地址
    CreateTimeDateTime建立時間
    DueTimeDateTime到期時間
    CloseTimeDateTime關閉時間
    PayTypeString支付型別 PREPAID:包年包月;PROBATION 試用。
    ProductStatusString產品狀態,正常:NORMAL 過期:OVERTIMER 欠費:ARREARAGE
    InterfaceSetRouterInterfaceItemType私有網路網絡卡資訊列表
    EipAssociationSetEipItemType外部 IP 關聯列表,描述外部 IP 地址和私有網路 IP 地址的關聯資訊。
    UserIdString所屬使用者ID
    LockedBoolean是否鎖定

    RouterInterfaceItemType

    名稱型別說明
    IdString網絡卡標識
    RouterIdString路由器 ID
    NetworkIdString私有網路 ID
    SubnetIdString私有網路子網 ID
    CidrString私有網路CIDR +1.1.2
    MacAddressStringMAC 地址
    IpAddressString私有網路 IP 地址
    StatusString狀態
    UserIdString所屬使用者

    EipItemType

    名稱型別說明
    IdString關聯 ID
    EipString外部 IP 地址
    DeviceIdString裝置ID
    RouterIdString路由器 ID
    LocalIpAddressString私有網路 IP 地址
    LocalNetworkIdString私有網路 ID
    UuidStringFloatingIP UUID

    請求示例

    https://api.yunpanel.com/v2/?Action=DescribeRouters&Region=cn-wuxi1

    返回示例

    {
    "code": 10000,
    "message": "",
    "data": {
    "TaskId": "98k11520170510153918782",
    "Action": "DescribeRouters",
    "TotalCount": 2,
    "RouterSet": [{
    "Id": "r-2n9ih46fys84f",
    "Uuid": "a231050e-b184-4eb6-810c-4d061e71ad4b",
    "Name": "tet33",
    "Description": null,
    "Firewall": "f-1r9ih3ke3g112",
    "Status": "ENABLED",
    "Eip": null,
    "CreateTime": "2017-05-06T15:34:28 +0800",
    "UseType": "CUSTOMER",
    "DueTime": "2017-05-09T15:34:28 +0800",
    "CloseTime": "2017-05-09T16:34:28 +0800",
    "ProductStatus": "OVERTIMER",
    "PayType": "PROBATION",
    "UserId": "18359229",
    "InterfaceSet": [],
    "IdLong": "r-2n9ih46fys84f-a231050e-b184-4eb6-810c-4d061e71ad4b"
    },
    {
    "Id": "r-vd9ih46dmt2p",
    "Uuid": "bf53cf6e-50e3-4b8c-a3e9-b87b4aa09e71",
    "Name": "test",
    "Description": null,
    "Firewall": "f-1r9ih3ke3g112",
    "Status": "ENABLED",
    "Eip": null,
    "CreateTime": "2017-05-06T13:58:29 +0800",
    "UseType": "CUSTOMER",
    "DueTime": "2017-05-09T13:58:29 +0800",
    "CloseTime": "2017-05-09T14:58:29 +0800",
    "ProductStatus": "OVERTIMER",
    "PayType": "PROBATION",
    "UserId": "18359229",
    "InterfaceSet": [],
    "IdLong": "r-vd9ih46dmt2p-bf53cf6e-50e3-4b8c-a3e9-b87b4aa09e71"
    }]
    }
    }