tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateDefaultVpc

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 with default settings.

To create a VPC with custom settings, such as VPC name, IP range, subnet IP range, and subnet availability zone, use CreateVpc instead.

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.

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: CreateDefaultVpc.
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.
Zone No String The ID of the availability zone in which the subnet resides. This parameter can be obtained through the DescribeZones API, such as ap-guangzhou-1. If it’s not specified, a random availability zone will be used.
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 VPC with default settings

This example shows you how to create a VPC with default settings.

Input Example

https://vpc.tencentcloudapi.com/?Action=CreateDefaultVpc
&<common request parameters>

Output Example

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

Example2 Creating a default VPC without passing in the Force parameter

In this example, the account supports both the classic network and VPC. When Force is not passed in, the returned VpcId is 0, indicating that the default VPC is not created.

Input Example

https://vpc.tencentcloudapi.com/?Action=CreateDefaultVpc
&<common request parameters>

Output Example

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

Example3 Creating a default VPC and ignoring the account network attribute

This example shows you how to create a default VPC without considering the network attribute of the account.

Input Example

https://vpc.tencentcloudapi.com/?Action=CreateDefaultVpc
&Force=true
&<common request parameters>

Output Example

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

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.Empty Missing parameters.
InvalidParameterValue.SubnetOverlap The CIDR block overlaps with another subnet within the same VPC.
LimitExceeded Quota limit is reached.
ResourceInsufficient.CidrBlock The IP range resources are insufficient.
ResourceNotFound The resource does not exist.
UnsupportedOperation.RecordExists This record already exists.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy