You need to enable JavaScript to run this app.
导航
私有网络
  • 文档首页
    • /私有网络/API参考/私有网络/CreateVpc
CreateVpc
最近更新时间：2024.08.07 15:38:11首次发布时间：2021.07.29 14:11:53
我的收藏

调用 CreateVpc 接口，创建一个VPC。

调用说明

  • 单个账号单个地域默认最多可创建VPC的数量为10个。若默认配额无法满足需求，请前往 配额中心 提升相应配额。
  • CreateVpc 为异步接口，即返回请求ID时，系统后台仍在创建。您可调用 DescribeVpcAttributes 查看VPC的状态，Creating表示创建中，Available 表示创建完成。

调试

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

请求参数

参数名称
类型
是否必选
示例值
描述
ActionString是CreateVpc要执行的操作，取值：CreateVpc。
VersionString是2020-04-01API版本信息，取值为：2020-04-01。

VpcName

String

否

vpc-1

VPC的名称。

  • 长度限制为1 ~ 128个字符。
  • 需要以字母、中文或数字开头，可包含点号（.）、下划线（_）和短横线（-）。
  • 不填默认为VPC实例的ID。
  • 不能以http://或https://开头。

Description

String

否

This is my first Vpc

VPC的描述信息。

  • 长度限制为0~ 255个字符。
  • 不填默认为空字符串。
  • 需要以字母、中文或数字开头。可包含英文逗号（,）、点号（.）、下划线（_）、空格（ ）、等号（=）、短横线（-）、中文逗号（，）、中文句号（。）。
  • 不能以http://或https://开头。

CidrBlock

String

是

172.XX.XX.0/12

VPC的IPv4网段。您可以使用以下网段或其子集作为VPC的IPv4网段：

  • 192.168.0.0/16 ~ 24
  • 10.0.0.0/8 ~ 24
  • 172.16.0.0/12 ~ 24

EnableIpv6

Boolean

否

true

是否开启IPv6网段，取值如下：

  • false（默认值）：不开启。
  • true：开启。

说明

IPv6功能正在邀测中，暂仅支持完成 企业认证 的账号申请试用，如需试用，请联系客户经理。

Ipv6CidrBlock

String

否

2408:XXXX:0:a600::/56

VPC的IPv6网段。
参数EnableIpv6设置为“true”时，如果不传入该参数，则由系统自动分配IPv6网段。

说明

IPv6功能正在邀测中，暂仅支持完成 企业认证 的账号申请试用，如需试用，请联系客户经理。

DnsServers.N

String

否

DnsServers.1=12.XX.XX.5&DnsServers.2=12.XX.XX.6

VPC的DNS服务器地址。

  • 参数 - N：表示DNS服务器地址的序号，单次调用数量上限为5个，每个DnsServer必须以合法IP形式给出。
  • 多个IP之间用&分隔。
  • 不填则配置为默认DNS服务器地址。
ProjectNameString否defaultVPC所属项目的名称。不填默认加入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****

客户端Token，用于保证请求幂等性。

  • 由客户端自动生成一个参数值，确保不同请求间该参数值唯一，避免当调用API超时或服务器内部错误时，客户端多次重试导致重复性操作。
  • 仅支持ASCII字符，且不能超过64个字符。
  • 若不传入ClientToken，则此次API调用不进行幂等校验。

返回数据

参数名称
类型
示例值
描述
VpcIdStringvpc-bp15zkdt37pq72zv****新创建VPC的ID。
RouteTableIdStringvtb-bp145q7glnuzdv****创建VPC后，系统自动创建的路由表的ID，即系统路由表ID。
RequestIdString2021062415303301022514515207C4****请求ID。

请求示例

GET /?Action=CreateVpc&Version=2020-04-01&CidrBlock=172.XX.XX.0/12&VpcName=vpc-1 HTTP/1.1
Host: open.volcengineapi.com
Service: vpc
Region: cn-beijing

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2021062415303301022514515207C4****",
        "Action": "CreateVpc",
        "Version": "2020-04-01",
        "Service": "vpc",
        "Region": "cn-beijing"
    },
    "Result": {
        "RequestId": "2021062415303301022514515207C4****",
        "RouteTableId": "vtb-bp145q7glnuzdv****",
        "VpcId": "vpc-bp15zckdt37pq72zv****"
    }
}

错误码

此处仅展示当前API的错误码，更多错误码请参见公共错误码。

HttpCode
错误码
错误信息
描述
400IdempotentParameterMismatchArguments on this idempotent request are inconsistent with arguments used in previous request(s).此幂等请求的参数与前一个请求中使用的参数不一致。
400InsufficientIpv6BlocksThe specified pool does not contain enough free IPv6 blocks to fulfill your request.IPv6 池中的 IPv6 地址段资源不足。
400InvalidCidr.MalformedThe specified cidr block is malformed.指定的网段格式不合法。
400InvalidDescription.MalformedThe specified description is malformed.指定的描述格式不合法。请修复描述格式后重试。
400InvalidDescription.MalformedThe specified description is malformed. Ensure the maximum length of description is 255.指定的描述格式不合法。描述长度不能超过255个字符。
400InvalidIpv6CidrBlock.NotReservedThe specified IPv6 CIDR block is not reserved.指定的 IPv6 地址段未预留。
400InvalidName.MalformedThe specified name is malformed.指定的名称格式不合法。请修复名称格式后重试。
400InvalidName.MalformedThe specified name is malformed. Ensure the maximum length of name is 128.指定的名称格式不合法。名称长度不能超过128个字符。
400InvalidParameter.ClientTokenMalformedThe specified parameter ClientToken is malformed.指定的参数ClientToken格式不合法，长度不能超过64个ASCII字符。
400InvalidParameter.EnableIpv6The EnableIpv6 parameter is currently not supported.当前不支持EnableIpv6请求参数。
400InvalidTag.DisorderThe specified index order of tag is malformed.指定标签的索引顺序参数格式不合法。
400InvalidTagKey.MalformedThe specified parameter tag key is invalid.标签键不合法。
400InvalidTagValue.MalformedThe specified parameter tag value is invalid.标签值不合法。
400InvalidVpcDnsServerIpAddress.MalformedThe specified DNS server IP address is malformed.指定的DNS服务器IP地址格式不合法。
400LimitExceeded.TagsYou've reached the limit on the number of tags that you can operate at one time.已达到单次可操作标签数量的上限。
400LimitExceeded.VpcDnsServerNumberYou've reached the limit on the number of DNS servers that you can add.已达到可添加的DNS服务器数量上限。
400QuotaExceeded.RouteTableRoute table number exceeded quota.已达到可创建路由表的数量上限。
400QuotaExceeded.SecurityGroupSecurity group number exceeded quota.已达到可创建安全组的数量上限。
400QuotaExceeded.VpcVPC number exceeded quota.已达到可创建私有网络的数量上限。
404InvalidProject.NotFoundThe specified Project does not exist.指定的项目不存在。
412IdempotentProcessingThe request uses the same client token as a previous one that is still in process.幂等请求处理中。