Updated on 2022-01-25 GMT+08:00

Updating Subnet Information

Function

This API is used to update information about a subnet.

URI

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

Table 1 describes the parameters.
Table 1 Parameter description

Name

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, which uniquely identifies the subnet.

Request Message

  • Request parameter
    Table 2 Request parameter

    Name

    Mandatory

    Type

    Description

    subnet

    Yes

    Object

    Specifies the subnet objects.

    Table 3 subnet objects

    Name

    Mandatory

    Type

    Description

    name

    Yes

    String

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

    description

    No

    String

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

    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. Exercise caution when performing this operation.

    primary_dns

    No

    String

    • Specifies the IP address of DNS server 1 on the subnet.
    • The value must be a valid IP address.

    secondary_dns

    No

    String

    • Specifies the IP address of DNS server 2 on the subnet.
    • The value must be a valid IP address.

    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.
  • Example request
    PUT https://{Endpoint}/v1/{project_id}/vpcs/{vpc_id}/subnets/4779ab1c-7c1a-44b1-a02e-93dfc361b32d
    
    {
        "subnet": {
            "name": "subnetqq",
            "dhcp_enable": false,
            "primary_dns": "114.xx.xx.115",
            "secondary_dns": "114.xx.xx.116"
        }
    }

Response Message

  • Response parameter
    Table 4 Response parameter

    Name

    Type

    Description

    subnet

    Object

    Specifies the subnet objects.

    Table 5 subnet objects

    Name

    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.