跳到主要内容

查询共享宽带列表

描述

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

请求参数

参数名参数类型是否必填参数说明
RegionString机房标识,取值参见地域列表
ActionString操作方法:ListCommonBandwidth
Id.NString共享宽带Id,支持多个查询,如Id.0=aa&Id.1=bb
Name.NString共享宽带名称,支持多个查询,如Name.0=aa&Name.1=bb
EipStringIP地址
BeginTimeString开始时间 格式yyyy-MM-dd HH:mm:ss
EndTimeString结束时间 格式yyyy-MM-dd HH:mm:ss
ProductTypeString线路网络类型
ProductStatusString产品状态,取值范围:
  • NORMAL:正常
  • OVERTIMER:过期
  • ARREARAGE:欠费
  • PayTypeString付费类型,取值范围:
  • PREPAID:包年包月
  • PROBATION:试用
  • OffsetInteger记录偏移量,不指定取0
    CountInteger记录数量,不指定为全部

    返回参数

    名称类型说明
    ActionString执行的操作
    TaskIdString请求标识
    TotalCountInteger过滤条件下总共记录数
    CommonBandwidthCommonBandwidth由CommonBandwidth组成的数组格式,返回共享宽带的信息

    CommonBandwidth

    共享宽带信息的数据类型

    名称类型说明
    IdString共享宽带标识
    NameString名称
    ProductModelIdinteger型号ID
    ProductTypestring网络类型
    ProductStatusString产品状态。取值范围:NORMAL-正常; OVERTIMER-过期; ARREARAGE-欠费
    BandwidthSizeinteger宽带大小
    PayTypeString支付类型 ONDEMAND:按量付费;PREPAID:包年包月
    RemarkString描述
    BandwidthSizeinteger宽带大小
    CreateTimeinteger创建时间,时间戳
    UpdateTimeinteger更新时间,时间戳
    DueTimeinteger到期时间,时间戳
    CloseTimeinteger关闭时间,时间戳
    ChangedTimeinteger变更时间,时间戳
    IsCommonBandwidthinteger是否共享宽带,目前是1
    EipListEipList由EipList组成的数组格式,返回加入共享宽带的IP信息

    EipList

    入共享宽带的IP信息

    名称类型说明
    IdStringIP的ID
    IpAddressStringIP地址
    ProductModelIdintegerIP型号ID
    ProductTypestringIP网络类型
    CreateTimeinteger创建时间,时间戳
    UpdateTimeinteger更新时间,时间戳
    DueTimeinteger到期时间,时间戳
    AllocateTimeinteger分配时间,时间戳
    DeviceIdstring公网ID绑定的设备ID
    DeviceTypestring公网ID绑定的设备类型,INSTANCE:云主机;ROUTER:路由器;LOADBALANCE:负载均衡器;IRONIC:裸机
    DeviceIdstringIP所属的路由器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"
    }]
    }]
    }
    }