查詢路由器資訊
查詢路由器資訊。
請求引數
引數名 | 引數型別 | 是否必填 | 引數說明 |
---|---|---|---|
Action | String | 是 | 操作方法:DescribeRouters |
Region | String | 是 | 機房標識,取值參見地域列表 |
Offset | String | 否 | 記錄偏移量,不指定取 0 |
Count | String | 否 | 記錄數量,不指定為全部 |
Id.N | String | 否 | 路由器 ID,支援多個查詢,如Id.0=aa&Id.1=bb |
Name.N | String | 否 | 路由器名稱,支援多個查詢,如Name.0=aa&Name.1=bb |
Eip | String | 否 | 路由器外部 IP 地址 |
StartTime | String | 否 | 到期開始時間 格式yyyy-MM-dd HH:mm:ss |
EndTime | String | 否 | 到期結束時間 格式yyyy-MM-dd HH:mm:ss |
ProductStatus | String | 否 | 產品狀態: |
PayType | String | 否 | 付費型別,取值範圍: |
返回引數
名稱 | 型別 | 說明 |
---|---|---|
Action | String | 執行的操作 |
TaskId | String | 請求標識 |
TotalCount | Integer | 過濾條件下總共記錄數 |
RouterSet | RouterItemType | 由RouterItemType組成的陣列格式,返回例項資訊 |
RouterItemType
名稱 | 型別 | 說明 |
---|---|---|
Id | String | 路由器 ID |
Name | String | 名稱 |
Description | String | 描述 |
Firewall | String | 防火牆 |
FirewallName | String | 防火牆名稱 |
Status | String | 狀態 |
Eip | String | 繫結在路由器上的外部 IP 地址 |
CreateTime | DateTime | 建立時間 |
DueTime | DateTime | 到期時間 |
CloseTime | DateTime | 關閉時間 |
PayType | String | 支付型別 PREPAID:包年包月;PROBATION 試用。 |
ProductStatus | String | 產品狀態,正常:NORMAL 過期:OVERTIMER 欠費:ARREARAGE |
InterfaceSet | InterfaceItemType | 由InterfaceItemType組成的陣列格式,返回網絡卡資訊 |
EipAssociationSet | EipItemType | 外部 IP 關聯列表,描述外部 IP 地址和私有網路 IP 地址的關聯資訊。 |
UserId | String | 所屬使用者ID |
Locked | Boolean | 是否鎖定 |
InterfaceItemType
名稱 | 型別 | 說明 |
---|---|---|
Id | String | 路由器 ID |
Name | String | 名稱 |
Description | String | 描述 |
Firewall | String | 防火牆 |
FirewallName | String | 防火牆名稱 |
Status | String | 狀態 |
Eip | String | 繫結在路由器上的外部 IP 地址 |
CreateTime | DateTime | 建立時間 |
DueTime | DateTime | 到期時間 |
CloseTime | DateTime | 關閉時間 |
PayType | String | 支付型別 PREPAID:包年包月;PROBATION 試用。 |
ProductStatus | String | 產品狀態,正常:NORMAL 過期:OVERTIMER 欠費:ARREARAGE |
InterfaceSet | RouterInterfaceItemType | 私有網路網絡卡資訊列表 |
EipAssociationSet | EipItemType | 外部 IP 關聯列表,描述外部 IP 地址和私有網路 IP 地址的關聯資訊。 |
UserId | String | 所屬使用者ID |
Locked | Boolean | 是否鎖定 |
RouterInterfaceItemType
名稱 | 型別 | 說明 |
---|---|---|
Id | String | 網絡卡標識 |
RouterId | String | 路由器 ID |
NetworkId | String | 私有網路 ID |
SubnetId | String | 私有網路子網 ID |
Cidr | String | 私有網路CIDR +1.1.2 |
MacAddress | String | MAC 地址 |
IpAddress | String | 私有網路 IP 地址 |
Status | String | 狀態 |
UserId | String | 所屬使用者 |
EipItemType
名稱 | 型別 | 說明 |
---|---|---|
Id | String | 關聯 ID |
Eip | String | 外部 IP 地址 |
DeviceId | String | 裝置ID |
RouterId | String | 路由器 ID |
LocalIpAddress | String | 私有網路 IP 地址 |
LocalNetworkId | String | 私有網路 ID |
Uuid | String | FloatingIP 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"
}]
}
}