1. 接口描述
接口请求域名: vpc.tencentcloudapi.com 。
本接口(CreateVpc)用于创建私有网络(VPC)。
- 用户可以创建的最小网段子网掩码为28(有16个IP地址),10.0.0.0/12,172.16.0.0/12最大网段子网掩码为12(1,048,576个IP地址),192.168.0.0/16最大网段子网掩码为16(65,536个IP地址)如果需要规划VPC网段请参见网络规划。
- 同一个地域能创建的VPC资源个数也是有限制的,详见 VPC使用限制,如果需要申请更多资源,请提交工单申请。
- 创建VPC同时可以绑定标签, 应答里的标签列表代表添加成功的标签。
默认接口请求频率限制:100次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateVpc。 |
Version | 是 | String | 公共参数,本接口取值:2017-03-12。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
VpcName | 是 | String | vpc名称,最大长度不能超过60个字节。 示例值:TestVPC |
CidrBlock | 是 | String | vpc的cidr,仅能在10.0.0.0/12,172.16.0.0/12,192.168.0.0/16这三个内网网段内。 示例值:10.8.0.0/16 |
EnableMulticast | 否 | String | 是否开启组播。true: 开启, false: 不开启。 示例值:true |
DnsServers.N | 否 | Array of String | DNS地址,最多支持4个。 |
DomainName | 否 | String | DHCP使用的域名。 |
Tags.N | 否 | Array of Tag | 指定绑定的标签列表,例如:[{"Key": "city", "Value": "shanghai"}]。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Vpc | Vpc | Vpc对象。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建VPC
创建VPC
输入示例
POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateVpc
<公共请求参数>
{
"VpcName": "TestVPC",
"CidrBlock": "10.8.0.0/16",
"Tags": [
{
"Value": "shanghai",
"Key": "city"
}
]
}
输出示例
{
"Response": {
"RequestId": "0a74f7fe-0cfe-4bc7-b1d2-6575168d7a44",
"Vpc": {
"VpcId": "vpc-2ln96dly",
"DomainName": "TEST",
"Ipv6CidrBlock": "2001::85b:3c51:f5ff:ffdb",
"EnableDhcp": true,
"DnsServerSet": [
"183.60.82.98",
"183.60.83.1"
],
"EnableMulticast": false,
"VpcName": "TEST",
"AssistantCidrSet": [
{
"SubnetSet": [
{
"NetworkAclId": "acl-n8w3ppae",
"RouteTableId": "rtb-57ruphgv",
"VpcId": "vpc-lrrlomg7",
"EnableBroadcast": true,
"Zone": "ap-guangzhou-1",
"IsCdcSubnet": 0,
"Ipv6CidrBlock": "2001::85b:3c51:f5ff:ffda",
"CdcId": "cluster-gbo27yc4",
"AvailableIpAddressCount": 1,
"IsRemoteVpcSnat": true,
"SubnetName": "TEST",
"TotalIpAddressCount": 1,
"CreatedTime": "2020-09-18 19:46:07",
"SubnetId": "subnet-p9oa3yo7",
"CidrBlock": "10.0.0.0/16",
"TagSet": [
{
"Value": "TEST",
"Key": "TEST"
}
],
"IsDefault": true
}
],
"VpcId": "vpc-lrrlomg7",
"CidrBlock": "10.0.0.0/16",
"AssistantType": 0
}
],
"TagSet": [
{
"Value": "TEST",
"Key": "TESt"
}
],
"DhcpOptionsId": "dopt-058pu85z",
"CreatedTime": "0000-00-00 00:00:00",
"CidrBlock": "10.0.0.0/16",
"IsDefault": false
}
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.LimitExceeded | 参数值超出限制。 |
InvalidParameterValue.Malformed | 入参格式不合法。 |
InvalidParameterValue.SubnetOverlap | CIDR与同一个私有网络内的另一个子网发生重叠。 |
InvalidParameterValue.TagDuplicateKey | 标签键重复。 |
InvalidParameterValue.TagDuplicateResourceType | 重复的标签资源类型。 |
InvalidParameterValue.TagInvalidKey | 标签键无效。 |
InvalidParameterValue.TagInvalidKeyLen | 标签键长度无效。 |
InvalidParameterValue.TagInvalidVal | 标签值无效。 |
InvalidParameterValue.TagKeyNotExists | 标签键不存在。 |
InvalidParameterValue.TagNotAllocatedQuota | 标签没有分配配额。 |
InvalidParameterValue.TagNotExisted | 该标签不存在。 |
InvalidParameterValue.TagNotSupportTag | 不支持的标签。 |
InvalidParameterValue.TagResourceFormatError | 标签资源格式错误。 |
InvalidParameterValue.TagTimestampExceeded | 标签时间戳超配。 |
InvalidParameterValue.TagValNotExists | 标签值不存在。 |
InvalidParameterValue.TooLong | 无效参数值。参数值太长。 |
LimitExceeded | 超过配额限制。 |
LimitExceeded.TagKeyExceeded | 标签键已达到上限。 |
LimitExceeded.TagKeyPerResourceExceeded | 每个资源的标签键已达到上限。 |
LimitExceeded.TagNotEnoughQuota | 没有足够的标签配额。 |
LimitExceeded.TagQuota | 标签配额已满,无法创建资源。 |
LimitExceeded.TagQuotaExceeded | 标签配额已达到上限。 |
LimitExceeded.TagTagsExceeded | 标签键的数目已达到上限。 |
MissingParameter | 缺少参数错误。 |
ResourceInsufficient | 资源不足。 |
ResourceNotFound | 资源不存在。 |
UnauthorizedOperation | 未授权操作。 |
UnsupportedOperation | 操作不支持。 |
UnsupportedOperation.AppIdMismatch | 资源不在指定的AppId下。 |
UnsupportedOperation.EnableMulticast | 当前地域不支持启用组播。 |
UnsupportedOperation.RecordExists | 记录已存在。 |
UnsupportedOperation.TagAllocate | 标签正在分配中。 |
UnsupportedOperation.TagFree | 标签正在释放中。 |
UnsupportedOperation.TagNotPermit | 标签没有权限。 |
UnsupportedOperation.TagSystemReservedTagKey | 不支持使用系统预留的标签键。 |