You need to enable JavaScript to run this app.
导航
批量开启边缘实例的 IPv6 功能
最近更新时间:2024.07.08 16:21:04首次发布时间:2023.03.24 15:51:06

本接口用于批量开启边缘实例的 IPv6 功能。

使用说明

前提条件:

  • 使用该接口前,需要先开通 IPv6 功能的使用权限。如需开通 IPv6 功能的使用权限,请提交工单申请。
  • 需要开启 IPv6 的边缘实例需处于运行中running)状态。
  • 需要开启 IPv6 的边缘实例必须开启了 IPv4 且镜像标签(label)为 IPv6。

请求说明

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

请求参数

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

Query

参数

类型

是否必选

示例值

描述

Action

String

EnableInstancesIPv6

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

Version

String

2021-04-30

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

Body

参数

类型

是否必选

示例值

描述

instance_identities

[]String

["veen1020125208252511****"]

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

with_reboot

Boolean

true

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

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

说明

重启实例后,IPv6 的配置才能生效。

返回参数

参数

类型

示例值

描述

instance_num

Integer

1

需要开启 IPv6 的边缘实例的总数量。

success_num

Integer

0

成功开启 IPv6 的边缘实例的数量。

fail_num

Integer

1

未能开启 IPv6 的边缘实例的数量。

instances

[]InstanceEnableIPv6Status

请参见返回示例

边缘实例的 IPv6 开启状态的列表。

说明

此时返回的数据可能不是最终的 IPv6 开启状态。您可以等待 5~10 秒之后,通过调用 GetInstancesIPv6UpgradeStatus 接口获取最终的 IPv6 开启状态。

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230525195023F316E646644CCEBA****",
        "Action": "EnableInstancesIPv6",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-north-1"
    },
    "Result": {
        "instance_num": 1,
        "success_num": 0,
        "fail_num": 0,
        "instances": [
            {
                "instance_identity": "veen2111270501017515****",
                "instance_name": "instance_test01",
                "enable_status": "upgrading",
                "remark": ""
            }
        ]
    }
}