查询边缘小站详情 - ShowEdgeSite
功能介绍
查询边缘小站详情。
-
该接口支持企业项目细粒度权限的校验,具体细粒度请参见 ies:edgeSite:get
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
ies:edgeSite:get
Read
edgeSite *
g:EnterpriseProjectId
-
-
URI
GET /v1/{domain_id}/edge-sites/{site_id}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
domain_id |
是 |
String |
path中租户的账号ID |
|
site_id |
是 |
String |
边缘小站ID |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
edge_site |
EdgeSiteDetail object |
边缘小站详情 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
站点状态:
|
|
location |
LocationDetail object |
场地详情 |
|
enterprise_project_id |
String |
边缘小站所属企业项目ID |
|
created_at |
String |
边缘小站创建时间 |
|
updated_at |
String |
边缘小站更新时间 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
name |
String |
场地名称(已废弃),传入该参数不会再生效,新建站点也不会再返回该字段 |
|
description |
String |
场地描述 |
|
zone_code |
String |
场地所在地区 |
|
address |
String |
部署位置 |
|
country |
String |
场地所在国家(逐步下线,使用zone_code替代) |
|
province |
String |
场地所在省/自治区/直辖市 |
|
city |
String |
场地所在市/区 |
|
district |
String |
场地所在区/县 |
|
condition |
Condition object |
场地条件 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
environment |
Integer |
机房环境条件 取值范围:
|
|
space |
Integer |
机柜空间条件 取值范围:
|
|
transport |
Integer |
运输条件 取值范围:
|
|
installation |
String |
整柜安装评估 取值范围:
|
请求示例
查询边缘小站详情
GET https://{ies_endpoint}/v1/{domain_id}/edge-sites/{site_id}
响应示例
状态码:200
successful operation
-
{ "edge_site" : { "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 } }
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
successful operation |
错误码
请参见错误码。