CreateIpAddressPool--公网IP-火山引擎

文档中心

立即注册

导航

CreateIpAddressPool

最近更新时间：2024.11.18 10:48:27首次发布时间：2024.09.06 10:16:24

调用 CreateIpAddressPool 接口，创建IP地址池。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

参数名称	类型	是否必选	示例值	描述
Action	String	是	CreateIpAddressPool	要执行的操作，取值：CreateIpAddressPool。
Version	String	是	2020-04-01	API的版本信息，当前版本为2020-04-01。
CidrBlock	String	否	101.0.XX.XX/24	IP地址网段。仅支持IPv4地址段，且不能以0开头，掩码取值范围：23~30。说明仅支持配置 `CidrBlock` 与 `CidrMask`其中之一。
CidrMask	Integer	否	24	IP地址网段掩码，取值范围：24~28。输入掩码后，IP 地址网段将自动分配。说明仅支持配置 `CidrBlock` 与 `CidrMask`其中之一。
ISP	String	是	BGP	线路类型，取值如下： BGP：BGP（多线）。若您的账号已申请并开通了静态单线权限，则可传入如下取值： ChinaMobile：中国移动静态单线。 ChinaTelecom：中国电信静态单线。 ChinaUnicom：中国联通静态单线。若您的账号已申请并开通了BGP单线权限，则可传入SingleLine_BGP。若您的账号已申请并开通了融合BGP权限，则可传入Fusion_BGP。若您的账号已申请并开通了惠选型静态单线权限，则可传入如下取值： ChinaMobile_Value：中国移动惠选型静态单线。 ChinaUnicom_Value：中国联通惠选型静态单线。 ChinaTelecom_Value：中国电信惠选型静态单线。
Name	String	否	IpAddressPool01	IP地址池的名称。长度限制为 1 ~ 128个字符。需要以字母或数字开头，不能以 http:// 或 https://.开头。可包含字母、数字、引号（：）、下划线（_）和短划线（-）。不填默认为空。
Description	String	否	238q08230***	IP地址池的描述。长度限制为 1 ~ 255 个字符。需要以字母、中文或数字开头，不能以 http:// 或 https://. 开头。可包含英文逗号（,）、点号（.）、下划线（_）、空格（）、等号（=）、短横线（-）、中文逗号（，）、中文句号（。）。不填默认为空。
ProjectName	String	否	Project_1	IP地址池所属项目的名称。不填默认加入default项目。
Tags.N.Key	String	否	Tags.1.Key=key1&Tags.2.Key=key2	用户标签的标签键。参数 - N：表示标签键的序号，取值范围：1～50。多个标签键之间用&分隔。不能以 `volc:`或`sys:`开头，包括任意大小写形式。长度取值范围为1~128字符，允许输入各国语言文字、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、中划线（-）和@（@）。若标签键开头或结尾存在空格，系统会自动为其去除。同一资源的标签键不允许重复。
Tags.N.Value	String	否	Tags.1.Value=value1&Tags.2.Value=value2	用户标签的标签值。参数 - N：表示标签值的序号，取值范围：1～50。多个标签值之间用&分隔。长度取值范围为0～256字符，不填默认为空。允许输入各国语言文字、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、中划线（-）和@（@）。大小写敏感。若标签值开头或结尾存在空格，系统会自动为其去除。若传入该参数，则必须先传入`Tags.N.Key`。
ClientToken	String	否	123e4567-e89b-12d3-a456-42665544****	保证请求幂等性。由客户端自动生成一个参数值，确保不同请求间该参数值唯一，避免当调用API超时或服务器内部错误时，客户端多次重试导致重复性操作。取值：仅支持ASCII字符，且不能超过64个字符。

返回数据

参数名称	类型	示例值	描述
RequestId	String	2021062415303314515207C4****	请求ID。
IpAddressPoolId	String	ippool-fda83op****	IP地址池的ID。

请求示例

GET /?Action=CreateIpAddressPool&Version=2020-04-01&CidrBlock=101.0.XX.XX/24&ISP=BGP HTTP/1.1
Host: open.volcengineapi.com
Service: vpc
Region: cn-beijing

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20210624153033015207C4****",
        "Action": "CreateIpAddressPool",
        "Version": "2020-04-01",
        "Service": "vpc",
        "Region": "cn-beijing"
    },
    "Result":{
         "RequestId": "2021062415303314515207C4****",
         "IpAddressPoolId": "ippool-fda83op****"
     }
}

错误码

公共错误码，请参见公共错误码。

HttpCode	错误码	错误信息	描述
400	IdempotentParameterMismatch	Arguments on this idempotent request are inconsistent with arguments used in previous request(s).	此幂等请求的参数与前一个请求中使用的参数不一致。
	InvalidCidr.Malformed	The specified cidr block is malformed.	指定的网段格式不合法。
	InvalidIPPool.CidrBlockResourceNotEnoug	There is not enough CIDR block resource to create an IP address pool.	可用网段资源不足无法创建IP地址池。
	InvalidIPPool.InvalidStatus	The specified IP address pool is not in the correct status for the request.	指定IP地址池所处的状态无法响应该请求。
	InvalidIPPoolCidrBlock.Malformed	The specified CIDR block is malformed. The mask length must be greater than or equal to 23 and less than or equal to 30.	指定的网段不合法，网段掩码必须大于等于23且小于等于30。
	InvalidIPPoolCidrBlock.NotSupportIPv6	The IP address pool does not support IPv6 CIDR block.	IP地址池不支持指定IPv6网段。
	InvalidIPPoolCidrMask.Malformed	The specified CIDR mask is malformed. The mask length must be greater than or equal to 24 and less than or equal to 28.	指定的掩码不合法，掩码必须大于等于24且小于等于28。
	InvalidParameter	A parameter specified in the request is not valid, is unsupported or cannot be used.	该请求传入了非法或不支持的参数。
	InvalidParameter.ClientTokenMalformed	The specified parameter ClientToken is malformed.	指定的参数ClientToken格式不合法，长度不能超过64个ASCII字符。
	QuotaExceeded.IPPoolIP	You've reached the limit on the number of IPs of all IP address pools that you can possess.	已达到所有IP地址池持有IP地址数量上限。
404	InvalidIPPool.NotFound	The specified IP address pool does not exist.	指定的IP地址池不存在。
412	IdempotentProcessing	The request uses the same client token as a previous one that is still in process.	幂等请求处理中。