文档首页/ CloudPond云服务/ API参考/ API/ 边缘小站/ 更新边缘小站
更新时间：2024-05-10 GMT+08:00
查看PDF
分享

更新边缘小站

功能介绍

更新边缘小站。

  • 允许更新边缘小站描述或场地信息。
  • 该接口支持企业项目细粒度权限的校验，具体细粒度请参见 ies:edgeSite:update

调试

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

URI

PUT /v1/{domain_id}/edge-sites/{site_id}

表1 路径参数

参数

是否必选

参数类型

描述

domain_id

是

String

path中租户的账号ID

最大长度：36

site_id

是

String

边缘小站ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token
表3 请求Body参数

参数

是否必选

参数类型

描述

edge_site

是

UpdateEdgeSite object

待更新的边缘小站参数
表4 UpdateEdgeSite

参数

是否必选

参数类型

描述

description

否

String

](tag:hws)描述，最大支持长度为255个字节，不允许包含<>

最大长度：255

location

否

UpdateLocation object

场地信息
表5 UpdateLocation

参数

是否必选

参数类型

描述

name

否

String

场地名称（已废弃），传入该参数不会再生效，新建站点也不会再返回该字段

country

否

String

场地所在国家（逐步下线，使用zone_code替代），传入该参数不会再生效

province

否

String

场地所在省/自治区/直辖市

最小长度：1

最大长度：64

city

否

String

场地所在市/区

最小长度：1

最大长度：64

district

否

String

场地所在区/县

最小长度：1

最大长度：64

condition

否

UpdateCondition object

场地条件

description

否

String

场地描述，最大支持长度为255个字节，不允许包含<>

最大长度：255
表6 UpdateCondition

参数

是否必选

参数类型

描述

environment

否

Integer

机房环境条件 取值范围：

  • 0：机房条件不属于上述任何一种情况
  • 1：机房使用模块化数据中心方案进行建设
  • 2：机房已通过国家级或行业级标准化认证

最小值：0

最大值：2

space

否

Integer

机柜空间条件

  • 0：暂无扩容计划，不考虑额外余量
  • 1：机柜余量相对充裕，可放置空间超过3柜
  • 2：机柜余量相对紧张，可放置空间3柜以内

最小值：0

最大值：2

transport

否

Integer

运输条件 取值范围：

  • 0：运输通道和机房门的高度或宽度不满足要求
  • 1：运输通道，货梯，机房门均可满足整机柜滚轮搬运
  • 2：运输通道，货梯，机房门不能支持整机柜滚轮搬运，沿途有台阶

最小值：0

最大值：2

installation

否

String

整柜安装评估 取值范围：

  • UNCLEAR：不清楚是否允许整柜安装，需要评估
  • UNSUPPORT：不允许整柜安装，需将设备放入现有机柜
  • SUPPORT：可支持整柜安装，并入现有机柜组

响应参数

状态码： 200

表7 响应Body参数

参数

参数类型

描述

edge_site

EdgeSiteDetail object

边缘小站详情
表8 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

边缘小站的部署状态

location

LocationDetail object

场地详情

created_at

String

边缘小站创建时间

updated_at

String

边缘小站更新时间
表9 LocationDetail

参数

参数类型

描述

name

String

场地名称（已废弃），传入该参数不会再生效，新建站点也不会再返回该字段

description

String

场地描述

zone_code

String

场地所在地区

address

String

部署位置

country

String

场地所在国家（逐步下线，使用zone_code替代）

province

String

场地所在省/自治区/直辖市

city

String

场地所在市/区

district

String

场地所在区/县

condition

Condition object

场地条件
表10 Condition

参数

参数类型

描述

environment

Integer

机房环境条件 取值范围：

  • 0：机房条件不属于上述任何一种情况
  • 1：机房使用模块化数据中心方案进行建设
  • 2：机房已通过国家级或行业级标准化认证

最小值：0

最大值：2

缺省值：0

space

Integer

机柜空间条件 取值范围：

  • 0：暂无扩容计划，不考虑额外余量
  • 1：机柜余量相对充裕，可放置空间超过3柜
  • 2：机柜余量相对紧张，可放置空间3柜以内

最小值：0

最大值：2

缺省值：0

transport

Integer

运输条件 取值范围：

  • 0：运输通道和机房门的高度或宽度不满足要求
  • 1：运输通道，货梯，机房门均可满足整机柜滚轮搬运
  • 2：运输通道，货梯，机房门不能支持整机柜滚轮搬运，沿途有台阶

最小值：0

最大值：2

缺省值：0

installation

String

整柜安装评估 取值范围：

  • UNCLEAR：不清楚是否允许整柜安装，需要评估
  • UNSUPPORT：不允许整柜安装，需将设备放入现有机柜
  • SUPPORT：可支持整柜安装，并入现有机柜组

缺省值：UNCLEAR

请求示例

  • 更新边缘小站，部署位置为中国/安徽省/合肥市/瑶海区，机房暂不确定是否满足条件，机柜暂无扩容计划，运输通道和机房门的高度或宽度不满足要求，可支持整柜安装，并入现有机柜组 
    PUT https://{ies_endpoint}/v1/{domain_id}/edge-sites/{site_id}

{
  "edge_site" : {
    "description" : "测试站点：位于安徽",
    "location" : {
      "description" : "测试站点场地信息",
      "country" : "CN",
      "province" : "安徽省",
      "city" : "合肥市",
      "district" : "瑶海区",
      "condition" : {
        "environment" : 0,
        "space" : 0,
        "transport" : 0,
        "installation" : "SUPPORT"
      }
    }
  }
}
  • 更新边缘小站 
    PUT https://{ies_endpoint}/v1/{domain_id}/edge-sites/{site_id}

{
  "edge_site" : {
    "description" : "边缘小站更新",
    "location" : {
      "description" : "测试站点场地信息",
      "condition" : {
        "environment" : 0,
        "space" : 0,
        "transport" : 0,
        "installation" : "SUPPORT"
      }
    }
  }
}

响应示例

状态码： 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"
      }
    },
    "created_at" : "2022-04-15T07:59:20.641Z",
    "updated_at" : "2022-04-15T08:59:20.641Z"
  }
}

状态码

状态码

描述

200

successful operation

错误码

请参见错误码。

父主题： 边缘小站

相关文档