proposalbot fa6b3af222 Changes to vpc_api-ref from docs/doc-exports#278 (VPC API 0930 version

20220930

Reviewed-by: Kucerak, Kristian <kristian.kucerak@t-systems.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>

2022-10-17 09:14:26 +00:00

19 KiB

Raw Permalink Blame History

original_name: vpc_subnet01_0002.html

Querying Subnet Details

Function

This API is used to query details about a subnet.

URI

GET /v1/{project_id}/subnets/{subnet_id}

Table 1 <vpc_subnet01_0002__table61566768> describes the parameters.

**Table 1** Parameter description
Name	Mandatory	Description
project_id	Yes	Specifies the project ID.
subnet_id	Yes	Specifies the subnet ID, which uniquely identifies the subnet. If you use the management console, the value of this parameter is the Network ID value.

Request Message

Request parameter

None

Example request

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

Response Message

Response parameter

**Table 2** Response parameter
Name	Type	Description
subnet	`subnet <vpc_subnet01_0002__table6614597017585>` object	Specifies the `subnet objects <vpc_subnet01_0002__table6614597017585>`.

**Table 3** **subnet** objects
Name	Type	Description
id	String	Specifies a resource ID in UUID format.
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.
gateway_ip	String	Specifies the subnet gateway address.
dhcp_enable	Boolean	Specifies whether DHCP is enabled for the subnet.
primary_dns	String	Specifies the IP address of DNS server 1 on the subnet.
secondary_dns	String	Specifies the IP address of DNS server 2 on the subnet.
dnsList	Array of strings	Specifies the IP address list of DNS servers on the subnet.
availability_zone	String	Identifies the AZ to which the subnet belongs.
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.
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).
extra_dhcp_opts	Array of `extra_dhcp_opt <vpc_subnet01_0002__table019517383270>` objects	Specifies the NTP server address configured for the subnet. For details, see `Table 4 <vpc_subnet01_0002__table019517383270>`.

**Table 4** **extra_dhcp_opt** object
Name	Mandatory	Type	Description
opt_value	No	String	Specifies the NTP server address configured for the subnet. Constraints: The option ntp for opt_name 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 (,). The option null for opt_name indicates that no NTP server is configured for the subnet. The parameter value cannot be an empty string.
opt_name	Yes	String	Specifies the NTP server address name configured for the subnet. Currently, the value can only be set to ntp.

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": "ACTIVE",
        "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85",
        "gateway_ip": "192.168.20.1",
        "dhcp_enable": true,
        "primary_dns": "114.xx.xx.114",
        "secondary_dns": "114.xx.xx.115",
        "availability_zone": "aa-bb-cc",//For example, the AZ is aa-bb-cc.
        "neutron_network_id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d",
        "neutron_subnet_id": "213cb9d-3122-2ac1-1a29-91ffc1231a12",
        "extra_dhcp_opts": [
            {
                "opt_value": "10.100.0.33,10.100.0.34",
                "opt_name": "ntp"
            }
        ]
    }
}

Status Code

See Status Codes <vpc_api_0002>.

Error Code

See Error Codes <vpc_api_0003>.

19 KiB Raw Permalink Blame History