创建边缘小站
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
POST /v1/{domain_id}/edge-sites
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
domain_id |
是 |
String |
path中租户的账号ID 最大长度:36 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
edge_site |
是 |
CreateEdgeSite object |
边缘小站参数 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
是 |
String |
边缘小站名称,最大支持长度为64个字节。只包含中文字符、英文字母(a-z、A-Z)、数字(0-9)、下划线(_)、中划线(-) 最小长度:2 最大长度:64 |
region_id |
是 |
String |
边缘小站所属区域ID,最大长度为64个字节。只包含英文字母(a-z、A-Z)、数字(0-9)、下划线(_)、中划线(-) 最小长度:1 最大长度:64 |
description |
否 |
String |
边缘小站描述,最大支持长度为255个字节,不允许包含<> 最大长度:255 |
location |
是 |
CreateLocation object |
场地信息 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
否 |
String |
场地名称(已废弃),该参数不会再持久化存储,新建站点也不会再返回该字段 |
address |
否 |
String |
场地所在省/自治区/直辖市 最小长度:1 最大长度:192 |
zone_code |
否 |
String |
场地所在地区 缺省值:CN 最小长度:1 |
province |
否 |
String |
场地所在省/自治区/直辖市 最小长度:1 最大长度:64 |
city |
否 |
String |
场地所在市/区 最小长度:1 最大长度:64 |
district |
否 |
String |
场地所在区/县 最小长度:1 最大长度:64 |
country |
否 |
String |
场地所在国家(逐步下线,使用zone_code替代) 缺省值:CN |
condition |
是 |
Condition object |
场地条件 |
description |
否 |
String |
场地描述,最大支持长度为255个字节,不允许包含<> 最大长度:255 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
environment |
否 |
Integer |
机房环境条件 取值范围:
最小值:0 最大值:2 缺省值:0 |
space |
否 |
Integer |
机柜空间条件 取值范围:
最小值:0 最大值:2 缺省值:0 |
transport |
否 |
Integer |
运输条件 取值范围:
最小值:0 最大值:2 缺省值:0 |
installation |
否 |
String |
整柜安装评估 取值范围:
缺省值:UNCLEAR |
响应参数
状态码: 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 |
场地详情 |
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 |
机房环境条件 取值范围:
最小值:0 最大值:2 缺省值:0 |
space |
Integer |
机柜空间条件 取值范围:
最小值:0 最大值:2 缺省值:0 |
transport |
Integer |
运输条件 取值范围:
最小值:0 最大值:2 缺省值:0 |
installation |
String |
整柜安装评估 取值范围:
缺省值:UNCLEAR |
请求示例
创建边缘小站,区域为cn-north-4(北京四),部署位置为中国/安徽省/合肥市/瑶海区,机房暂不确定是否满足条件,机柜暂无扩容计划,运输通道和机房门的高度或宽度不满足要求,可支持整柜安装,并入现有机柜组
POST https://{ies_endpoint}/v1/{domain_id}/edge-sites { "edge_site" : { "name" : "测试站点", "description" : "测试站点:位于安徽", "region_id" : "cn-north-4", "location" : { "description" : "站点场地信息", "zone_code" : "CN", "address" : "安徽省 合肥市 瑶海区", "country" : "CN", "province" : "安徽省", "city" : "合肥市", "district" : "瑶海区", "condition" : { "environment" : 0, "space" : 0, "transport" : 0 } } } }
响应示例
状态码: 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, "enterprise_project_id" : "0", "status" : "initial", "location" : { "description" : "站点场地信息", "zone_code" : "CN", "address" : "安徽省 合肥市 瑶海区", "country" : "CN", "province" : "安徽省", "city" : "合肥市", "district" : "瑶海区", "condition" : { "environment" : 0, "space" : 0, "transport" : 0, "installation" : "SUPPORT" } }, "created_at" : "2022-04-15T07:59:20.641Z", "updated_at" : null } }
状态码
状态码 |
描述 |
---|---|
200 |
successful operation |
错误码
请参见错误码。