Querying the Site List
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.
Calling Method
For details, see Calling APIs.
URI
GET /v3/{domain_id}/gcb/sites
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
domain_id |
Yes |
String |
Account ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
limit |
No |
Integer |
Number of records on each page. Value range: 1 to 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. |
name_en |
No |
String |
User-defined site information in English. |
name_cn |
No |
String |
User-defined site information in Chinese. |
site_code |
No |
String |
Site code. |
site_type |
No |
String |
Site type.
|
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
No |
String |
User token. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
request_id |
String |
Request ID. |
page_info |
PageInfo object |
Pagination query information. |
site_infos |
Array of GlobalConnectionBandwidthSites objects |
Response body for querying the site list. |
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. |
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 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_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.
|
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. |
region_id |
String |
ID of a standard Huawei Cloud region. This parameter is mandatory only when the site is inherited from a Huawei Cloud region. Value range: 0 to 64 characters |
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 |
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. Value range: 1 to 255 characters |
name_cn |
String |
User-defined site group name in Chinese. Value range: 1 to 64 characters |
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,GEIP", "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" } ], "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 |
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 ListGlobalConnectionBandwidthSitesSolution { 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(); ListGlobalConnectionBandwidthSitesRequest request = new ListGlobalConnectionBandwidthSitesRequest(); try { ListGlobalConnectionBandwidthSitesResponse response = client.listGlobalConnectionBandwidthSites(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 = ListGlobalConnectionBandwidthSitesRequest() response = client.list_global_connection_bandwidth_sites(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.ListGlobalConnectionBandwidthSitesRequest{} response, err := client.ListGlobalConnectionBandwidthSites(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 site list has been queried. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot