查询带宽列表

接口说明

本接口支持用户查询当前所有带宽实例信息。

接口说明:支持用户根据实际需求进行分页查询,可根据资源实例ID进行模糊搜索。


推荐使用API Explorer调试

API Explorer支持接口在线可视化调用,同时自动生成动态代码示例,搭配OpenAPI SDK无需计算签名实现接口快速集成。

URL

POST https://ecloud.10086.cn/api/Computer_api/ccabusiorder/api/v1/order/bw/getBwInstanceList

请求参数

Body

参数名称
类型
必填
描述
ccaInstanceBwParam
带宽实例列表入参
是

接口入参

bwName
string
否

带宽名称

instanceIds
<string> array
否

实例列表

measureUnit
string
否

计费类型 month:包月计费,year:包年计费

pageNumber
string
否

页码

pageSize
string
否

页大小

poolId
string
否

资源池ID

regionId
string
否

可用区编码

statusList
<integer(int32)> array
否

带宽实例状态,1开通中、2已开通、3续订中、6/601已退订、8冻结中、7已冻结、10开通失败、1004审批中、18变更中

请求示例

POST https://ecloud.10086.cn/api/Computer_api/ccabusiorder/api/v1/order/bw/getBwInstanceList
{
	"pageNumber":"1",
	"pageSize":"10"
}

返回参数

返回码:200
OK
参数名称
类型
描述
data
Page«带宽实例列表出参»

响应数据

current
integer(int64)

当前页数

hitCount
boolean

是否命中count缓存

orders
<OrderItem> array

排序字段信息

asc
boolean

是否升序

column
string

排序列

pages
integer(int64)

总页数

records
<带宽实例列表出参> array

实例数据列表

autoRenew
boolean

是否自动续订,true:是,false:否

bwName
string

带宽名称

bwSize
integer(int32)

带宽大小

bwSubnetName
string

业务子网名称,多个用英文逗号隔开

bwVpcId
string

带宽VPC的ID

bwVpcName
string

带宽VPC名称

effTime
string

开通时间

endTime
string

到期时间,免费订单此字段为空

hasUneffectiveRenewalDesc
string

是否包含未生效的续订周期:包含、不包含

id
string

主键

instanceId
string

实例ID

isDel
integer(int32)

是否删除,0:未删除,1:已删除

measureUnit
string

month:包月计费,year:包年计费,免费订单此字段为空

mopO
string

mopO

mopT
string

mopT

natGatWayId
string

nat网关id

natGatewayName
string

nat网关名称

natInstanceId
string

nat资源id

periodNum
integer(int32)

订购周期,免费订单时此字段为空

poolName
string

资源池名称

price
string

价格

productId
string

产品id

publicIpAddress
string

公网ip地址

regionName
string

云管可用区名称

renewDuration
integer(int32)

续订周期

saleType
string

订单购买类型,0:赠送,1:购买

status
integer(int32)

带宽实例状态,1开通中、2已开通、3续订中、6/601已退订、8冻结中、7已冻结、10开通失败、1004审批中、18变更中

type
integer(int32)

带宽类型,1:IPv4,2:IPv6

searchCount
boolean

是否进行count查询

size
integer(int64)

页大小

total
integer(int64)

总数

requestId
string

请求ID

respCode
string

响应编码

respMsg
string

响应信息

返回示例

返回码:200
OK
{
	"data":{
		"records":[
			{
				"id":"1960993283159367682",
				"instanceId":"CCA-NBW-74618dbb0a914b10ac232d104a1c6089",
				"mopO":"MOP-O-25082886238638",
				"mopT":"MOP-T-25082897549268",
				"periodNum":1,
				"bwName":"bandwidth-td",
				"status":6,
				"bwSize":6,
				"measureUnit":"month",
				"bwVpcName":null,
				"bwVpcId":null,
				"bwSubnetName":null,
				"autoRenew":false,
				"renewDuration":0,
				"natGatWayId":null,
				"natGatewayName":null,
				"natInstanceId":null,
				"poolName":"华东-苏州",
				"publicIpAddress":null,
				"regionName":"可用区二",
				"effTime":"2025-08-28 17:10:09",
				"endTime":"2025-08-28 17:12:38",
				"isDel":null,
				"saleType":"1",
				"type":1,
				"productId":"2308240022196239",
				"price":null,
				"hasUneffectiveRenewalDesc":"不包含"
			},
			{
				"id":"1960992786012708865",
				"instanceId":"CCA-NBW-d66bb49d039e41dfadd45bebb7b8129d",
				"mopO":"MOP-O-25082886238098",
				"mopT":"MOP-T-25082897548870",
				"periodNum":1,
				"bwName":"bandwidth-re1",
				"status":2,
				"bwSize":6,
				"measureUnit":"month",
				"bwVpcName":null,
				"bwVpcId":null,
				"bwSubnetName":null,
				"autoRenew":false,
				"renewDuration":0,
				"natGatWayId":null,
				"natGatewayName":null,
				"natInstanceId":null,
				"poolName":"华东-苏州",
				"publicIpAddress":"2.23.1.227",
				"regionName":"可用区二",
				"effTime":"2025-08-28 17:05:06",
				"endTime":"2025-10-28 17:05:50",
				"isDel":null,
				"saleType":"1",
				"type":1,
				"productId":"2308240022196239",
				"price":null,
				"hasUneffectiveRenewalDesc":"不包含"
			}
		],
		"total":57,
		"size":2,
		"current":1,
		"orders":[],
		"hitCount":false,
		"searchCount":true,
		"pages":29
	},
	"respCode":"0",
	"respMsg":"",
	"requestId":"6450d7f82317101a51ab413108bb158b"
}
本文档内容整理自移动云官方帮助中心(查看原文),仅供参考。