本接口用于创建弹性公网 IP。
下表列出了接口特定的请求参数以及公共请求参数 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 的名称。命名规则如下:
当您创建多个弹性公网 IP 时,系统会自动在您指定的弹性公网 IP 的名称后面按照以下规则添加后缀:<自定义名称>-<cluster_name> |
eip_type | String | 是 | IPv4 | 弹性公网 IP 的类型:
|
isp | String | 否 | CMCC | 运营商:
说明 当您在三线节点创建弹性公网 IP 时,您必须设置该参数来指定运营商。例如,如果您将运营商指定为 CMCC,那么系统仅会创建一个使用中国移动线路的弹性公网 IP。 |
network_type | String | 是 | public | 网络类型。取值:public。 |
bandwidth_peak | Integer | 是 | 20 | 带宽峰值。取值范围:20 ~ 5000。单位:Mbps。 |
desc | String | 否 | test | 弹性公网 IP 的描述。最多可输入 80 个字符。 |
eip_num | Interget | 否 | 2 | 弹性公网 IP 的数量。默认值:1。如果选择多个节点,将在每个节点下购买指定数量的弹性公网 IP。 |
project | String | 否 | default | 弹性公网 IP 所属的项目。如果不指定该参数或参数值为空字符串,采用默认值 default。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
eip_instances | 请参见返回示例 | 弹性公网 IP 的列表。 |
POST https://veenedge.volcengineapi.com/?Action=BatchCreateEIPInstances&Version=2021-04-30 &<其他公共参数> { "cluster_names": [ "**ct01" ], "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-**ct01-CTCC", "cluster": { "cluster_name": "**ct01", "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 请求失败。关于错误码的更多信息,参见错误码。