API文档>私有网络>路由器相关>查询路由器信息
  • 接口说明
  • 接口调试

查询路由器信息

更新时间：2019-06-04 14:33:03

查询路由器信息。

请求参数

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

操作方法
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 否

产品状态:

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

付费类型,取值范围：

  • PREPAID:包年包月
  • PROBATION:试用

返回参数

名称 类型 说明
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 支付类型 ONDEMAND：按量付费；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 支付类型 ONDEMAND：按量付费；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.chinac.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"
        }]
    }
}
*
*