Estos contenidos se han traducido de forma automática para su comodidad, pero Huawei Cloud no garantiza la exactitud de estos. Para consultar los contenidos originales, acceda a la versión en inglés.

Centro de ayuda/ Virtual Private Cloud/ Referencia de la API/ API/ Subred/ Consulta de subredes

Actualización más reciente 2023-02-03 GMT+08:00

Ver PDF

Consulta de subredes

Función

Esta API se utiliza para consultar subredes mediante criterios de búsqueda y para mostrar las subredes en una lista.

URI

GET /v1/{project_id}/subnets

Por ejemplo:

GET https://{Endpoint}/v1/{project_id}/subnets?limit=10&marker=4779ab1c-7c1a-44b1-a02e-93dfc361b32d&vpc_id=3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85

**Tabla 1** Descripción del parámetro
Nombre	Obligatorio	Tipo	Descripción
project_id	Sí	String	Especifica el ID del proyecto. Para obtener más información sobre cómo obtener un ID de proyecto, consulte Obtención de un ID de proyecto.
marker	No	String	Especifica un ID de recurso para la consulta de paginación, que indica que la consulta comienza en el siguiente registro del ID de recurso especificado. Este parámetro puede funcionar junto con el parámetro limit. Si no se pasan los parámetros marker y limit, se devolverán los registros de recursos de la primera página. Si no se pasa el parámetro marker y el valor del parámetro limit se establece en 10 se devolverán los 10 primeros registros de recursos. Si el valor del parámetro marker se establece en el ID de recurso del 10º registro y el valor del parámetro limit se establece en 10, se devolverán los registros de recursos del 11º al 20º. Si el valor del parámetro marker se establece en el ID de recurso del 10º registro y no se pasa el parámetro limit, se devolverán los registros de recursos que comienzan desde el 11º registro (incluido el 11º).
limit	No	Integer	Especifica el número de registros que se devolverán en cada página. El valor es de 0 a intmax (2^31-1). limit se puede utilizar junto con marker. Para obtener más información, consulte la descripción de parámetros de marker.
vpc_id	No	String	Especifica que el ID de VPC se utiliza como condición de filtrado.

Mensaje de solicitud

Parámetro de solicitud
No hay

Ejemplo de la solicitud

GET https://{Endpoint}/v1/{project_id}/subnets

Mensaje de la respuesta

Parámetro de respuesta

**Tabla 2** Parámetro de respuesta
Nombre	Tipo	Descripción
subnets	Array of subnet objects	Especifica las subredes.

**Tabla 3** Objetos de **subnet**
Nombre	Tipo	Descripción
id	String	Especifica un ID de recurso en formato UUID.
name	String	Especifica el nombre de la subred. El valor puede contener de 1 a 64 caracteres, incluidos letras, dígitos, guiones bajos (_), guiones (-) y puntos (.).
description	String	Proporciona la información adicional sobre la subred. El valor no puede contener más de 255 caracteres y no puede contener los corchetes angulares (< o >).
cidr	String	Especifica el bloque CIDR de subred.
gateway_ip	String	Especifica la dirección de gateway de subred.
ipv6_enable	Boolean	Especifica si se puede crear una subred IPv6.
cidr_v6	String	Especifica el bloque CIDR de subred IPv6. Si la subred es una subred IPv4, este parámetro no se devuelve.
gateway_ip_v6	String	Especifica el gateway de subred IPv6. Si la subred es una subred IPv4, este parámetro no se devuelve.
dhcp_enable	Boolean	Especifica si la función DHCP está habilitada para la subred.
primary_dns	String	Especifica la dirección IP del servidor DNS 1 en la subred.
secondary_dns	String	Especifica la dirección IP del servidor DNS 2 en la subred.
dnsList	Array of strings	Especifica la lista de direcciones IP de los servidores DNS de la subred.
availability_zone	String	Identifica la AZ a la que pertenece la subred.
vpc_id	String	Especifica el ID de la VPC a la que pertenece la subred.
status	String	Especifica el estado de la subred. El valor puede ser ACTIVE, UNKNOWN o ERROR. ACTIVE: indica que la subred se ha asociado a una VPC. UNKNOWN: indica que la subred no se ha asociado con una VPC. ERROR indica que la subred es anormal.
neutron_network_id	String	Especifica el ID de la red correspondiente (API de OpenStack Neutron).
neutron_subnet_id	String	Especifica el ID de la subred correspondiente (API de OpenStack Neutron).
neutron_subnet_id_v6	String	Especifica el ID de la subred IPv6 (API de OpenStack Neutron). Si la subred es una subred IPv4, este parámetro no se devuelve.
extra_dhcp_opts	Array of extra_dhcp_opt objects	Especifica la dirección del servidor NTP o el tiempo de concesión DHCP configurado para la subred. Para obtener más información, véase Tabla 4.
scope	String	Especifica dónde se utiliza la subred. Valores: center: La subred se utiliza en una AZ central. {azId}: La subred se utiliza en una AZ de borde.
tenant_id	String	Especifica el ID del proyecto de empresa.
created_at	String	Especifica la hora (UTC) en la que se crea la subred. Formato: aaaa-MM-ddTHH:mm:ss
updated_at	String	Especifica la hora (UTC) en la que se crea la subred. Formato: aaaa-MM-ddTHH:mm:ss

**Tabla 4** Objeto de **extra_dhcp_opt**
Nombre	Obligatorio	Tipo	Descripción
opt_value	No	String	Especifica la dirección del servidor NTP o el tiempo de caducidad de la concesión DHCP configurado para la subred. Restricciones: La opción ntp para opt_name indica el servidor NTP configurado para la subred. Actualmente, solo se admiten direcciones IPv4. Se puede configurar un máximo de cuatro direcciones IP, y cada dirección debe ser única. Varias direcciones IP deben separarse mediante las comas (,). La opción null para opt_name indica que no hay ningún servidor NTP configurado para la subred. El valor del parámetro no puede ser una string vacía. La opción addresstime para opt_name indica el tiempo de caducidad de la concesión DHCP. El valor puede ser -1 que indica el tiempo de concesión ilimitado o Number+h. El número varía de 1 a 30,000. Por ejemplo, el valor puede ser 5h. El valor predeterminado es 24h.
opt_name	Sí	String	Especifica el nombre de la dirección del servidor de NTP o el nombre del tiempo de expiración de la concesión DHCP configurado para la subred. Actualmente, el valor solo se puede establecer en ntp o addresstime.

Ejemplo de la respuesta

{
    "subnets": [
        {
            "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",
            "ipv6_enable": true, 
            "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",//For example, the AZ is 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"
        },
        {
            "id": "531dec0f-3116-411b-a21b-e612e42349fd",
            "name": "Subnet1",
            "description": "",
            "cidr": "192.168.1.0/24",
            "dnsList": [
                "114.xx.xx.114",
                "114.xx.xx.115"
            ],
            "status": "ACTIVE",
            "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85",
            "gateway_ip": "192.168.1.1",
            "ipv6_enable": false,
            "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": "531dec0f-3116-411b-a21b-e612e42349fd",
            "neutron_subnet_id": "1aac193-a2ad-f153-d122-12d64c2c1d78",
            "extra_dhcp_opts": [
              {
                "opt_value": "10.100.0.33,10.100.0.34",
                "opt_name": "ntp"
              }
           ],
            "tenant_id": "087679f0aa80d32a2f4ec0172f5e902b",
            "created_at": "2022-12-15T03:41:22",
            "updated_at": "2022-12-15T03:41:22"
        }
    ]
}