新增边缘实例--边缘计算节点-火山引擎

文档中心

立即注册

导航

边缘计算节点

新增边缘实例

最近更新时间：2024.07.08 16:21:01首次发布时间：2022.02.25 18:58:31

本接口用于创建边缘实例。

使用说明

新增边缘实例时，您需要选择已创建的边缘服务。因此新增实例的配置将继承边缘服务当前的实例配置。

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	CreateInstance	公共参数。该参数表示接口名称。取值：CreateInstance。
Version	String	是	2021-04-30	公共参数。该参数表示接口版本。取值：2021-04-30。

Body

参数	类型	是否必选	示例值	描述
cloud_server_identity	String	是	cloudserver-8bvl8r6xcng****	边缘实例所属的边缘服务的 ID。您可以通过 ListCloudServers 接口查询边缘服务的 ID。
instance_area_nums	[]InstanceAreaNum	是	`[ { "cluster_name":"****-gdgzct06", "num": 1 } ]`	边缘实例的地域信息。
billing_config	CreateInstanceBillingConfigs	否	`{ "pre_paid_period": "monthly", "pre_paid_period_number": "3", "auto_renew": false }`	包年包月实例的计费配置。该参数在计费方式为包年包月时必须指定。
create_instance_timeout	Integer	否	120	说明该参数仅适用于后付费实例。边缘实例的创建超时时间。单位：秒。最小值：120。当边缘实例的创建时长超过设置的值时，边缘实例创建失败，其状态变为 open_fail。您可以通过控制台或 API 接口来删除相关实例。如果不指定该参数的值，代表不限制实例创建时长。
client_token	String	否	123e-34bd-4ffsc****	接口幂等参数。参数值只能包含ASCII字符，且不能超过64个字符。字符大小写敏感。更多信息，请参见幂等性说明。
limit_mode	String	否	isp	限速模式。当您使用多线节点时，您可以配置边缘实例的限速模式。取值范围： shared（默认值）：共享限速。各运营商共享带宽资源，占用的总公网带宽不超过设置的 bandwidth_peak 的值（公网带宽峰值)。 isp：按运营商限速。您可以为每个运营商分别设置带宽峰值。说明您需要提交工单开通多线节点的权限后，该参数才可使用；否则参数值无效。公网配置限制：单网卡多IP、多网卡多IP支持按运营商限速和共享限速。单网卡单IP、单网卡联通IP、单网卡电信IP、单网卡移动IP仅支持共享限速。
bandwidth_peak_limit_isp_configs	BandwidthPeakLimitIspConfig	否	[{"isp":"CMCC","bandwidth_peak_limit":"10"},{"isp":"CTCC","bandwidth_peak_limit":"0"},{"isp":"CUCC","bandwidth_peak_limit":"10"}]	分运营商配置的限速带宽。当您选择按运营商限速（isp）模式时，传入的参数值才会生效。移动公网带宽峰值：默认值等于公网带宽峰值。取值须是 5 的倍数。单位是 Mbps。联通公网带宽峰值：默认值为 0。取值须是 5 的倍数。单位是 Mbps。电信公网带宽峰值：默认值为 0。取值须是 5 的倍数。单位是 Mbps。说明您需要提交工单开通多线节点的权限后，该参数才可使用；否则参数值无效。如果您设置的各运营商带宽峰值之和超过了设置的 bandwidth_peak 的值（公网带宽峰值)，那么公网带宽峰值会被一同修改。

返回参数

参数	类型	示例值	描述
instance_id_list	[]String	["veen2202012110000220****"]	边缘实例 ID 列表。
pre_paid_url	String	Order7294553339923****	订单号。计费方式为包年包月时，会返回该参数。当您通过 API 接口创建包年包月实例时，系统默认自动创建资源并使用您的账户余额或信控额度进行支付。如果您的账户余额或信控额度不足以支付资源费用，系统会返回错误消息。如果扣款成功但是实例创建失败，您可以提交工单或联系客服来取消该订单，或者等待系统自动取消该订单。实例创建失败后，系统会在 12 小时后自动取消该订单。订单取消后，费用将原路退回。

请求示例

POST https://veenedge.volcengineapi.com/?Action=CreateInstance&Version=2021-04-30
&<其他公共参数>
{
  "cloud_server_identity": "cloudserver-28qt4gbvknp****",
  "instance_area_nums": [
    {
      "cluster_name":"****-gdgzct06",
      "num": 1
    }
  ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202305311922559FC62FDDC9C3A6B6****",
        "Action": "CreateInstance",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-north-1"
    },
    "Result": {
        "instance_id_list": [
            "veen9352113250020352****"
        ]
    }
}

错误码

如果响应正文中包含 Error 字段，则表示 API 请求失败。关于错误码的更多信息，参见错误码。