批量变更实例规格--边缘计算节点-火山引擎

文档中心

立即注册

导航

边缘计算节点

批量变更实例规格

最近更新时间：2024.07.08 16:21:05首次发布时间：2023.09.05 19:19:42

本接口用于变更边缘实例的实例规格。
当您提交变更后，边缘实例会立即自动启动。实例启动完成后，变更后的实例规格生效。

使用说明

前提条件：
需要变更实例规格的边缘实例须处于已停止状态。

请求说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
instance_identities	[]String	是	["veen1020125208252511****"]	边缘实例 ID 列表。您可以通过 ListInstances 接口查询边缘实例 ID。
new_spec_name	String	是	veEN.G1.large	新的实例规格的名称。您可以通过 ListInstanceTypes 接口查询可开通的实例规格。

返回参数

参数	类型	示例值	描述
pre_paid_url	String	Order7294553339923****	订单号。计费方式为包年包月且变更实例规格后需要支付资源费用差额的情况下，会返回该参数。该情况下，系统默认使用您的账户余额或信控额度进行支付。如果您的账户余额或信控额度不足以支付资源费用差额，系统会返回错误消息。如果扣款成功但是变配失败，系统会取消变配订单并退回差额费用。如有任何疑问，请提交工单或联系客服进行咨询。关于变配的费用说明，请参考变更包年包月资源规格。

请求示例

POST https://veenedge.volcengineapi.com/?Action=UpdateInstancesSpec&Version=2021-04-30
&<其他公共参数>
{
  "instance_identities": ["veen2111270501017515****"],
  "new_spec_name": "veEN.G1.large"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230905165735619B436E2CF6332E****",
        "Action": "UpdateInstancesSpec",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-north-1"
    }
}

错误码

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