Documentation|Tencent Cloud

Recent Pages

Documentation

CreateVpc

Last updated: 2020-07-31 14:30:26

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), and that of the largest IP address range is 16 (65,536 IP addresses). For more information, see the corresponding documents about VPC IP address ranges.
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, contact the online customer service.
You can bind a tag 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.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: vpc.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: CreateVpc.
Version	Yes	String	Common parameter. The value used for this API: 2017-03-12.
Region	Yes	String	Common parameter. For more information, please see the list of regions supported by the product.
VpcName	Yes	String	The VPC name. The maximum length is 60 bytes.
CidrBlock	Yes	String	VPC CIDR, which must fall within the following private network IP ranges: 10.0.0.0/16, 172.16.0.0/16, and 192.168.0.0/16.
EnableMulticast	No	String	Whether multicast is enabled. `true`: Enabled. `false`: Not enabled.
DnsServers.N	No	Array of String	The DNS address. A maximum of 4 addresses is supported.
DomainName	No	String	Domain name
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 instance

Input Example

https://vpc.tencentcloudapi.com/?Action=CreateVpc
&Version=2017-03-12
&VpcName=TestVPC
&CidrBlock=10.8.0.0/16
&Tags.0.Key=city
&Tags.0.Value=shanghai
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "354f4ac3-8546-4516-8c8a-69e3ab73aa8a",
    "Vpc": {
      "VpcId": "vpc-4tboefn3",
      "VpcName": "TestVPC",
      "EnableMulticast": false,
      "CidrBlock": "10.8.0.0/16",
      "TagSet": [
        {
          "Key": "city",
          "Value": "shanghai"
        }
      ]
    }
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

API 3.0 Explorer

SDK

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

Command Line Interface

Tencent Cloud CLI 3.0

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	Invalid parameter value
InvalidParameterValue.LimitExceeded	The parameter value exceeds the limit.
InvalidParameterValue.Malformed	Invalid input parameter format.
InvalidParameterValue.TooLong	Invalid parameter value. The parameter value is too long.
LimitExceeded	Quota limit is reached.
MissingParameter	Parameter missing. A required parameter is missing in the request.
ResourceNotFound	The resource does not exist.