本接口用于创建边缘服务。
边缘服务是逻辑层面的资源集合,可以看作一组边缘实例。通过边缘服务同时创建的所有边缘实例拥有相同的配置,包括实例规格、存储、镜像、网络、调度策略等。
使用限制:
下表列出了接口特定的请求参数以及公共请求参数 Action 和 Version。 其他公共参数,请参见公共参数。
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | CreateCloudServer | 公共参数。该参数表示接口名称。取值:CreateCloudServer。 |
Version | String | 是 | 2021-04-30 | 公共参数。该参数表示接口版本。取值:2021-04-30。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
cloudserver_name | String | 是 | cloud-test | 边缘服务名称。命名规则如下:
|
image_id | String | 是 | image87uiy8**** | 镜像 ID。您可以通过 ListImages 接口查询镜像 ID。 |
spec_name | String | 是 | veEN.G1.large | 边缘实例规格名称。您可以通过 ListInstanceTypes 接口查询可开通的实例规格。如果您需要的规格不在可开通实例规格列表,请提交工单申请。 |
storage_config | 是 |
| 存储配置,包括系统盘和数据盘的类型和容量信息。 | |
network_config | 是 |
| 网络配置。 | |
secret_config | 是 |
| 边缘实例的登录密码设置。 | |
instance_area_nums | 否 |
| 边缘实例的地域或节点信息以及边缘实例的个数。 | |
schedule_strategy | 否 |
| 调度策略。 | |
custom_data | 否 |
| 自定义数据。自定义数据为边缘实例的定制信息。最大可输入 16 KB 的自定义数据。 说明 自定义数据只支持 Shell 脚本。您需要使用明文方式输入脚本,系统将自动对脚本进行 Base64 编码。请勿直接输入 Base64 编码后的脚本。对于 Linux 系统,脚本通常以 | |
billing_config | 是 |
| 计费方式,包括算力和带宽的计费方式。 | |
advanced_configuration | 否 |
| 高级配置,用于自定义边缘实例名称、实例描述信息、主机名称。批量创建边缘实例时,将按照自定义名称顺序生成边缘实例名和主机名。 | |
project | String | 否 | default | 通过边缘服务创建的实例所属的项目。 |
disable_vga | Boolean | 否 | false | 是否禁用 VGA。取值范围:
该参数仅适用于云游戏型边缘实例。当您开启了 VGA 功能后,将可以使用 VNC 方式登录边缘实例,但该功能可能会影响边缘实例的性能。如果不开启该功能,边缘实例的性能不受影响,但您将无法直接通过 VNC 方式登录边缘实例。更多信息,请参见使用VGA功能时,应该注意哪些事项? |
cloud_server_desc | String | 否 | cloud-server-test | 边缘服务的描述信息。最多可输入 80 个字符。 |
create_instance_timeout | Integer | 否 | 120 | 说明 该参数仅适用于后付费实例。 边缘实例的创建超时时间。单位:秒。最小值:120。 |
client_token | String | 否 | 123e-34bd-4ffsc**** | 接口幂等参数。参数值只能包含ASCII字符,且不能超过64个字符。字符大小写敏感。 |
tags | []Tag | 否 |
| 边缘实例的标签。标签(Tag)由一个标签键(Key)和一个标签值(Value)组成。
|
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
cloud_server_identity | String | cloudserver-qkjrw9rg6dd**** | 边缘服务的 ID。 |
pre_paid_url | String | Order7294553339923**** | 订单号。计费方式为包年包月时,会返回订单号。 |
POST https://veenedge.volcengineapi.com/?Action=CreateCloudServer&Version=2021-04-30 &<其他公共参数> { "cloudserver_name": "cloud-test", "image_id": "imagepnjk4y****", "spec_name": "veEN.G1.large", "storage_config": { "system_disk": { "storage_type": "CloudBlockSSD", "capacity": "50" }, "data_disk": { "storage_type": "CloudBlockSSD", "capacity": "20" } }, "network_config":{ "bandwidth_peak": "20" }, "secret_config": { "secret_type": 2, "secret_data":"My_password" }, "billing_config": { "computing_billing_method":"MonthlyPeak", "bandwidth_billing_method":"MonthlyP95" }, "instance_area_nums": [ { "cluster_name": "zj**05", "num": 1 } ] }
{ "ResponseMetadata": { "RequestId": "20230519170908A23BB9F74AC95F68****", "Action": "CreateCloudServer", "Version": "2021-04-30", "Service": "veenedge", "Region": "cn-north-1" }, "Result": { "cloud_server_identity": "cloudserver-hgvbfwkpnsq****", "instance_id_list": [ "veen2374342702077441****" ] } }
如果响应正文中包含 Error 字段,则表示 API 请求失败。关于错误码的更多信息,参见错误码。