查询边缘小站列表 - ListEdgeSites

功能介绍

查询边缘小站列表。

该接口支持企业项目细粒度权限的校验，具体细粒度请参见 ies:edgeSite:list

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
ies:edgeSite:list
List
edgeSite *
-
-
-
-
g:EnterpriseProjectId

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
ies:edgeSite:list	List	edgeSite *	-	-	-
-	g:EnterpriseProjectId

URI

GET /v1/{domain_id}/edge-sites

表1 路径参数
参数	是否必选	参数类型	描述
domain_id	是	String	path中租户的账号ID

表2 Query参数
参数	是否必选	参数类型	描述
limit	否	Integer	每页的数量
marker	否	String	分页标识
sort_key	否	Array of strings	排序字段
sort_dir	否	Array of strings	排序方式，取值范围： desc：降序 asc：升序
enterprise_project_id	否	Array of strings	企业项目ID。可以使用该字段过滤某个企业项目下的边缘小站。最大长度36字节，带“-”连字符的UUID格式，或者是字符串“0”。“0”表示默认企业项目。若需要查询当前用户所有企业项目绑定的边缘小站，请传参all_granted_eps。不传则查询全部。
id	否	Array of strings	根据边缘小站ID查询，支持排序
name	否	Array of strings	根据边缘小站名称查询（精确），支持排序
availability_zone_id	否	Array of strings	根据边缘可用区ID查询
status	否	Array of strings	根据边缘小站部署状态查询

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
edge_sites	Array of EdgeSiteDetail objects	边缘小站列表。
page_info	PageInfo object	分页信息

表5 EdgeSiteDetail
参数	参数类型	描述
id	String	边缘小站ID
domain_id	String	边缘小站所属账号ID
name	String	边缘小站名称
description	String	边缘小站描述
region_id	String	边缘小站所属区域ID
project_id	String	边缘小站所属项目ID
availability_zone_id	String	边缘小站的可用区ID
status	String	站点状态： initial：待部署 deploying：部署中 available：可用 unavailable：不可用
location	LocationDetail object	场地详情
enterprise_project_id	String	边缘小站所属企业项目ID
created_at	String	边缘小站创建时间
updated_at	String	边缘小站更新时间

表6 LocationDetail
参数	参数类型	描述
name	String	场地名称（已废弃），传入该参数不会再生效，新建站点也不会再返回该字段
description	String	场地描述
zone_code	String	场地所在地区
address	String	部署位置
country	String	场地所在国家（逐步下线，使用zone_code替代）
province	String	场地所在省/自治区/直辖市
city	String	场地所在市/区
district	String	场地所在区/县
condition	Condition object	场地条件

表7 Condition
参数	参数类型	描述
environment	Integer	机房环境条件取值范围： 0：机房条件不属于上述任何一种情况 1：机房使用模块化数据中心方案进行建设 2：机房已通过国家级或行业级标准化认证
space	Integer	机柜空间条件取值范围： 0：暂无扩容计划，不考虑额外余量 1：机柜余量相对充裕，可放置空间超过3柜 2：机柜余量相对紧张，可放置空间3柜以内
transport	Integer	运输条件取值范围： 0：运输通道和机房门的高度或宽度不满足要求 1：运输通道，货梯，机房门均可满足整机柜滚轮搬运 2：运输通道，货梯，机房门不能支持整机柜滚轮搬运，沿途有台阶
installation	String	整柜安装评估取值范围： UNCLEAR：不清楚是否允许整柜安装，需要评估 UNSUPPORT：不允许整柜安装，需将设备放入现有机柜 SUPPORT：可支持整柜安装，并入现有机柜组

表8 PageInfo
参数	参数类型	描述
next_marker	String	下一页标识。
current_count	Integer	当前页数量。

请求示例

查询边缘小站列表

GET https://{ies_endpoint}/v1/{domain_id}/edge-sites?id=cc89b1e5-521d-4a85-be83-e6f7217fc63e

响应示例

状态码：200

successful operation

{
  "edge_sites" : [ {
    "id" : "cc89b1e5-521d-4a85-be83-e6f7217fc63e",
    "domain_id" : "2b76febbe5d34eac85d26435c1f15809",
    "name" : "测试站点",
    "description" : "测试站点：位于安徽",
    "region_id" : "cn-north-4",
    "project_id" : "060576838600d5762f2dc000470eb164",
    "availability_zone_id" : null,
    "status" : "initial",
    "location" : {
      "description" : "站点场地信息",
      "zone_code" : "CN",
      "address" : "安徽省 合肥市 瑶海区",
      "country" : "CN",
      "province" : "安徽省",
      "city" : "合肥市",
      "district" : "瑶海区",
      "condition" : {
        "environment" : 0,
        "space" : 0,
        "transport" : 0,
        "installation" : "SUPPORT"
      }
    },
    "enterprise_project_id" : "06fb8917-442d-4d4d-bcdb-79eb3e7b7b5d",
    "created_at" : "2022-04-15T07:59:20.641Z",
    "updated_at" : null
  } ],
  "page_info" : {
    "current_count" : 1
  }
}