API文档>私有网络>共享宽带相关>查询共享宽带列表
  • 接口说明
  • 接口调试

查询共享宽带列表

更新时间：2019-08-23 13:51:33

描述

查询共享宽带信息，可根据查询条件检索到多条记录。

请求参数

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

机房标识，取值参见地域列表
Action String 是

操作方法
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 支付类型 ONDEMAND：按量付费；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.chinac.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"
            }]
        }]
    }
}
*
*