创建IP地址池--边缘计算节点-火山引擎

文档中心

立即注册

边缘计算节点

请输入

IP地址池

创建IP地址池

本接口用于创建 IP 地址池。

使用说明

使用限制：
当前，如需使用 IP 地址池功能，请提交工单或联系客户经理进行申请。

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`CreateIpPool`	接口名称。当前 API 的名称为 `CreateIpPool`。
Version	String	是	`2021-04-30`	接口版本。当前 API 的版本为 `2021-04-30`。

Body

参数	类型	是否必选	示例值	描述
project	String	否	`default`	IP 地址池所属的项目。如果不设置该参数或参数值为空字符串，采用默认值 default。
Tags	Object[]	否	`-`	IP 地址池的标签。
billing_method	String	是	`MonthlyPeak`	计费方式。取值范围： DailyPeak：按日峰值计费。 MonthlyPeak：按月峰值计费。
desc	String	否	`used for testing env`	IP 地址池的描述。描述须符合以下要求：允许 0~255 个字符。支持汉字、大写字母、小写字母、数字和特殊字符 ()`~!@#$%^&*-+=_\|{}[]:;'<>,.?/。不能包含双引号（"）、反斜线（ \）和空格，且不能以正斜线（/）开头。
pool_name	String	否	`ip_pool_testing`	IP 地址池的名称。命名规则如下：允许 5~80 个字符。支持汉字、大写字母、小写字母、数字和特殊字符 ()`~!@#$%^&*-+=_\|{}[]:;'<>,.?/。不能包含双引号（"）、反斜线（\）和空格，且不能以正斜线（/）开头。如果您未指定 IP 地址池的名称，系统为其赋予默认名称“未命名”。
cidr_block_name	String	否	`cidr_01`	IP 地址段的名称。命名规则如下：允许 5~80 个字符。支持汉字、大写字母、小写字母、数字和特殊字符 ()`~!@#$%^&*-+=_\|{}[]:;'<>,.?/。不能包含双引号（"）、反斜线（ \）和空格，且不能以正斜线（/）开头。如果您未指定 IP 地址段的名称，系统为其赋予默认名称“未命名”。
cidr_blocks_by_mask	Integer[]	否	`[24,26]`	掩码。系统将按照您指定的掩码在 IP 地址池中创建 IP 地址段。取值范围： IPv4： 24~32。 IPv6： 120。 cidr_blocks 与 cidr_blocks_by_mask 参数不能同时指定。
cidr_blocks	String[]	否	`["12...0/24","17...0/26"]`	网段。系统将按照您指定的网段在 IP 地址池中创建 IP 地址段。 cidr_blocks 与 cidr_blocks_by_mask 参数不能同时指定。
isp	String	是	`CMCC`	线路类型。取值范围： CMCC：中国移动。 CUCC：中国联通。 CTCC：中国电信。
ip_version	String	是	`ipv4`	IP 协议版本。取值范围： ipv4 ipv6
network_type	String	是	`external`	IP地址池的网络类型。取值范围： external：公网。
cluster_name	String	是	`****-zzcu01`	IP 地址池所属节点的名称。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结果。

参数	类型	示例值	描述
ip_pool_id	String	`ippool-phh9wg28qk8****`	IP 地址池的 ID。
ip_cidr_block_ids	String[]	`ipcidr-s2nkfjc9rhg****`	IP 地址段的 ID。

请求示例

POST https://veenedge.volcengineapi.com/?Action=CreateIpPool&Version=2021-04-30
&<其他公共参数>
{
    "cluster_name": "****-zzcm01",
    "isp": "CMCC",
    "ip_version": "ipv4",
    "network_type": "external",
    "cidr_blocks": [
        "12.**.**.0/24"
    ],
    "cidr_block_name": "cidr_01",
    "pool_name": "ip_pool_testing",
    "billing_method": "MonthlyPeak"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2025072414312102513225210143****",
        "Action": "CreateIpPool",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-beijing"
    },
    "Result": {
        "ip_pool_id": "ippool-phh9wg28qk8****",
        "ip_cidr_block_ids": [
            "ipcidr-s2nkfjc9rhg****"
        ]
    }
}

错误码

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

最近更新时间：2026.01.07 16:45:02

这个页面对您有帮助吗？

有用

无用

边缘计算节点

使用说明 #

请求说明 #

请求参数 #

Query #

Body #

返回参数 #

请求示例 #

返回示例 #

错误码 #