启动边缘实例--边缘计算节点-火山引擎

文档中心

立即注册

导航

边缘计算节点

启动边缘实例

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

本接口用于根据边缘实例 ID 启动实例。

接口说明

启动边缘实例时，边缘实例需处于已停止（stop）状态。

请求说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
instance_identities	[]String	是	["veen1020125208252511****"]	边缘实例 ID 列表。您可以通过 ListInstances 接口查询边缘实例 ID。

返回参数

该接口无特有的返回参数。

请求示例

POST https://veenedge.volcengineapi.com/?Action=StartInstances&Version=2021-04-30
&<其他公共参数>
{
  "instance_identities": [
    "veen2210222221323202****"
  ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202305251813095DF9F8DE0A115A17****",
        "Action": "StartInstances",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-north-1"
    }
}

错误码

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