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.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
domain_id	Yes	String	Account ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Number of records returned on each page. Value range: 1-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.
id	No	Array of arrays	Resource ID. Multiple IDs can be queried.
local_area	No	String	Local access point code included in the line specification.
remote_area	No	String	Remote access point code included in the line specification.
level	No	Array of strings	Bandwidth class. Pt: Platinum Au: Gold Ag: Silver

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	User token.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
request_id	String	Request ID.
page_info	PageInfo object	Pagination query information.
spec_codes	Array of GlobalConnectionBandwidthSpecCode objects	Response body for querying the line specification list.

**Table 5** PageInfo
Parameter	Type	Description
next_marker	String	Backward pagination identifier.
previous_marker	String	Forward pagination identifier.
current_count	Integer	Number of the resources in the current list.

**Table 6** GlobalConnectionBandwidthSpecCode
Parameter	Type	Description
id	String	Instance ID.
local_area	String	Local access point. This parameter is used together with remote_area to describe the applicability of a global connection 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.
remote_area	String	Remote access point. This parameter is used together with local_area to describe the applicability of a global connection 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.
created_at	String	Time when the resource was created. The UTC time is in the yyyy-MM-ddTHH:mm:ss format.
updated_at	String	Time when the resource was updated. The UTC time must be in the yyyy-MM-ddTHH:mm:ss format.
name_zh	String	Line specification in Chinese.
name_en	String	Line specification in English.
level	String	Line grade. Pt: Platinum Au: Gold Ag: Silver
sku	String	Product code of specific global connection bandwidth line specifications.
size	Integer	Minimum bandwidth for sale, in Mbit/s.

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" : "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
  }
}