Compute
Elastic Cloud Server
Huawei Cloud Flexus
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Management & Governance
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
OneAccess
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
IAM Identity Center
Cloud Operations Center
Resource Governance Center
Migration
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Analytics
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
Data Lake Factory
DataArts Lake Formation
IoT
IoT Device Access
Others
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Security & Compliance
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Anti-DDoS Service
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Edge Security
Situation Awareness
Managed Threat Detection
Blockchain
Blockchain Service
Web3 Node Engine Service
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
Storage
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service Turbo
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Containers
Cloud Container Engine
SoftWare Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
Multi-Site High Availability Service
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Business Applications
Workspace
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Video Intelligent Analysis Service
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Content Delivery & Edge Computing
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Intelligent EdgeCloud
Solutions
SAP Cloud
High Performance Computing
Developer Services
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
CodeArts Repo
Cloud Application Engine
MacroVerse aPaaS
KooMessage
KooPhone
KooDrive

Creating a Subnet

Function

This API is used to create a subnet.

URI

POST /v1/{project_id}/subnets

Table 1 describes the parameters.
Table 1 Parameter description

Parameter

Mandatory

Description

project_id

Yes

Specifies the project ID. For details about how to obtain a project ID, see Obtaining a Project ID.

Request Parameters

Table 2 Request parameter

Parameter

Mandatory

Type

Description

subnet

Yes

subnet object

Specifies the subnet objects.

Table 3 subnet objects

Parameter

Mandatory

Type

Description

name

Yes

String

  • Specifies the subnet name.
  • The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).

description

No

String

  • Provides supplementary information about the subnet.
  • The value can contain no more than 255 characters and cannot contain angle brackets (< or >).

cidr

Yes

String

  • Specifies the subnet CIDR block.
  • The value must be within the VPC CIDR block.
  • The value must be in CIDR format. The subnet mask cannot be greater than 28.

gateway_ip

Yes

String

  • Specifies the gateway of the subnet.
  • The value must be an IP address in the subnet.
  • The value must be a valid IP address.

ipv6_enable

No

Boolean

  • Specifies whether IPv6 is enabled.
  • The value can be true (enabled) or false (disabled).
  • If this parameter is left blank, the system automatically sets it to false by default.

dhcp_enable

No

Boolean

  • Specifies whether DHCP is enabled for the subnet.
  • The value can be true (enabled) or false (disabled).
  • If this parameter is left blank, the value is set to true by default. If this parameter is set to false, newly created ECSs cannot obtain IP addresses, and usernames and passwords cannot be injected using Cloud-init.

primary_dns

No

String

  • Specifies the primary IP address of DNS server on the subnet.
  • The value must be an IP address. If the value is not specified, the default value will be left blank.

For instructions about how to obtain a private DNS server address, see What Are the Private DNS Server Addresses Provided by the DNS Service?

For instructions about how to DNS server address, see Querying Name Servers.

secondary_dns

No

String

  • Specifies the standby IP address of DNS server on the subnet.
  • The value must be an IP address. If the value is not specified, the default value will be left blank.

    If only secondary_dns is specified and primary_dns is not specified, primary_dns will automatically use the value of secondary_dns.

    If there is only one DNS server address, only primary_dns is displayed.

For instructions about how to obtain a private DNS server address, see What Are the Private DNS Server Addresses Provided by the DNS Service?

For instructions about how to DNS server address, see Querying Name Servers.

dnsList

No

Array of strings

  • Specifies the DNS server address list of a subnet. This field is required if you need to use more than two DNS servers.
  • This parameter value is the superset of both DNS server address 1 and DNS server address 2. If the value is not specified, the default value will be left blank.

For instructions about how to obtain a private DNS server address, see What Are the Private DNS Server Addresses Provided by the DNS Service?

For instructions about how to DNS server address, see Querying Name Servers.

availability_zone

No

String

  • Specifies the AZ to which the subnet belongs, which can be obtained from endpoints. For details, see Endpoints.
  • The value must be an existing AZ in the system. If the value is not specified, the default value will be left blank.

vpc_id

Yes

String

Specifies the ID of the VPC to which the subnet belongs.

extra_dhcp_opts

No

Array of extra_dhcp_opt objects

Specifies the NTP server address or DHCP lease time configured for the subnet. For details, see Table 4.

tags

No

Array of Strings

  • Specifies subnet tags. When creating a subnet, you can add tags to the subnet.
  • Each subnet can have up to 10 tags.
    • key: Tag key. The key cannot be empty and can contain up to 128 characters (36 characters on the console). It can consist of letters, digits, underscores (_), and hyphens (-). Tag keys of a resource must be unique.
    • value: Tag value. The value can contain up to 255 characters (43 characters on the console). It can consist of letters, digits, underscores (_), periods (.), and hyphens (-).
  • Format: [key*value]. The key and value of each tag are connected by an asterisk (*).
