You need to enable JavaScript to run this app.
导航
边缘计算节点
  • 文档首页
    • /
  • 边缘计算节点

批量设置边缘实例的带宽峰值

最近更新时间：2024.03.07 19:19:37

首次发布时间：2023.03.24 15:51:07

我的收藏

本接口用于批量设置边缘实例的带宽峰值。

接口说明

边缘实例需处于运行中（running）状态。

请求方法

POST

请求参数

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

名称

类型

是否必选

示例值

描述

Action

String

是

SetInstancesBandwidthPeak

公共参数。该参数表示接口名称。取值：SetInstancesBandwidthPeak。

Version

String

是

2021-04-30

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

instance_bandwidth_peak_map

Map[String]String

是

{
    "veen1020125208252511****": "50",
    "veen1020125208252511****": "100"
}

边缘实例的带宽峰值。

with_reboot

Boolean

是

true

是否重启实例。取值范围：

  • true：重启实例。
  • false：不重启实例。

说明

  • 对于私有网络型实例，您在为其修改带宽峰值后无需重启实例。新的带宽峰值会直接生效。因此，建议您将 with_reboot 参数设置为 false。
  • 对于直通型实例，您在为其修改带宽峰值后必须重启实例。这样，新的带宽峰值才会生效。您可以将 with_reboot 参数设置为 true，系统将自动重启实例。 如需使用直通型实例，请提交工单。
  • 如果您指定的实例中既包含私有网络型实例又包含直通型实例，且您将 with_reboot 参数设置为 true，系统仅会重启直通型实例。

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 的值（公网带宽峰值)，那么公网带宽峰值会被一同修改。

返回数据

无

请求示例

POST https://veenedge.volcengineapi.com/?Action=SetInstancesBandwidthPeak&Version=2021-04-30
&<其他公共参数>
{
  "instance_bandwidth_peak_map": {
        "veen2111270501017515****": "50",
        "veen2210222221323202****": "100"
    },
  "with_reboot": true
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2023052520240947C3E768D68C8B0C****",
        "Action": "SetInstancesBandwidthPeak",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-north-1"
    }
}

错误码

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