文档首页/ 云连接 CC/ API参考/ API/ 全域互联带宽/ 查询线路规格列表
更新时间:2024-03-25 GMT+08:00
分享

查询线路规格列表

功能介绍

查询线路规格列表。租户白名单控制,默认为空。 分页查询使用的参数为marker、limit。marker和limit一起使用时才会生效,单独使用无效。

调用方法

请参见如何调用API

URI

GET /v3/{domain_id}/gcb/spec-codes

表1 路径参数

参数

是否必选

参数类型

描述

domain_id

String

账户ID。

最小长度:10

最大长度:32

表2 Query参数

参数

是否必选

参数类型

描述

limit

Integer

每页返回的个数。 取值范围:1~1000。

最小值:1

最大值:1000

缺省值:1000

marker

String

翻页信息,从上次API调用返回的翻页数据中获取,可填写前一页marker或者后一页marker,填入前一页previous_marker就向前翻页,后一页next_marker就向翻页。 翻页过程中,查询条件不能修改,包括过滤条件,排序条件,limit。

最小长度:1

最大长度:4096

id

Array

根据id查询,可查询多个id。

数组长度:1 - 20

local_area

String

线路规格本端接入点编码信息。

最小长度:1

最大长度:64

remote_area

String

线路规格远端接入点编码信息。

最小长度:1

最大长度:64

level

Array

带宽等级:

  • Pt: 铂金

  • Au: 金

  • Ag: 银

数组长度:1 - 10

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

最小长度:0

最大长度:2000000

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

request_id

String

资源ID标识符。

最小长度:32

最大长度:36

page_info

PageInfo object

分页查询页的信息。

spec_codes

Array of GlobalConnectionBandwidthSpecCode objects

线路规格列表响应体。

数组长度:1 - 10

表5 PageInfo

参数

参数类型

描述

next_marker

String

向后分页标识符。

最小长度:1

最大长度:4096

previous_marker

String

向前分页标识符。

最小长度:1

最大长度:4096

current_count

Integer

当前列表中资源数量。

最小值:0

最大值:2000

表6 GlobalConnectionBandwidthSpecCode

参数

参数类型

描述

id

String

资源ID标识符。

local_area

String

功能说明:本端接入点,配合remote_area信息描述带宽实例应用的范围。 取值范围:1-64个字符,支持数字、字母、中文、_(下划线)、-(中划线)、.(点),站点编码通过接口获取,带宽类型为Region可不传,其他类型必传

最小长度:1

最大长度:36

remote_area

String

功能说明:远端接入点,配合local_area信息描述带宽实例应用的范围。 取值范围:1-64个字符,支持数字、字母、中文、_(下划线)、-(中划线)、.(点),站点编码通过接口获取,带宽类型为Region可不传,其他类型必传

最小长度:1

最大长度:36

created_at

String

实例创建时间。UTC时间格式,yyyy-MM-ddTHH:mm:ss。

updated_at

String

实例更新时间。UTC时间格式,yyyy-MM-ddTHH:mm:ss。

name_zh

String

功能说明:线路规格中文名。

最小长度:0

最大长度:64

name_en

String

功能说明:线路规格英文名。

最小长度:0

最大长度:64

level

String

支持的线路等级:

  • Pt: 铂金

  • Au: 金

  • Ag: 银

最小长度:0

最大长度:64

sku

String

功能描述:GCB特定线路规格产品编码。

最小长度:0

最大长度:64

size

Integer

功能描述:带宽起售值,单位Mbps。

最小值:2

最大值:999999

请求示例

查询线路规格列表

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" : "cn-southwest-guiyang1",
    "remote_area" : "cn-north-wulanchabu1",
    "level" : "Ag",
    "sku" : "guiyang1_wulanchabu1_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
46
47
48
49
50
51
52
53
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.*;

import java.util.List;
import java.util.ArrayList;

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();
        request.withLocalArea("<local_area>");
        request.withRemoteArea("<remote_area>");
        request.withLevel();
        request.withLimit(<limit>);
        request.withMarker("<marker>");
        request.withId();
        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
31
32
33
34
35
# coding: utf-8

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 = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("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()
        request.local_area = "<local_area>"
        request.remote_area = "<remote_area>"
        request.level = 
        request.limit = <limit>
        request.marker = "<marker>"
        request.id = 
        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
36
37
38
39
40
41
42
43
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{}
	localAreaRequest:= "<local_area>"
	request.LocalArea = &localAreaRequest
	remoteAreaRequest:= "<remote_area>"
	request.RemoteArea = &remoteAreaRequest
	limitRequest:= int32(<limit>)
	request.Limit = &limitRequest
	markerRequest:= "<marker>"
	request.Marker = &markerRequest
	response, err := client.ListGlobalConnectionBandwidthSpecCodes(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

查询线路规格列表成功。

错误码

请参见错误码

相关文档