Table 4 extra_dhcp_opt object

Parameter

Mandatory

Type

Description

opt_value

No

String

  • Specifies the NTP server address domain name, or DHCP lease expiration time configured for the subnet.
  • Constraints:

    If opt_name is set to ntp, the value indicates the NTP server configured for the subnet. Currently, only IPv4 addresses are supported. A maximum of four IP addresses can be configured, and each address must be unique. Multiple IP addresses must be separated using commas (,). If opt_name is set to null, the value indicates that no NTP server is configured for the subnet. The parameter value cannot be an empty string.

    If opt_name is set to domainname, the value is the domain name configured for DNS and is used to obtain the IP address from the DNS server. A domain name can contain only letters, digits, and hyphens (-) and cannot start or end with a hyphen (-). Each domain name contains at least two labels separated by periods (.). Max total: 254 characters. Max label: 63 characters.

    The option addresstime for opt_name indicates the DHCP lease expiration time of the subnet. The value can be -1, which indicates unlimited lease time, or Number+h. The number ranges from 1 to 30,000. For example, the value can be 5h. The default value is 24h.

opt_name

Yes

String

  • Specifies the NTP server address or DHCP lease expiration time configured for the subnet.
  • Currently, the value can be ntpdomainname, or addresstime.

Example Request

  • Create a subnet with name set to subnet, CIDR block set to 192.168.20.0/24, and gateway IP address set to 192.168.20.1 in the VPC with ID of 3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85.
    POST https://{Endpoint}/v1/{project_id}/subnets
    
    {
        "subnet": {
            "name": "subnet",
            "description": "",
            "cidr": "192.168.20.0/24",
            "gateway_ip": "192.168.20.1",
            "ipv6_enable": true,
            "dhcp_enable": true,
            "primary_dns": "114.xx.xx.114",
            "secondary_dns": "114.xx.xx.115",
            "dnsList": [
                "114.xx.xx.114",
                "114.xx.xx.115"
            ],
            "availability_zone": "aa-bb-cc",
            "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85",
            "extra_dhcp_opts": [
                {
                    "opt_value": "10.100.0.33,10.100.0.34",
                    "opt_name": "ntp"
                }
            ]
        }
    }

Response Parameters

Table 5 Response parameter

Parameter

Type

Description

subnet

subnet object

Specifies the subnet objects.

Table 6 subnet objects

Parameter

Type

Description

id

String

Specifies the resource identifier in the form of UUID.

name

String

  • Specifies the subnet name.
  • The value can contain 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), and periods (.).

description

String

  • Provides supplementary information about the subnet.
  • The value can contain no more than 255 characters and cannot contain angle brackets (< or >).

cidr

String

  • Specifies the subnet CIDR block.
  • The value must be within the VPC CIDR block.
  • The value must be in CIDR format. The subnet mask cannot be greater than 28.

gateway_ip

String

  • Specifies the gateway of the subnet.
  • The value must be an IP address in the subnet.
  • The value must be a valid IP address.

ipv6_enable

Boolean

Specifies whether IPv6 is enabled.

cidr_v6

String

Specifies the IPv6 subnet CIDR block. If the subnet is an IPv4 subnet, this parameter is not returned.

gateway_ip_v6

String

Specifies the IPv6 subnet gateway. If the subnet is an IPv4 subnet, this parameter is not returned.

dhcp_enable

Boolean

Specifies whether DHCP is enabled for the subnet.

primary_dns

String

  • Specifies the primary IP address of DNS server on the subnet.
  • The value must be an IP address. If the value is not specified, the default value will be left blank.

secondary_dns

String

  • Specifies the standby IP address of DNS server on the subnet.
  • The value must be an IP address. If the value is not specified, the default value will be left blank.

    If only secondary_dns is specified and primary_dns is not specified, primary_dns will automatically use the value of secondary_dns.

    If there is only one DNS server address, only primary_dns is displayed.

dnsList

Array of strings

  • Specifies the DNS server address list of a subnet. This field is required if you need to use more than two DNS servers.
  • This parameter value is the superset of both DNS server address 1 and DNS server address 2. If the value is not specified, the default value will be left blank.

availability_zone

String

  • Specifies the AZ to which the subnet belongs, which can be obtained from endpoints. For details, see Endpoints.
  • The value must be an existing AZ in the system. If the value is not specified, the default value will be left blank.

