4.1 边缘业务
4.1.1 创建部署计划
功能介绍
为方便您的统一管理，以及跨边缘站点管理资源，IEC基于业务场景角度，定义了边缘 业务。 边缘业务即为逻辑层面的一套资源管理集合。这里的资源主要是指计算实例，
包含实例规格、镜像、硬盘、网络等方面。通过指定计算实例的数量、调度策略以及 区域分布等形成一套管理集合。了解更多
创建一个部署计划并执行，即可创建一个边缘业务。
● 边缘业务下实例分布取决于部署计划的实例分布与调度策略。
● 边缘业务下实例名称、规格、镜像等参数取决于部署计划配置计算实例字段。
调试
您可以在API Explorer中调试该接口。
URI
POST /v1/deployments
请求参数
表4-1 请求 Header 参数
参数 是否必选 参数类型 描述
X-Auth-Token 是 String 用户Token。
通过调用IAM服务获取用户 Token接口获取（响应消息头中 X-Subject-Token的值）。
表4-2 请求 Body 参数
参数 是否必选 参数类型 描述
edgecloud 是 EdgeCloudO
ption object 待部署的边缘业务。
表4-3 EdgeCloudOption
参数 是否必选 参数类型 描述
name 否 String 边缘业务名称。 取值范围：只
能由中文字符、大小写英文字 母、数字及中划线、下划线组 成，且长度为[1-32]个字符。
最小长度：1 最大长度：32
id 否 String 已有边缘业务ID，该参数用于扩
容边缘业务场景。
说明
● id与name不可同时为空，同时 有值时部署计划无效；
● 通过id扩容场景要求区域分 布层级与原边缘业务一致；
● 区域分布层级为站点级的边 缘业务不支持扩容。
description 否 String 描述，缺省值为空字符串。
最小长度：0 最大长度：255 coverage 是 Coverage
object 边缘业务实例分布策略。
参数 是否必选 参数类型 描述
stack 是 Stack object 边缘业务资源组配置模板，边缘 业务中的计算实例将根据该参数 信息创建。
表4-4 Coverage
参数 是否必选 参数类型 描述
coverage_poli
cy 是 String 区域调度策略，只支持
centralize/discrete。
● centralize：代表城市集中策 略，指定该策略，边缘业务 创建时会保证将所有实例都 发放在同一个站点。
● discrete：代表城市分散，指 定该策略，边缘业务创建
coverage_sites 是 Array of CoverageSite objects
区域及购买数量列表。
表4-5 CoverageSite
参数 是否必选 参数类型 描述
site 是 String 站点名称。 具体信息可通过调
用“查询边缘站点列表”来查询 (注意：本字段区分大小写)。
demands 是 Array of Demand
operator 否 String 所属运营商。
demand_coun
pool_id 否 String 线路ID。 多线路场景下，将在 该线路下创建弹性公网IP。 resources 是 Array of
Resource objects
边缘业务的堆栈，即为资源组。
表4-8 Resource 952和RFC 1123命名规范，建议使 用a-zA-z或0-9以及中划线'-'组成的 名称命名，' _' 将在边缘实例内部 默认转化为'-'。
最小长度：1 最大长度：48
with_prefix 否 Boolean 是否自动添加名称前缀。
● with_prefix为false时不拼接 IEC前缀
● with_prefix不传或者传true 时拼自动IEC前缀
以name为iec为例： 不添加前 缀时实例名称为：iec-0001 自 动添加前缀实例名称为：IEC-ZS01-iec-0001 0001为创建边缘 业务时根据实例个数自动添加的 编号
缺省值：true
image_ref 是 String 待发放边缘实例的系统镜像，需 要指定已创建镜像的ID。
说明镜像的ID可以从控制台或者参考本 文档的“查询边镜像列表”的章节 获取。
flavor_ref 是 String 边缘实例的系统规格的ID。
参数 是否必选 参数类型 描述
admin_pass 否 String 如果需要使用密码方式登录边缘 实例，可使用admin_pass字段
● Windows系统密码不能包含 用户名或用户名的逆序，不
key_name 否 String 密钥对名称。
net_config 是 NetConfig
object 实例的边缘网络配置。 包含了 边缘网络的网段信息和子网数目 信息。
bandwidth 否 BandwidthCo
nfig object 实例的带宽参数。 IEC服务现在 提供共享带宽服务，暂不支持其 他类型带宽。
说明
创建边缘业务时指定实例同步创建 EIP则需通过此参数指定。
root_volume 是 RootVolume
object 边缘实例对应系统盘相关配置。
data_volumes 否 Array of DataVolume
参数 是否必选 参数类型 描述 security_grou
ps 否 Array of
SecurityGrou pOption objects
边缘业务对应安全组信息。
user_data 否 String 创建边缘实例过程中注入用户数 据。支持注入文本、文本文件或 gzip文件。 更多关于待注入用 户数据的信息，请参见《弹性云 服务器用户指南 》的“用户数
据注入”章节。
表4-9 NetConfig
参数 是否必选 参数类型 描述
vpc_id 是 String 边缘网络ID。
约束：
● 创建边缘业务仅支持使用系 统规划的虚拟私有云。
nic_num 是 Integer 边缘实例绑定的网卡数量。
约束：一台边缘实例最少绑定一 张网卡，最多绑定8张网卡。
最小值：1 最大值：8
表4-10 BandwidthConfig
参数 是否必选 参数类型 描述
sharetype 是 String 带宽类型，现支持WHOLE类 型，即共享带宽，其他类型不支 持。
枚举值：
● WHOLE
size 否 Integer 带宽（Mbit/s）。
表4-11 RootVolume
参数 是否必选 参数类型 描述
size 是 Integer 系统盘大小，容量单位为GB，
输入大小范围为[40,100]。
最小值：40 最大值：100
volume_type 是 String 边缘实例系统盘对应的磁盘类 型，需要与站点所提供的磁盘类 型相匹配。
表4-12 DataVolume
参数 是否必选 参数类型 描述
size 是 Integer 数据盘大小，容量单位为GB，
输入大小范围为[1,500]。
最小值：1 最大值：500
volume_type 是 String 边缘实例数据盘对应的磁盘类 型，需要与站点所提供的磁盘类 型相匹配。
表4-13 SecurityGroupOption
参数 是否必选 参数类型 描述
id 否 String 边缘实例的安全组，会对边缘实
例中配置的网卡生效。需要指定 已有安全组的ID。不填写时选择 默认安全组
响应参数
状态码： 200
表4-14 响应 Body 参数
参数 参数类型 描述
id String 部署计划ID。
locations Array of Location objects
部署位置信息列表。
表4-15 Location
参数 参数类型 描述
site_id String 站点ID。
area String 所在大区。
province String 所属省份英文名称。 大小写通用，皆支持
city String 所在城市英文名称。
operator String 所属运营商。
枚举值：
● chinamobile
● chinaunicom
● chinatelecom
pool_id String 线路ID。多线路场景下，创建的弹性公网IP在该 线路下。
stack_count Integer 站点需要发放的资源(组)总数。
city_short_na
me String 城市简称。
请求示例
POST https://{endpoint}/v1/deployments { "edgecloud" : {
"stack" : {
"name" : "stack-fo09", "resources" : [ {
"name" : "edgeinstance1",
"image_ref" : "00000000-0000-0000-0000-000000000002", "flavor_ref" : "c6.large.2",
"net_config" : {
"vpc_id" : "4a6d9663-475f-11eb-aa7c-fa16406a65c4", "nic_num" : 1
"id" : "153133f5-2b16-11eb-a594-fa16408859a1"
} ],
"coverage_level" : "city", "coverage_policy" : "centralize", "coverage_sites" : [ {
"name" : "edgecloud1"
}}
响应示例
状态码： 200 OK
{ "id" : "87b9a88c-499d-11eb-8a8a-fa1640495574", "locations" : [ {
"site_id" : "74a75ed3-cfb9-11ea-a0c3-fa1640495574", "area" : "north",
"province" : "shaanxi", "city" : "xi'an", "operator" : "bgp",
"pool_id" : "5_bgp_edgecloud-site4_0", "stack_count" : 1,
"city_short_name" : ""
} ]
您可以在API Explorer中调试该接口。
URI
GET /v1/deployments