Function

This API is used to query the site list.

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/sites

**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. The value ranges from 1 to 2000.
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 strings	Resource ID. Multiple IDs can be queried.
name_en	No	String	User-defined site information in English.
name_cn	No	String	User-defined site information in English.
site_code	No	String	Site code.
site_type	No	String	Site type. Area: a geographic region site SubArea: a region site Region: a multi-city site

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.
total_count	Integer	Total number of records.
site_infos	Array of GlobalConnectionBandwidthSites objects	Response body for querying the site 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** GlobalConnectionBandwidthSites
Parameter	Type	Description
id	String	Instance ID.
description	String	Resource description. Angle brackets (<>) are not allowed.
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.
region_id	String	Region ID.
name_en	String	User-defined site name in English. Value range: 1 to 255 characters
name_cn	String	User-defined site name in English. Value range: 1 to 64 characters
site_code	String	Site code in the format of <area_code>[-<subarea_code>[-<region_code>]]. Value range: 1 to 64 characters
site_type	String	Site type that corresponds to the site code. One code indicates a site in a geographic region, two codes indicate a site in a region, and three codes indicate a multi-city site. The value can be: Area: a geographic region site SubArea: a region site Region: a multi-city site
service_list	String	List of services supported at the site. Multiple services are separated by commas (,). Value range: 0 to 255 characters
group_list	Array of SiteGroupReferenceInfo objects	Data model for association between site groups and external systems.
public_border_group	String	Whether the site is a central site or an edge site. center: indicates a central site. Value range: 0 to 255 characters
spec_code	String	The specification code of the site. This parameter has been discarded. Please do not use it.
region_size	String	The number of subordinates of the site. This parameter has been discarded. Please do not use it.
enable_share	String	Whether a global connection bandwidth can be used by multiple instances in the site. This parameter has been discarded. Please do not use it.

**Table 7** SiteGroupReferenceInfo
Parameter	Type	Description
id	String	Instance ID.
description	String	Resource description. Angle brackets (<>) are not allowed.
name_en	String	User-defined site group name in English.
name_cn	String	User-defined site group name in English.

Example Requests

Querying the site list

GET https://{cc_endpoint}/v3/{domain_id}/gcb/sites

Example Responses

Status code: 200

The site list has been queried.

{
  "request_id" : "61126320a1802d5c6444f9d2d76526c2",
  "site_infos" : [ {
    "id" : "5c2d5343-cde2-4a41-83ae-56b7f44d73b5",
    "description" : "description",
    "name_cn" : "Site abc",
    "name_en" : "site-abc",
    "site_code" : "site-abc",
    "site_type" : "Region",
    "service_list" : "CC,GCN",
    "region_id" : "region-abc",
    "public_border_group" : "center",
    "group_list" : [ {
      "id" : "a3bad420-33b8-4e26-9e9b-bdf67aa8e72b",
      "description" : "description"
    } ],
    "created_at" : "2024-01-24T08:26:41.914Z",
    "updated_at" : "2024-01-24T08:26:41.914Z"
  } ],
  "total_count" : 10,
  "page_info" : {
    "next_marker" : "XXX",
    "previous_marker" : "XXX",
    "current_count" : 1
  }
}

Status Codes

Status Code	Description
200	The site list has been queried.

Error Codes

See Error Codes.

Querying the Site List