You need to enable JavaScript to run this app.
导航

停止边缘实例

最近更新时间2023.07.06 10:45:55

首次发布时间2022.02.25 18:58:31

本接口用于根据边缘实例 ID 停止实例。

接口说明

停止边缘实例时,边缘实例需处于运行中running)状态。

请求方法

POST

请求参数

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

名称

类型

是否必选

示例值

描述

Action

String

StopInstances

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

Version

String

2021-04-30

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

instance_identities

[]String

["veen1020125208252511****"]

边缘实例 ID 列表。您可以通过 ListInstances 接口查询边缘实例 ID。

返回数据


请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230525180910750E7FA6C41FB1AB****",
        "Action": "StopInstances",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-north-1"
    }
}

错误码

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