tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateSubnet

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

1. API Description

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

This API is used to create a subnet.

  • You must create a VPC instance before creating a subnet.
  • After the subnet is successfully created, its IP address range cannot be modified. The subnet IP address range must fall within the VPC IP address range. They can be the same if the VPC instance has only one subnet. We recommend that you keep the subnet IP address range within the VPC IP address range to reserve IP address ranges for other subnets.
  • 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).
  • IP address ranges of different subnets cannot overlap with each other within the same VPC instance.
  • A subnet is automatically associated with the default route table once created.
  • You can bind a tag when creating a subnet. 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: CreateSubnet.
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.
VpcId Yes String The ID of the VPC instance to be operated on. You can obtain the parameter value from the VpcId field in the returned result of DescribeVpcs API.
SubnetName Yes String The subnet name. The maximum length is 60 bytes.
CidrBlock Yes String The subnet IP address range. It must be within the VPC IP address range. Subnet IP address ranges cannot overlap with each other within the same VPC.
Zone Yes String The ID of the availability zone in which the subnet resides. You can set up disaster recovery across availability zones by choosing different availability zones for different subnets.
Tags.N No Array of Tag Bound tags, such as [{"Key": "city", "Value": "shanghai"}].
CdcId No String CDC instance ID

3. Output Parameters

Parameter Name Type Description
Subnet Subnet Subnet 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 subnet

This example shows you how to create a subnet.

Input Example

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

{
    "SubnetName": "TestSubnet",
    "VpcId": "vpc-m3ul053f",
    "CidrBlock": "10.8.0.0/24",
    "Zone": "ap-guangzhou-1",
    "Tags": [
        {
            "Value": "shanghai",
            "Key": "city"
        }
    ]
}

Output Example

{
    "Response": {
        "Subnet": {
            "VpcId": "vpc-m3ul053f",
            "EnableBroadcast": true,
            "Zone": "1001",
            "IsCdcSubnet": 0,
            "AvailableIpAddressCount": 1021,
            "IsRemoteVpcSnat": true,
            "SubnetName": "subnet1",
            "TotalIpAddressCount": 1024,
            "TagSet": [
                {
                    "Value": "shanghai",
                    "Key": "city"
                }
            ],
            "CreatedTime": "2023-03-21 18:00:00",
            "SubnetId": "subnet-1d32nvu2",
            "CidrBlock": "10.8.0.0/24",
            "IsDefault": false,
            "CdcId": "",
            "Ipv6CidrBlock": "",
            "RouteTableId": "",
            "NetworkAclId": ""
        },
        "RequestId": "9450a158-0487-4baa-bd3f-a07f343b6c4e"
    }
}

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
FailedOperation.NetDetectTimeOut Network probe timed out. Please retry later.
InvalidParameter A parameter error occurred.
InvalidParameterValue Incorrect parameter value.
InvalidParameterValue.Duplicate The input parameter already exists.
InvalidParameterValue.Empty Missing parameters.
InvalidParameterValue.LimitExceeded The parameter value exceeds the limit.
InvalidParameterValue.Malformed Invalid input parameter format.
InvalidParameterValue.SubnetConflict Subnet CIDR conflict.
InvalidParameterValue.SubnetOverlap The CIDR block overlaps with another subnet within the same VPC.
InvalidParameterValue.SubnetRange Invalid subnet CIDR.
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.
InvalidParameterValue.ZoneConflict The Zone parameter value should be the zone where CDC resides.
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.
ResourceNotFound The resource does not exist.
UnsupportedOperation.AppIdMismatch The resource is not under the specified AppId.
UnsupportedOperation.DcGatewaysNotFoundInVpc No direct connect gateway exists in the specified VPC.
UnsupportedOperation.RecordExists This record already exists.
UnsupportedOperation.RecordNotExists The record does not exist.
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