查询站点列表
功能介绍
查询站点列表。 分页查询使用的参数为marker、limit。marker和limit一起使用时才会生效,单独使用无效。
调用方法
请参见如何调用API。
URI
GET /v3/{domain_id}/gcb/sites
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
domain_id |
是 |
String |
账户ID。 最小长度:10 最大长度:32 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
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 |
name_en |
否 |
String |
站点信息自定义英文名称。 最小长度:1 最大长度:64 |
name_cn |
否 |
String |
站点信息自定义中文名称。 最小长度:1 最大长度:64 |
site_code |
否 |
String |
站点编码。 最小长度:1 最大长度:64 |
site_type |
否 |
String |
站点类型:
|
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
否 |
String |
用户Token。 最小长度:0 最大长度:2000000 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
request_id |
String |
资源ID标识符。 最小长度:32 最大长度:36 |
page_info |
PageInfo object |
分页查询页的信息。 |
site_infos |
Array of GlobalConnectionBandwidthSites objects |
站点信息列表响应体。 数组长度:1 - 10 |
参数 |
参数类型 |
描述 |
---|---|---|
next_marker |
String |
向后分页标识符。 最小长度:1 最大长度:4096 |
previous_marker |
String |
向前分页标识符。 最小长度:1 最大长度:4096 |
current_count |
Integer |
当前列表中资源数量。 最小值:0 最大值:2000 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
资源ID标识符。 |
description |
String |
实例描述。不支持 <>。 最小长度:0 最大长度:255 |
created_at |
String |
实例创建时间。UTC时间格式,yyyy-MM-ddTHH:mm:ss。 |
updated_at |
String |
实例更新时间。UTC时间格式,yyyy-MM-ddTHH:mm:ss。 |
name_en |
String |
功能说明:站点信息自定义的英文名字。 取值范围:1-255个字符 最小长度:1 最大长度:255 |
name_cn |
String |
功能说明:站点信息自定义的中文名字。 取值范围:1-64个字符。 最小长度:1 最大长度:64 |
site_code |
String |
功能说明:站点编码,格式为<area_code>[-<subarea_code>[-<region_code>]]。 取值范围:1-64个字符。 最小长度:1 最大长度:64 |
site_type |
String |
功能说明:站点类型,必须跟站点编码对应,一段编码为大区,两段编码为区域,三段编码为城域。 取值范围:
最小长度:1 最大长度:64 |
service_list |
String |
功能说明:站点支持的服务列表,多个服务用","分隔。 取值范围:0-255个字符 最小长度:0 最大长度:255 |
group_list |
Array of SiteGroupReferenceInfo objects |
站点分组跟外部关联的数据模型。 数组长度:1 - 10 |
region_id |
String |
功能说明:对应华为云标准region的id,该站点继承自华为云region时才需要填写该字段。 取值范围:0-64个字符。 最小长度:0 最大长度:64 |
public_border_group |
String |
功能说明:用于标记是中心还是边缘站点。中心:center 取值范围:0-255个字符。 最小长度:0 最大长度:255 |
请求示例
查询站点列表
GET https://{cc_endpoint}/v3/{domain_id}/gcb/sites
响应示例
状态码: 200
查询站点列表成功。
{ "request_id" : "61126320a1802d5c6444f9d2d76526c2", "site_infos" : [ { "id" : "5c2d5343-cde2-4a41-83ae-56b7f44d73b5", "description" : "description", "name_cn" : "CN north beijing4", "name_en" : "CN north beijing4", "site_code" : "cn-north-beijing4", "site_type" : "Region", "service_list" : "CC,GEIP", "region_id" : "cn-north-4", "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代码示例
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 |
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 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(); request.withSiteCode("<site_code>"); request.withSiteType(ListGlobalConnectionBandwidthSitesRequest.SiteTypeEnum.fromValue("<site_type>")); request.withLimit(<limit>); request.withMarker("<marker>"); request.withId(); 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 31 32 33 34 |
# 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 = ListGlobalConnectionBandwidthSitesRequest() request.site_code = "<site_code>" request.site_type = "<site_type>" request.limit = <limit> request.marker = "<marker>" request.id = 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 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.ListGlobalConnectionBandwidthSitesRequest{} siteCodeRequest:= "<site_code>" request.SiteCode = &siteCodeRequest siteTypeRequest:= model.GetListGlobalConnectionBandwidthSitesRequestSiteTypeEnum().<SITE_TYPE> request.SiteType = &siteTypeRequest limitRequest:= int32(<limit>) request.Limit = &limitRequest markerRequest:= "<marker>" request.Marker = &markerRequest response, err := client.ListGlobalConnectionBandwidthSites(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
查询站点列表成功。 |
错误码
请参见错误码。