Help Center/ Cloud Connect/ API Reference/ API/ Global Private Bandwidths/ Querying the Line Specification List
Updated on 2024-03-25 GMT+08:00

Querying the Line Specification List

Function

This API is used to query the line specification list. Fields in the response body of this API are controlled using a whitelist. They are left blank by default.

Parameters marker and limit are used for pagination query. The two parameters take effect only when they are used together.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

domain_id

Yes

String

Account ID.

Minimum: 10

Maximum: 32

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

Number of records on each page.

Value range: 1 to 1000

Minimum: 1

Maximum: 1000

Default: 1000

marker

No

String

Pagination query information. You can obtain the marker values from the response of the last API call. You can enter the marker value of the previous page or the next page. If you enter the marker value of the previous page, the previous page will be queried. If you enter the marker value of the next page, the next page will be queried. During pagination query, the query criteria, including the filters, sorting criteria, and the limit value, cannot be modified.

Minimum: 1

Maximum: 4096

id

No

Array

Resource ID. Multiple IDs can be queried.

Array Length: 1 - 20

local_area

No

String

Local access point code included in the line specification.

Minimum: 1

Maximum: 64

remote_area

No

String

Remote access point code included in the line specification.

Minimum: 1

Maximum: 64

level

No

Array

Bandwidth class.

  • Pt: Platinum

  • Au: Gold

  • Ag: Silver

Array Length: 1 - 10

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token.

Minimum: 0

Maximum: 2000000

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

request_id

String

Resource ID.

Minimum: 32

Maximum: 36

page_info

PageInfo object

Pagination query information.

spec_codes

Array of GlobalConnectionBandwidthSpecCode objects

Response body for querying the line specification list.

Array Length: 1 - 10

Table 5 PageInfo

Parameter

Type

Description

next_marker

String

Backward pagination identifier.

Minimum: 1

Maximum: 4096

previous_marker

String

Forward pagination identifier.

Minimum: 1

Maximum: 4096

current_count

Integer

Number of the resources in the current list.

Minimum: 0

Maximum: 2000

Table 6 GlobalConnectionBandwidthSpecCode

Parameter

Type

Description

id

String

Resource ID.

local_area

String

Local access point. This parameter is used together with remote_area to describe the applicability of a global private bandwidth. The value can contain 1 to 64 characters, including digits, letters, underscores (_), hyphens (-), and periods (.). The site code is obtained through API calls. If the bandwidth type is Region, this parameter is optional. For other types, this parameter is mandatory.

Minimum: 1

Maximum: 36

remote_area

String

Remote access point. This parameter is used together with local_area to describe the applicability of a global private bandwidth. The value can contain 1 to 64 characters, including digits, letters, underscores (_), hyphens (-), and periods (.). The site code is obtained through API calls. If the bandwidth type is Region, this parameter is optional. For other types, this parameter is mandatory.

Minimum: 1

Maximum: 36

created_at

String

Time when the resource was created. The time is in the yyyy-MM-ddTHH:mm:ss format.

updated_at

String

Time when the resource was updated. The time must be in the yyyy-MM-ddTHH:mm:ss format.

name_zh

String

Line specification in Chinese.

Minimum: 0

Maximum: 64

name_en

String

Line specification in English.

Minimum: 0

Maximum: 64

level

String

Line grade.

  • Pt: platinum

  • Au: gold

  • Ag: silver

Minimum: 0

Maximum: 64

sku

String

Product code of specific global private bandwidth line specifications.

Minimum: 0

Maximum: 64

size

Integer

Minimum bandwidth for sale, in Mbit/s.

Minimum: 2

Maximum: 999999

Example Requests

Querying the line specification list

GET https://{cc_endpoint}/v3/{domain_id}/gcb/spec-codes

Example Responses

Status code: 200

The line specification list has been queried.

{
  "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 Sample Code

The SDK sample code is as follows.

 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)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

The line specification list has been queried.

Error Codes

See Error Codes.