查询全域互联带宽列表
功能介绍
查询全域互联带宽列表。
分页查询使用的参数为marker、limit。marker和limit一起使用时才会生效,单独使用无效。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v3/{domain_id}/gcb/gcbandwidths
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
domain_id |
是 |
String |
账号ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
limit |
否 |
Integer |
每页返回的个数。 取值范围:1~1000。 |
marker |
否 |
String |
翻页信息,从上次API调用返回的翻页数据中获取,可填写前一页marker或者后一页marker,填入前一页previous_marker就向前翻页,后一页next_marker就向后翻页。 翻页过程中,查询条件不能修改,包括过滤条件、排序条件、limit。 |
id |
否 |
Array of arrays |
根据ID查询,可查询多个ID。 |
name |
否 |
Array of strings |
根据名字查询,可查询多个名字。 |
enterprise_project_id |
否 |
Array of strings |
根据企业项目ID过滤列表。 |
instance_id |
否 |
Array of strings |
根据绑定实例id过滤全域互联带宽列表。 |
instance_type |
否 |
Array of strings |
根据绑定实例类型过滤全域互联带宽列表。实例类型:
|
binding_service |
否 |
Array of strings |
根据支持绑定实例类型过滤全域互联带宽列表。实例类型:
|
type |
否 |
Array of strings |
根据带宽类型过滤全域互联带宽列表。带宽类型:
|
admin_state |
否 |
Array of strings |
根据带宽状态过滤全域互联带宽列表:
|
charge_mode |
否 |
Array of strings |
根据计费方式过滤全域互联带宽列表:
|
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
否 |
String |
用户Token。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
request_id |
String |
请求ID。 |
page_info |
PageInfo object |
分页查询页的信息。 |
globalconnection_bandwidths |
Array of GlobalConnectionBandwidth objects |
全域互联带宽列表响应体。 |
参数 |
参数类型 |
描述 |
---|---|---|
next_marker |
String |
向后分页标识符。 |
previous_marker |
String |
向前分页标识符。 |
current_count |
Integer |
当前列表中资源数量。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
实例ID。 |
name |
String |
实例名称。 |
description |
String |
实例描述。不支持 <>。 |
domain_id |
String |
实例所属账号ID。 |
bordercross |
Boolean |
功能说明:全域互联带宽是否跨境,判断依据:带宽是否涉及从中国大陆到其他国家。 取值范围:True:跨境;False:非跨境 |
type |
String |
功能说明:描述带宽类型,对应地理区间的城域、区域、大区、跨区四级:
|
binding_service |
String |
功能说明:绑定的服务类型。实例类型:
|
enterprise_project_id |
String |
实例所属企业项目ID。 |
charge_mode |
String |
功能说明:描述计费类型,描述可选计费类型。默认开放按带宽计费,传统95计费租户白名单控制。 取值范围: bwd: 按带宽计费 95: 按传统型95计费 95avr: 按传统型日95计费 |
size |
Integer |
功能说明:全域互联带宽实例中的带宽值大小,单位Mbit/s。 取值范围:2-300Mbit/s |
sla_level |
String |
功能说明:描述网络等级,从高到低分为铂金、金、银。默认金,其余租户白名单控制。
|
local_area |
String |
功能说明:本端接入点的中英文名。通过HEADER里面的x-language控制,默认英文,zh-cn返回中文。 |
remote_area |
String |
功能说明:远端接入点的中英文名。通过HEADER里面的x-language控制,默认英文,zh-cn返回中文。 |
local_site_code |
String |
功能说明:本端接入点的编码。 |
remote_site_code |
String |
功能说明:远端接入点的编码。 |
admin_state |
String |
功能说明: 全域互联带宽状态。 取值范围: NORMAL-正常 FREEZED-冻结状态 |
frozen |
Boolean |
功能说明: 全域互联带宽是否冻结。 取值范围: true-冻结 false-非冻结 |
spec_code_id |
String |
功能说明:线路规格编码UUID。 |
tags |
Array of Tag objects |
实例标签。 |
created_at |
String |
实例创建时间。UTC时间格式,yyyy-MM-ddTHH:mm:ss。 |
updated_at |
String |
实例更新时间。UTC时间格式,yyyy-MM-ddTHH:mm:ss。 |
enable_share |
Boolean |
功能说明: 全域互联带宽是否支持绑定多实例。 取值范围: true-支持 false-不支持 |
instances |
Array of GlobalConnectionBandwidthAssociatedInstance objects |
功能说明: 全域互联带宽绑定实例列表。 |
请求示例
查询全域互联带宽列表
GET https://{cc_endpoint}/v3/{domain_id}/gcb/gcbandwidths
响应示例
状态码: 200
查询全域互联带宽列表成功。
{ "request_id" : "61126320a1802d5c6444f9d2d76526c2", "globalconnection_bandwidths" : [ { "id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b", "name" : "name", "description" : "description", "domain_id" : "521bb3d98bed4c6c9ee8669bd0620f76", "bordercross" : false, "type" : "Region", "binding_service" : "CC", "enterprise_project_id" : "0c478f9e-73a4-4c45-b9bc-b2c3bfc0d4c0", "charge_mode" : "bwd", "size" : 100, "sla_level" : "Au", "local_site_code" : "site-abc", "remote_site_code" : "site-def", "frozen" : false, "spec_code_id" : "", "tags" : [ ], "created_at" : "2024-01-24T08:26:41.914Z", "updated_at" : "2024-01-24T08:26:41.914Z", "enable_share" : false, "instances" : [ ] } ], "page_info" : { "next_marker" : "XXX", "previous_marker" : "XXX", "current_count" : 1 } }
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 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.GlobalCredentials; 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.cc.v3.region.CcRegion; import com.huaweicloud.sdk.cc.v3.*; import com.huaweicloud.sdk.cc.v3.model.*; public class ListGlobalConnectionBandwidthsSolution { 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"); ICredential auth = new GlobalCredentials() .withAk(ak) .withSk(sk); CcClient client = CcClient.newBuilder() .withCredential(auth) .withRegion(CcRegion.valueOf("<YOUR REGION>")) .build(); ListGlobalConnectionBandwidthsRequest request = new ListGlobalConnectionBandwidthsRequest(); try { ListGlobalConnectionBandwidthsResponse response = client.listGlobalConnectionBandwidths(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 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import GlobalCredentials from huaweicloudsdkcc.v3.region.cc_region import CcRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcc.v3 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"] credentials = GlobalCredentials(ak, sk) client = CcClient.new_builder() \ .with_credentials(credentials) \ .with_region(CcRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListGlobalConnectionBandwidthsRequest() response = client.list_global_connection_bandwidths(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 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global" cc "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cc/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cc/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/cc/v3/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") auth := global.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := cc.NewCcClient( cc.CcClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListGlobalConnectionBandwidthsRequest{} response, err := client.ListGlobalConnectionBandwidths(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
查询全域互联带宽列表成功。 |
错误码
请参见错误码。