查询线路规格列表
功能介绍
查询线路规格列表。租户白名单控制,默认为空。
分页查询使用的参数为marker、limit。marker和limit一起使用时才会生效,单独使用无效。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v3/{domain_id}/gcb/spec-codes
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
domain_id |
是 |
String |
账号ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
limit |
否 |
Integer |
每页返回的个数。 取值范围:1~1000。 |
marker |
否 |
String |
翻页信息,从上次API调用返回的翻页数据中获取,可填写前一页marker或者后一页marker,填入前一页previous_marker就向前翻页,后一页next_marker就向后翻页。 翻页过程中,查询条件不能修改,包括过滤条件、排序条件、limit。 |
id |
否 |
Array of arrays |
根据ID查询,可查询多个ID。 |
local_area |
否 |
String |
线路规格本端接入点编码信息。 |
remote_area |
否 |
String |
线路规格远端接入点编码信息。 |
level |
否 |
Array of strings |
带宽等级:
|
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
否 |
String |
用户Token。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
request_id |
String |
请求ID。 |
page_info |
PageInfo object |
分页查询页的信息。 |
spec_codes |
Array of GlobalConnectionBandwidthSpecCode objects |
线路规格列表响应体。 |
参数 |
参数类型 |
描述 |
---|---|---|
next_marker |
String |
向后分页标识符。 |
previous_marker |
String |
向前分页标识符。 |
current_count |
Integer |
当前列表中资源数量。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
实例ID。 |
local_area |
String |
功能说明:本端接入点,配合remote_area信息描述带宽实例应用的范围。 取值范围:1-64个字符,支持数字、字母、中文、_(下划线)、-(中划线)、.(点),站点编码通过接口获取,带宽类型为Region可不传,其他类型必传 |
remote_area |
String |
功能说明:远端接入点,配合local_area信息描述带宽实例应用的范围。 取值范围:1-64个字符,支持数字、字母、中文、_(下划线)、-(中划线)、.(点),站点编码通过接口获取,带宽类型为Region可不传,其他类型必传 |
created_at |
String |
实例创建时间。UTC时间格式,yyyy-MM-ddTHH:mm:ss。 |
updated_at |
String |
实例更新时间。UTC时间格式,yyyy-MM-ddTHH:mm:ss。 |
name_zh |
String |
功能说明:线路规格中文名。 |
name_en |
String |
功能说明:线路规格英文名。 |
level |
String |
支持的线路等级:
|
sku |
String |
功能描述:GCB特定线路规格产品编码。 |
size |
Integer |
功能描述:带宽起售值,单位Mbps。 |
请求示例
查询线路规格列表
GET https://{cc_endpoint}/v3/{domain_id}/gcb/spec-codes
响应示例
状态码: 200
查询线路规格列表成功。
{ "request_id" : "61126320a1802d5c6444f9d2d76526c2", "spec_codes" : [ { "id" : "5c2d5343-cde2-4a41-83ae-56b7f44d73b5", "name_zh" : "DirectionalBandwidth", "name_en" : "DirectionalBandwidth", "local_area" : "site-abc", "remote_area" : "site-def", "level" : "Ag", "sku" : "abc_def_ext_ag", "size" : 2, "created_at" : "2024-01-24T08:26:41.914Z", "updated_at" : "2024-01-24T08:26:41.914Z" } ], "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 ListGlobalConnectionBandwidthSpecCodesSolution { 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(); ListGlobalConnectionBandwidthSpecCodesRequest request = new ListGlobalConnectionBandwidthSpecCodesRequest(); try { ListGlobalConnectionBandwidthSpecCodesResponse response = client.listGlobalConnectionBandwidthSpecCodes(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 = ListGlobalConnectionBandwidthSpecCodesRequest() response = client.list_global_connection_bandwidth_spec_codes(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.ListGlobalConnectionBandwidthSpecCodesRequest{} response, err := client.ListGlobalConnectionBandwidthSpecCodes(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
查询线路规格列表成功。 |
错误码
请参见错误码。