查询带宽详情 - ShowBandwidth
功能介绍
查询单条指定带宽的详细信息。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
URI
GET /v1/{project_id}/bandwidths/{bandwidth_id}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String |
|
| bandwidth_id | 是 | String |
请求参数
无
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| bandwidth | BandwidthResp object | 带宽对象 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| bandwidth_type | String | 最小长度:1 最大长度:36 |
| billing_info | String | 最小长度:0 最大长度:255 |
| charge_mode | String | |
| id | String | 最大长度:36 |
| name | String | 最小长度:1 最大长度:64 |
| publicip_info | Array of PublicipInfoResp objects | 带宽对应的弹性公网IP信息 |
| share_type | String | 带宽类型,标识是否是共享带宽 |
| size | Integer | |
| tenant_id | String | 最大长度:36 |
| enterprise_project_id | String |
最大长度:36 |
| status | String | |
| enable_bandwidth_rules | Boolean | 是否开启企业级qos |
| rule_quota | Integer | 带宽支持的最大分组规则数。(该字段目前在华南-广州、华南-广州-友好用户环境 、华南-深圳、西南-贵阳一、华东-上海一、华北-北京四、中国-香港、亚太-新加坡局点返回,后续其他局点将陆续开放) 最小值:0 最大值:1024 |
| bandwidth_rules | Array of BandWidthRules objects | 带宽规则对象。(该字段目前在华南-广州、华南-广州-友好用户环境 、华南-深圳、西南-贵阳一、华东-上海一、华北-北京四、中国-香港、亚太-新加坡局点返回,后续其他局点将陆续开放) |
| created_at | String | 资源创建时间,UTC时间 |
| updated_at | String | 资源更新时间,UTC时间 |
| public_border_group | String | 最小长度:1 最大长度:64 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 最大长度:36 |
| name | String | 最小长度:0 最大长度:64 |
| admin_state_up | Boolean | |
| egress_size | Integer | 出网带宽最大值,单位Mbps 最小值:0 缺省值:0 |
| egress_guarented_size | Integer | 出网保障带宽大小,单位Mbps 最小值:0 缺省值:0 |
| publicip_info | Array of PublicipInfoResp objects |
请求示例
查询id为3fa5b383-5a73-4dcb-a314-c6128546d855的宽带详情
GET https://{Endpoint}/v1/{project_id}/bandwidths/3fa5b383-5a73-4dcb-a314-c6128546d855 响应示例
状态码:200
查询带宽详情正常返回
{
"bandwidth" : {
"tenant_id" : "8b7e35ad379141fc9df3e178bd64f55c",
"enterprise_project_id" : "0",
"billing_info" : "CS1712121146TSQOJ:0616e2a5dc9f4985ba52ea8c0c7e273c:southchina:35f2b308f5d64441a6fa7999fbcd4321",
"size" : 5,
"share_type" : "WHOLE",
"bandwidth_type" : "share",
"publicip_info" : [ {
"publicip_id" : "6285e7be-fd9f-497c-bc2d-dd0bdea6efe0",
"ip_version" : 4,
"publicip_type" : "5_bgp",
"publicip_address" : "161.xx.xx.9"
} ],
"name" : "2222",
"charge_mode" : "bandwidth",
"id" : "3fa5b383-5a73-4dcb-a314-c6128546d855",
"enable_bandwidth_rules" : false,
"rule_quota" : 0,
"bandwidth_rules" : [ ],
"status" : "NORMAL",
"created_at" : "2020-06-03T09:01:11Z",
"updated_at" : "2020-06-03T09:01:11Z"
}
} SDK代码示例
SDK代码示例如下。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 | package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.eip.v2.region.EipRegion; import com.huaweicloud.sdk.eip.v2.*; import com.huaweicloud.sdk.eip.v2.model.*; public class ShowBandwidthSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); EipClient client = EipClient.newBuilder() .withCredential(auth) .withRegion(EipRegion.valueOf("<YOUR REGION>")) .build(); ShowBandwidthRequest request = new ShowBandwidthRequest(); request.withBandwidthId("{bandwidth_id}"); try { ShowBandwidthResponse response = client.showBandwidth(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 | # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkeip.v2.region.eip_region import EipRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkeip.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = EipClient.new_builder() \ .with_credentials(credentials) \ .with_region(EipRegion.value_of("<YOUR REGION>")) \ .build() try: request = ShowBandwidthRequest() request.bandwidth_id = "{bandwidth_id}" response = client.show_bandwidth(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 | package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" eip "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eip/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eip/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/eip/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := eip.EipClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := eip.NewEipClient(hcClient) request := &model.ShowBandwidthRequest{} request.BandwidthId = "{bandwidth_id}" response, err := client.ShowBandwidth(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 查询带宽详情正常返回 |
错误码
请参见错误码。