CreateDefaultVpc

Last updated: 2020-03-06 20:26:21

1. API Description

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

This API is used to create a default VPC.

The default VPC is suitable for getting started with and launching public instances, and it can be used like any other VPCs. To create a standard VPC, for which you need to specify a VPC name, VPC IP range, subnet IP range, and subnet availability zone, use the regular CreateVpc API.

Under normal circumstances, this API may not create a default VPC. It depends on the network attributes (DescribeAccountAttributes) of your account.

  • If both basic network and VPC are supported, the returned VpcId is 0.
  • If only VPC is supported, the default VPC information is returned.

You can also use the Force parameter to forcibly return a default VPC.

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

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: CreateDefaultVpc.
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.
Zone No String The ID of the availability zone in which the subnet resides. The availability zone will be randomly selected if not specified.
Force No Boolean Whether to forcibly return a default VPC

3. Output Parameters

Parameter Name Type Description
Vpc DefaultVpcSubnet Default VPC and subnet IDs
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Creating a default VPC

Input Example

https://vpc.tencentcloudapi.com/?Action=CreateDefaultVpc
&Version=2017-03-12
&<Common Request Parameters>

Output Example

{
  "Response": {
    "Vpc": {
      "VpcId": "vpc-pin7sxcd",
      "SubnetId": "subnet-ixzf2m42"
    },
    "RequestId": "a2353d77-5c08-49c4-a28a-632a8af5e294"
  }
}

Example2 The network attributes (DescribeAccountAttributes) of the user account support both the basic network and VPC. If a default VPC is not created as required, the returned VpcId is 0, indicating that a default VPC is not created.

Input Example

https://vpc.tencentcloudapi.com/?Action=CreateDefaultVpc
&Version=2017-03-12
&<Common Request Parameters>

Output Example

{
  "Response": {
    "Vpc": {
      "VpcId": "0",
      "SubnetId": "0"
    },
    "RequestId": "c52dda11-9e53-440f-b034-6292f2144dd0"
  }
}

Example3 Creating a default VPC as required

Input Example

https://vpc.tencentcloudapi.com/?Action=CreateDefaultVpc
&Version=2017-03-12
&Force=true
&<Common Request Parameters>

Output Example

{
  "Response": {
    "Vpc": {
      "VpcId": "vpc-8mpwlbdv",
      "SubnetId": "subnet-l9emqwnw"
    },
    "RequestId": "91348b0a-6846-49ff-822b-a21eef848c9f"
  }
}

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.

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

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.