vpc_id

String

Specifies the ID of the VPC to which the subnet belongs.

status

String

  • Specifies the status of the subnet.
  • The value can be ACTIVE, UNKNOWN, or ERROR.
    • ACTIVE: indicates that the subnet has been associated with a VPC.
    • UNKNOWN: indicates that the subnet has not been associated with a VPC.
    • ERROR: indicates that the subnet is abnormal.
  • The system creates a subnet and then associates the subnet with a VPC in the threads.

    In the concurrent scenario, if the CIDR block of the created subnet is the same as that of an existing subnet, the created subnet fails to associate with a VPC after underlying system verification. As a result, the subnet creation fails.

  • The value of status is UNKNOWN before the subnet is associated with a VPC. After the subnet is associated with a VPC in the threads, the status of the subnet is ACTIVE.

neutron_network_id

String

Specifies the ID of the corresponding network (OpenStack Neutron API).

neutron_subnet_id

String

Specifies the ID of the corresponding subnet (OpenStack Neutron API).

neutron_subnet_id_v6

String

Specifies the ID of the IPv6 subnet (OpenStack Neutron API). If the subnet is an IPv4 subnet, this parameter is not returned.

extra_dhcp_opts

Array of extra_dhcp_opt objects

Specifies the NTP server address or DHCP lease time configured for the subnet. For details, see Table 7.

scope

String

  • Specifies where the subnet is used in edge cloud scenario.
  • The value can be:
    • center: The subnet is used in a central AZ.
    • {azId}: The subnet is used in an edge AZ.

tenant_id

String

  • Project ID

created_at

String

  • Specifies the time (UTC) when the subnet is created.
  • Format: yyyy-MM-ddTHH:mm:ss

updated_at

String

  • Specifies the time (UTC) when the subnet is updated.
  • Format: yyyy-MM-ddTHH:mm:ss
Table 7 extra_dhcp_opt object

Parameter

Mandatory

Type

Description

opt_value

No

String

  • Specifies the NTP server address domain name, or DHCP lease expiration time configured for the subnet.
  • Constraints:

    If opt_name is set to ntp, the value indicates the NTP server configured for the subnet. Currently, only IPv4 addresses are supported. A maximum of four IP addresses can be configured, and each address must be unique. Multiple IP addresses must be separated using commas (,). If opt_name is set to null, the value indicates that no NTP server is configured for the subnet. The parameter value cannot be an empty string.

    If opt_name is set to domainname, the value is the domain name configured for DNS and is used to obtain the IP address from the DNS server. A domain name can contain only letters, digits, and hyphens (-) and cannot start or end with a hyphen (-). Each domain name contains at least two labels separated by periods (.). Max total: 254 characters. Max label: 63 characters.

    The option addresstime for opt_name indicates the DHCP lease expiration time of the subnet. The value can be -1, which indicates unlimited lease time, or Number+h. The number ranges from 1 to 30,000. For example, the value can be 5h. The default value is 24h.

opt_name

Yes

String

  • Specifies the NTP server address or DHCP lease expiration time configured for the subnet.
  • Currently, the value can be ntpdomainname, or addresstime.

Example Response

{
    "subnet": {
        "id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d",
        "name": "subnet",
        "description": "",
        "cidr": "192.168.20.0/24",
        "dnsList": [
            "114.xx.xx.114",
            "114.xx.xx.115"
        ],
        "status": "UNKNOWN",
        "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85",
        "gateway_ip": "192.168.20.1",
        "ipv6_enable": true, 
        "cidr_v6": "2001:db8:a583::/64",
        "gateway_ip_v6": "2001:db8:a583::1",
        "dhcp_enable": true,
        "primary_dns": "114.xx.xx.114",
        "secondary_dns": "114.xx.xx.115",
        "availability_zone": "aa-bb-cc",
        "neutron_network_id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d",
        "neutron_subnet_id": "213cb9d-3122-2ac1-1a29-91ffc1231a12",
        "neutron_subnet_id_v6": "e0fa7de1-a6e2-44c9-b052-b9d8cebe93c4",  
        "extra_dhcp_opts": [
            {
                "opt_value": "10.100.0.33,10.100.0.34",
                "opt_name": "ntp"
            }
        ],
        "tenant_id": "087679f0aa80d32a2f4ec0172f5e902b",
        "created_at": "2022-12-15T02:42:07",
        "updated_at": "2022-12-15T02:42:07"
    }
}

Status Code

See Status Codes.

Error Code

See Error Codes.

We use cookies to improve our site and your experience. By continuing to browse our site you accept our cookie policy. Find out more

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback