Updating Subnet Information

Function

This API is used to update information about a subnet.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
vpc:subnets:update	Write	subnet *	g:ResourceTag/<tag-key> vpc:SubnetId vpc:VpcId vpc:AvailabilityZone g:EnterpriseProjectId	-	-
vpc:subnets:update	Write	-	vpc:SubnetIpv6Enable	-	-

URI

PUT /v1/{project_id}/vpcs/{vpc_id}/subnets/{subnet_id}

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.
vpc_id	Yes	Specifies the VPC ID of the subnet.
subnet_id	Yes	Specifies the subnet ID that uniquely identifies the subnet. If you use the management console, the value of this parameter is the Network ID value.

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 >).
ipv6_enable	No	Boolean	Specifies whether IPv6 is enabled. The value can be true (enabled) or false (disabled).
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 system automatically sets it 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.
enable_network_address_usage_metrics	No	Boolean	Definition: Whether to monitor the IPv4 address usage of the current subnet. Range: true: This function is enabled. false: This function is disabled.
primary_dns	No	String	Specifies the primary IP address of DNS server on the subnet. The value must be a valid IP address. 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 obtain a 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 a valid IP address. The value of secondary_dns must be different from that of primary_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 obtain a 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. 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 obtain a DNS server address, see Querying Name Servers.
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.

**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 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 IPv4 subnet. The value can be -1, which indicates unlimited lease time, or Numberh. The number ranges from 1 to 175200. For example, the value can be 5h. The default value is 87600h. The option ipv6_addresstime for opt_name indicates the DHCP lease expiration time of the IPv6 subnet. The value can be -1, which indicates unlimited lease time, or Numberh. The number ranges from 1 to 175200. For example, the value can be 5h. The default value is 2h. If this value is set to null, the configuration of the NTP server address, DNS domain name, or DHCP lease expiration time of the subnet is deleted. The value cannot be an empty string (" ").
opt_name	Yes	String	Specifies the NTP server address, domain name or DHCP lease expiration time configured for the subnet. Currently, the value can be ntp, domainname, addresstime, or ipv6_addresstime.

Example Request

Change the name of the subnet whose ID is 4779ab1c-7c1a-44b1-a02e-93dfc361b32d to subnet02, and also change its DNS and DHCP configurations.

PUT https://{Endpoint}/v1/{project_id}/vpcs/{vpc_id}/subnets/4779ab1c-7c1a-44b1-a02e-93dfc361b32d

{
    "subnet": {
        "name": "subnet02",
        "ipv6_enable": true,
        "dhcp_enable": false,
        "primary_dns": "114.xx.xx.115",
        "secondary_dns": "114.xx.xx.116",
        "extra_dhcp_opts": [
            {
                "opt_value": "10.100.0.33,10.100.0.34",
                "opt_name": "ntp"
            },
            {
                "opt_value": "24h",
                "opt_name": "addresstime"
            },
            {
                "opt_value": "2h",
                "opt_name": "ipv6_addresstime"
            }
        ]
        "enable_network_address_usage_metrics": false
    }
}

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 a resource ID in UUID format.
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.

Example Response

{
    "subnet": {
        "id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d",
        "status": "ACTIVE"
    }
}

Status Code

See Status Codes.

Error Code

See Error Codes.

Parent Topic: Subnet

Previous topic: Querying Subnets

Next topic: Deleting a Subnet

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot