查询边缘站点列表
功能介绍
查询边缘站点列表。
边缘站点：靠近终端应用的位置，基于一个或多个运营商建立的一个城市级站点。边缘站点提供物理隔离的资源池，提供多元算力、存储和网络的能力。用户可以将业务灵活就近部署在边缘站点上，以降低网络时延和成本。
边缘区域：为依据边缘站点的物理位置划分的区域，一个边缘区域包含多个相靠近的边缘站点的集合。IEC当前提供城市级、省级和大区级三个分布层级的边缘区域。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v1/sites
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
area |
否 |
String |
边缘实例所在大区。 大小写通用，皆支持。 支持多个查询，中间使用','分隔。 |
city |
否 |
String |
边缘实例所在城市。 大小写通用，皆支持。 支持多个查询，中间使用“,”分隔。 |
flavor |
否 |
String |
边缘实例规格。 |
id |
否 |
String |
查询条件，站点ID。 |
limit |
否 |
Integer |
查询返回边缘站点列表当前页面的数量。 取值范围：0~1000。 最小值：0 最大值：1000 缺省值：1000 |
offset |
否 |
Integer |
查询的偏移量。默认为0。 缺省值：0 |
province |
否 |
String |
边缘实例所在省份。 大小写通用，皆支持。 支持多个查询，中间使用“,”分隔。 |
volume_type |
否 |
String |
过滤支持磁盘类型的站点，多个类型之间用“,”分割。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：0 |
响应参数
状态码： 200
参数 |
参数类型 |
描述 |
|---|---|---|
count |
Integer |
边缘站点总数。 |
sites |
Array of Site objects |
站点列表。 |
参数 |
参数类型 |
描述 |
|---|---|---|
id |
String |
边缘站点ID。 |
name |
String |
边缘站点名称。 |
city |
String |
站点所在城市。 |
i18n_city |
String |
城市的国际化名称。 |
province |
String |
站点所在省份。 |
i18n_province |
String |
省份的国际化名称。 |
area |
String |
所在大区。 |
i18n_area |
String |
大区的国际化名称。 |
country |
String |
站点所在的国家。 |
i18n_country |
String |
国家的国际化名称。 |
status |
String |
站点当前的状态。 取值范围：
|
pools |
Array of IpPool objects |
站点IP线路列表。 |
city_short_name |
String |
城市名称缩写。 |
参数 |
参数类型 |
描述 |
|---|---|---|
id |
String |
线路的ID。 |
site_id |
String |
线路所属站点ID。 |
pool_id |
String |
线路标识。 |
ip_version |
String |
IPv4或IPv6线路。 取值范围：
|
operator |
Operator object |
运营商信息。 |
display_name |
String |
线路的显示名称。 |
allow_share_bandwidth_types |
Array of strings |
功能说明：表示此线路可以使用的带宽类型列表，如果列表为空，则表示该线路不能使用任何带宽 约束：线路下的ip只能加入到带宽类型在allow_share_bandwidth_types中带宽 最大长度：36 |
请求示例
GET https://{endpoint}/v1/sites?flavor=c6.large.2
响应示例
状态码： 200
OK
{
"count" : 1,
"sites" : [ {
"id" : "705da43d-fa20-11ea-9fb2-fa1640495574",
"name" : "changsha",
"city" : "changsha",
"i18n_city" : "长沙市",
"province" : "hunan",
"i18n_province" : "湖南",
"area" : "central",
"i18n_area" : "华中地区",
"country" : "China",
"i18n_country" : "China",
"status" : "Normal",
"city_short_name" : "CS",
"pools" : [ {
"id" : "705ed516-fa20-11ea-9fb2-fa1640495574",
"site_id" : "705da43d-fa20-11ea-9fb2-fa1640495574",
"display_name" : "",
"operator" : {
"id" : "1",
"name" : "chinatelecom",
"i18n_name" : "中国电信",
"sa" : "CTCC"
},
"pool_id" : "5_sbgp_site1",
"ip_version" : "4"
}, {
"id" : "705ed56a-fa20-11ea-9fb2-fa1640495574",
"site_id" : "705da43d-fa20-11ea-9fb2-fa1640495574",
"display_name" : "",
"operator" : {
"id" : "2",
"name" : "chinaunicom",
"i18n_name" : "中国联通",
"sa" : "CUCC"
},
"pool_id" : "5_unicon_site1",
"ip_version" : "4"
}, {
"id" : "fcd8beaa-fd71-11ea-9594-00d861bad499",
"site_id" : "705da43d-fa20-11ea-9fb2-fa1640495574",
"display_name" : "iec-changsha-pool2",
"operator" : {
"id" : "3",
"name" : "chinamobile",
"i18n_name" : "中国移动",
"sa" : "CMCC"
},
"pool_id" : "5_mobile_site1",
"ip_version" : "4"
} ]
} ]
}
状态码
状态码 |
描述 |
|---|---|
200 |
OK |
错误码
请参见错误码。
