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

创建弹性公网IP

最近更新时间2024.03.25 10:17:51

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

本接口用于创建弹性公网 IP。

请求方法

POST

请求参数

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

名称

类型

是否必选

示例值

描述

Action

String

BatchCreateEIPInstances

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

Version

String

2021-04-30

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

cluster_names

[]String

["***-zzcu01"]

弹性公网 IP 所在节点的名称的列表。您可以通过 ListAvailableResourceInfo 接口查询支持的节点的信息。

eip_name

String

eip-123

弹性公网 IP 的名称。命名规则如下:

  • 允许 5~20 个字符。
  • 支持中文、大写字母、小写字母、数字。
  • 支持特殊字符 ()`~!@#$%^&*-+=_|{}[]:;'<>,.?/。 |
  • 不能包含双引号(")、反斜线( \)和 空格,且不能以正斜线(/)开头。

当您创建多个弹性公网 IP 时,系统会自动在您指定的弹性公网 IP 的名称后面按照以下规则添加后缀:<自定义名称>-<cluster_name><序号>。第一个创建出来的实例不会被添加序号。例如,如果您在 fjfzct01 节点创建了 3 个弹性公网 IP 并指定名称为 test,那么最终返回的弹性公网 IP 的名称将分别是 test-fjfzct01-CTCC,test-fjfzct01-CTCC-1,test-fjfzct01-CTCC-2。

eip_type

String

IPv4

弹性公网 IP 的类型:

  • IPv4:IPv4 类型。
  • IPv6:IPv6 类型。

isp

String

CMCC

运营商:

  • CMCC:中国移动。
  • CUCC:中国联通。
  • CTCC:中国电信。

说明

当您在三线节点创建弹性公网 IP 时,您必须设置该参数来指定运营商。例如,如果您将运营商指定为 CMCC,那么系统仅会创建一个使用中国移动线路的弹性公网 IP。

network_type

String

public

网络类型。取值:public

bandwidth_peak

Integer

20

带宽峰值。取值范围:20 ~ 5000。单位:Mbps。
取值只能是 5 的倍数。

desc

String

test

弹性公网 IP 的描述。最多可输入 80 个字符。

eip_num

Interget

2

弹性公网 IP 的数量。默认值:1。如果选择多个节点,将在每个节点下购买指定数量的弹性公网 IP。

project

String

default

弹性公网 IP 所属的项目。如果不指定该参数或参数值为空字符串,采用默认值 default

返回数据

名称

类型

示例值

描述

eip_instances

[]EIPInstance

请参见返回示例

弹性公网 IP 的列表。

请求示例

POST https://veenedge.volcengineapi.com/?Action=BatchCreateEIPInstances&Version=2021-04-30
&<其他公共参数>
{
  "cluster_names": [
    "****-fjfzct01"
  ],
  "eip_name": "test",
  "eip_type": "IPv4",
  "isp": "CTCC",
  "network_type": "public",
  "bandwidth_peak": 20
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202305241433367FA48D15F352EFF2****",
        "Action": "BatchCreateEIPInstances",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-north-1"
    },
    "Result": {
        "eip_instances": [
            {
                "account_identity": 210000****,
                "user_identity": 0,
                "eip_identity": "eip-r9bn5l****",
                "eip_name": "test-****-fjfzct01-CTCC",
                "cluster": {
                    "cluster_name": "****-fjfzct01",
                    "country": "CN",
                    "region": "EastChina",
                    "province": "FJ",
                    "city": "350100",
                    "isp": "CTCC",
                    "level": "2",
                    "alias": "福州电信01"
                },
                "eip_type": "IPv4",
                "eip_addr": "",
                "bandwidth_peak": 20,
                "isp": "CTCC",
                "network_type": "public",
                "status": "creating",
                "desc": "",
                "billing_config": {
                    "ip_billing_method": "MonthlyPeak",
                    "bandwidth_billing_method": "MonthlyP95"
                },
                "cluster_bwp_id": 72**,
                "create_time": 1684910017,
                "update_time": 1684910017
            }
        ]
    }
}

错误码

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