You need to enable JavaScript to run this app.
导航
创建边缘服务
最近更新时间:2024.07.08 16:21:00首次发布时间:2022.02.25 18:58:31

本接口用于创建边缘服务。
边缘服务是逻辑层面的资源集合,可以看作一组边缘实例。通过边缘服务同时创建的所有边缘实例拥有相同的配置,包括实例规格、存储、镜像、网络、调度策略等。

使用说明

使用限制:

  • 默认一个火山引擎账号最多可创建 5 个边缘服务,一个边缘服务中最多可创建 10 个边缘实例。如果您需要创建更多的边缘服务或边缘实例,请提交工单申请。
  • 创建边缘服务时,需要指定实例规格、选择地域和运营商。您可以通过 ListInstanceTypes 接口查看可开通的实例规格,通过 ListAvailableResourceInfo 接口查看实例规格支持的地域和运营商。

请求说明

  • 请求方式:POST
  • 请求地址:https://veenedge.volcengineapi.com/?Action=CreateCloudServer&Version=2021-04-30

请求参数

下表列出了接口特定的请求参数以及公共请求参数 Action 和 Version。 其他公共参数,请参见公共参数

Query

名称

类型

是否必选

示例值

描述

Action

String

CreateCloudServer

公共参数。该参数表示接口名称。取值:CreateCloudServer。

Version

String

2021-04-30

公共参数。该参数表示接口版本。取值:2021-04-30。

Body

参数

类型

是否必选

示例值

描述

cloudserver_name

String

cloud-test

边缘服务名称。命名规则如下:

  • 允许 5~20 个字符。
  • 支持中文、大写字母、小写字母、数字。
  • 支持特殊字符 ()`~!@#$%^&*-+=_|{}[]:;'<>,.?/。 |
  • 不能包含双引号(")、反斜线( \)和空格,且不能以正斜线(/)开头。

image_id

String

image87uiy8****

镜像 ID。您可以通过 ListImages 接口查询镜像 ID。

spec_name

String

veEN.G1.large

边缘实例规格名称。您可以通过 ListInstanceTypes 接口查询可开通的实例规格。如果您需要的规格不在可开通实例规格列表,请提交工单申请。

storage_config

StorageConfig

{
  "system_disk": {
    "capacity": "40",
    "storage_type": "CloudBlockSSD"
  }
}

存储配置,包括系统盘和数据盘的类型和容量信息。
详情请参见 StorageConfig

network_config

NetworkConfigReq

{
  "bandwidth_peak": "20",
  "enable_ipv6": false
}

网络配置。
详情请参见 NetworkConfigReq

secret_config

SecretConfig

{
  "secret_type": 2,
  "secret_data": "My_password"
}

边缘实例的登录密码设置。
详情请参见 SecretConfig

instance_area_nums

[]InstanceAreaNum

[
  {
    "cluster_name": "zj**05",
    "num": 1
  }
]

边缘实例的地域或节点信息以及边缘实例的个数。
详情请参见 InstanceAreaNum
如果不指定该参数,代表不创建边缘实例。

schedule_strategy

ScheduleStrategy

{
  "schedule_strategy": "dispersion",
  "price_strategy": "high_priority"
}

调度策略。
不设置该参数时,默认按照城市分散、低价优先策略。
服务层级为城市级时,无需设置该参数,按照城市分散、低价优先策略。如果该参数设置为其他值,策略将不生效。建议您将该参数留空。
服务层级为大区级时,按照设置的策略生效。

custom_data

CustomData

{
  "data": ""
}

自定义数据。自定义数据为边缘实例的定制信息。最大可输入 16 KB 的自定义数据。

说明

自定义数据只支持 Shell 脚本。您需要使用明文方式输入脚本,系统将自动对脚本进行 Base64 编码。请勿直接输入 Base64 编码后的脚本。对于 Linux 系统,脚本通常以 !/bin/bash 开头;对于 Windows 系统,脚本可以直接输入。
输入的脚本将在边缘实例首次启动时执行。

billing_config

CreateCloudServerBillingConfigs

{
  "computing_billing_method": "MonthlyPeak",
  "bandwidth_billing_method": "MonthlyP95"
}

计费方式,包括算力和带宽的计费方式。
详情请参见 CreateCloudServerBillingConfigs

advanced_configuration

AdvancedConfiguration

{
  "instance_name":"aaaaa",
  "instance_desc":"test",
  "instance_host_name":"bbbbb",
}

高级配置,用于自定义边缘实例名称、实例描述信息、主机名称。批量创建边缘实例时,将按照自定义名称顺序生成边缘实例名和主机名。

project

String

default

通过边缘服务创建的实例所属的项目。
如果不设置该参数或参数值为空字符串,采用默认值 default

disable_vga

Boolean

false

是否禁用 VGA。取值范围:

  • true:禁用 VGA。
  • false(默认值):开启 VGA。

该参数仅适用于云游戏型边缘实例。当您开启了 VGA 功能后,将可以使用 VNC 方式登录边缘实例,但该功能可能会影响边缘实例的性能。如果不开启该功能,边缘实例的性能不受影响,但您将无法直接通过 VNC 方式登录边缘实例。更多信息,请参见使用VGA功能时,应该注意哪些事项?

cloud_server_desc

String

cloud-server-test

边缘服务的描述信息。最多可输入 80 个字符。

create_instance_timeout

Integer

120

说明

该参数仅适用于后付费实例。

边缘实例的创建超时时间。单位:秒。最小值:120。
当边缘实例的创建时长超过设置的值时,边缘实例创建失败,其状态变为 open_fail。您可以通过控制台或 API 接口来删除相关实例。
如果不指定该参数的值,代表不限制实例创建时长。

client_token

String

123e-34bd-4ffsc****

接口幂等参数。参数值只能包含ASCII字符,且不能超过64个字符。字符大小写敏感。
更多信息,请参见幂等性说明

tags

[]Tag

{
  {
      "key": "test_key1",
      "value": "test_value1"
  },
  {
      "key": "test_key2",
      "value": "test_value2"
  }
}

边缘实例的标签。标签(Tag)由一个标签键(Key)和一个标签值(Value)组成。
使用标签功能时,请您注意以下事项:

  • 只能创建自定义标签。
  • 如果您在创建边缘服务时设置了标签,随边缘服务创建的边缘实例会自动绑定设置的标签。
  • 如果一个边缘实例需要绑定多个标签,标签键不能相同。
  • 同一边缘服务下设置的标签键必须唯一。如果设置的标签键已经存在,新的标签值将会覆盖旧的标签值。
  • 一次最多可以设置50个标签。
  • 更多关于标签的说明,请参见Tag

返回参数

参数

类型

示例值

描述

cloud_server_identity

String

cloudserver-qkjrw9rg6dd****

边缘服务的 ID。

pre_paid_url

String

Order7294553339923****

订单号。计费方式为包年包月时,会返回订单号。
当您通过 API 接口创建包年包月实例时,系统默认自动创建资源并使用您的账户余额或信控额度进行支付。
如果您的账户余额或信控额度不足以支付资源费用,系统会返回错误消息。如果扣款成功但是实例创建失败,您可以提交工单或联系客服来取消该订单,或者等待系统自动取消该订单。实例创建失败后,系统会在 12 小时后自动取消该订单。订单取消后,费用将原路退回。

请求示例

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 请求失败。关于错误码的更多信息,参见错误码