tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateVpc

Last updated: 2023-08-23 14:11:12

1. API Description

Domain name for API request: vpc.tencentcloudapi.com.

This API is used to create a VPC instance.

  • The subnet mask of the smallest IP address range that can be created is 28 (16 IP addresses), that of the largest IP address ranges 10.0.0.0/12 and 172.16.0.0/12 is 12 (1,048,576 IP addresses), and that of the largest IP address range 192.168.0.0/16 is 16 (65,536 IP addresses). For more information on how to plan VPC IP ranges, see Network Planning.
  • The number of VPC instances that can be created in a region is limited. For more information, see VPC Use Limits. To request more resources, submit a ticket.
  • You can bind tags when creating a VPC instance. The tag list in the response indicates the tags that have been successfully added.

A maximum of 100 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: CreateVpc.
Version Yes String Common Params. The value used for this API: 2017-03-12.
Region No String Common Params. This parameter is not required for this API.
VpcName Yes String The VPC name. The maximum length is 60 bytes.
CidrBlock Yes String VPC CIDR block, which must fall within the following three private network IP ranges: 10.0.0.0/12, 172.16.0.0/12, and 192.168.0.0/16.
EnableMulticast No String Whether multicast is enabled. true: Enabled. false: Not enabled.
DnsServers.N No Array of String DNS address. A maximum of 4 addresses is supported.
DomainName No String Domain name of DHCP
Tags.N No Array of Tag Bound tags, such as [{"Key": "city", "Value": "shanghai"}]

3. Output Parameters

Parameter Name Type Description
Vpc Vpc The VPC object.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating a VPC

This example shows you how to create a VPC.

Input Example

POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateVpc
<Common request parameters>

{
    "VpcName": "TestVPC",
    "CidrBlock": "10.8.0.0/16",
    "Tags": [
        {
            "Value": "shanghai",
            "Key": "city"
        }
    ]
}

Output Example

{
    "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. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InvalidParameterValue Incorrect parameter value.
InvalidParameterValue.LimitExceeded The parameter value exceeds the limit.
InvalidParameterValue.Malformed Invalid input parameter format.
InvalidParameterValue.SubnetOverlap The CIDR block overlaps with another subnet within the same VPC.
InvalidParameterValue.TagDuplicateKey Duplicate tag keys.
InvalidParameterValue.TagDuplicateResourceType Duplicate tag resource type.
InvalidParameterValue.TagInvalidKey Invalid tag key.
InvalidParameterValue.TagInvalidKeyLen Invalid tag key length.
InvalidParameterValue.TagInvalidVal Invalid tag key.
InvalidParameterValue.TagKeyNotExists The tag key does not exist.
InvalidParameterValue.TagNotAllocatedQuota Tags are not assigned quotas.
InvalidParameterValue.TagNotExisted The tag and value do not exist.
InvalidParameterValue.TagNotSupportTag Unsupported tag.
InvalidParameterValue.TagResourceFormatError 'The tag resource format error.
InvalidParameterValue.TagTimestampExceeded Exceeded the quota of tag timestamp.
InvalidParameterValue.TagValNotExists The tag value does not exist.
InvalidParameterValue.TooLong Invalid parameter value. The parameter value is too long.
LimitExceeded Quota limit is reached.
LimitExceeded.TagKeyExceeded Reached the upper limit of tag keys.
LimitExceeded.TagKeyPerResourceExceeded Reached the upper limit of tags keys per resource.
LimitExceeded.TagNotEnoughQuota Insufficient tag quota.
LimitExceeded.TagQuota Exceeded the tag quota. Unable to create resources.
LimitExceeded.TagQuotaExceeded Reached the upper limit of tag quota.
LimitExceeded.TagTagsExceeded Reached the number limit of tag keys.
MissingParameter Missing parameter.
ResourceInsufficient Insufficient resources.
ResourceNotFound The resource does not exist.
UnauthorizedOperation Unauthorized operation.
UnsupportedOperation.AppIdMismatch The resource is not under the specified AppId.
UnsupportedOperation.EnableMulticast Multi-cast is not available in the current region.
UnsupportedOperation.RecordExists This record already exists.
UnsupportedOperation.TagAllocate Tags are being assigned.
UnsupportedOperation.TagFree Tags are being released.
UnsupportedOperation.TagNotPermit Unauthorized for this tag.
UnsupportedOperation.TagSystemReservedTagKey The specified tag key is reserved for system usage.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy