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

获取私网 IP 地址列表

最近更新时间：2023.07.03 16:32:44

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

我的收藏

本接口用于获取边缘实例的私网 IP 地址的列表。

请求方法

GET

请求参数

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

名称

类型

是否必选

示例值

描述

Action

String

是

ListInstanceInternalIps

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

Version

String

是

2021-04-30

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

instance_identity

String

是

veen1020125208252511****

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

返回数据

名称

类型

示例值

描述

internal_ips

[]InternalIP

[
    {
        "addr": "172.22.**.**",
        "mask": "22",
        "ip_version": "ipv4",
        "primary": true,
        "status": "unbound"
    }
]

私网 IP 地址的列表。

bound_eip_share_bandwidth_peak

Integer

500

弹性公网 IP 的共享带宽峰值。单位：Mbps。

bwp_status

String

ready

弹性公网 IP 的共享带宽峰值的状态：

  • updating：更新中。
  • ready：已就绪。

wanted_secondary_ip_num

Integer

6

所需辅助私网 IP 地址的数量。

actual_secondary_ip_num

Integer

3

实际已分配的辅助私网 IP 地址的数量。

allocating_secondary_ip_num

Integer

1

分配中的辅助私网 IP 地址的数量。

allocate_fail_secondary_ip_num

Integer

1

分配失败的辅助私网 IP 地址的数量。

deleting_secondary_ip_num

Integer

1

删除中的辅助私网 IP 地址的数量。

请求示例

GET https://veenedge.volcengineapi.com/?Action=ListInstanceInternalIps&Version=2021-04-30
&instance_identity=veen2111270501017515****
&<其他公共参数>

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202305252029016ADF3E5E12FB84CC****",
        "Action": "ListInstanceInternalIps",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-north-1"
    },
    "Result": {
        "internal_ips": [
            {
                "addr": "172.**.**.194",
                "mask": "26",
                "ip_version": "ipv4",
                "primary": true,
                "status": "unbound"
            }
        ],
        "bound_eip_share_bandwidth_peak": "",
        "bwp_status": "ready",
        "wanted_secondary_ip_num": 2,
        "actual_secondary_ip_num": 2,
        "allocating_secondary_ip_num": 0,
        "allocate_fail_secondary_ip_num": 0,
        "deleting_secondary_ip_num": 0
    }
}

错误码

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