功能介绍
查询带宽列表。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v1/{project_id}/bandwidths
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取项目ID请参见获取项目ID |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
marker |
否 |
String |
最大长度:36 |
limit |
否 |
Integer |
最小值:0 |
enterprise_project_id |
否 |
String |
关于企业项目ID的获取及企业项目特性的详细信息,请参见《企业管理用户指南》。 |
share_type |
否 |
String |
枚举值:
|
请求参数
无
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
bandwidth_type |
String |
最小长度:1 最大长度:36 |
billing_info |
String |
最小长度:0 最大长度:255 |
charge_mode |
String |
枚举值:
|
id |
String |
最大长度:36 |
name |
String |
最小长度:1 最大长度:64 |
publicip_info |
|
|
share_type |
String |
枚举值:
|
size |
Integer |
|
tenant_id |
String |
最大长度:36 |
enterprise_project_id |
String |
关于企业项目ID的获取及企业项目特性的详细信息,请参见《企业管理用户指南》。 最大长度:36 |
status |
String |
枚举值:
|
enable_bandwidth_rules |
Boolean |
|
rule_quota |
Integer |
最小值:0 最大值:1024 |
bandwidth_rules |
|
|
created_at |
String |
|
updated_at |
String |
|
public_border_group |
String |
最小长度:1 最大长度:64 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
最大长度:36 |
name |
String |
最小长度:0 最大长度:64 |
admin_state_up |
Boolean |
|
egress_size |
Integer |
最小值:0 缺省值:0 |
egress_guarented_size |
Integer |
最小值:0 缺省值:0 |
publicip_info |
|
参数 |
参数类型 |
描述 |
---|---|---|
publicip_address |
String |
最大长度:15 |
publicip_id |
String |
最大长度:36 |
publicip_type |
String |
最大长度:36 |
publicipv6_address |
String |
最大长度:39 |
ip_version |
Integer |
枚举值:
|
请求示例
GET https://{Endpoint}/v1/{project_id}/bandwidths?limit=3&marker=4779ab1c-7c1a-44b1-a02e-93dfc361b32d
响应示例
状态码: 200
GET和PUT操作正常返回
{
"bandwidths" : [ {
"tenant_id" : "8b7e35ad379141fc9df3e178bd64f55c",
"enterprise_project_id" : "0",
"billing_info" : "CS1712121146TSQOJ:0616e2a5dc9f4985ba52ea8c0c7e273c:southchina:35f2b308f5d64441a6fa7999fbcd4321",
"size" : 5,
"share_type" : "PER",
"bandwidth_type" : "bgp",
"publicip_info" : [ {
"publicip_id" : "80d5b82e-43b9-4f82-809a-37bec5793bd4",
"ip_version" : 4,
"publicip_type" : "5_bgp",
"publicip_address" : "161.xx.xx.10"
} ],
"name" : "ddddd",
"charge_mode" : "bandwidth",
"enable_bandwidth_rules" : false,
"rule_quota" : 0,
"bandwidth_rules" : [ ],
"id" : "a79fd11a-047b-4f5b-8f12-99c178cc780a",
"status" : "NORMAL"
}, {
"tenant_id" : "8b7e35ad379141fc9df3e178bd64f55c",
"enterprise_project_id" : "0",
"size" : 6,
"share_type" : "PER",
"bandwidth_type" : "bgp",
"publicip_info" : [ {
"publicip_id" : "6285e7be-fd9f-497c-bc2d-dd0bdea6efe0",
"ip_version" : 4,
"publicip_type" : "5_bgp",
"publicip_address" : "161.xx.xx.9"
} ],
"name" : "22212",
"enable_bandwidth_rules" : false,
"rule_quota" : 0,
"bandwidth_rules" : [ ],
"charge_mode" : "bandwidth",
"id" : "3fa5b383-5a73-4dcb-a314-c6128546d855",
"status" : "NORMAL"
}, {
"tenant_id" : "8b7e35ad379141fc9df3e178bd64f55c",
"enterprise_project_id" : "0",
"size" : 5,
"share_type" : "PER",
"bandwidth_type" : "bgp",
"publicip_info" : [ {
"publicip_id" : "4ca21961-8e52-4ff4-b9c5-af2dcc2c7b50",
"ip_version" : 4,
"publicip_type" : "5_bgp",
"publicip_address" : "161.xx.xx.13"
} ],
"name" : "2222",
"enable_bandwidth_rules" : false,
"rule_quota" : 0,
"bandwidth_rules" : [ ],
"charge_mode" : "bandwidth",
"id" : "f54e0df7-422d-4ab6-8d65-fd436151479c",
"status" : "NORMAL"
} ]
}
状态码
状态码 |
描述 |
---|---|
200 |
GET和PUT操作正常返回 |
错误码
请参见错误码。