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> Consulta del uso de direcciones IP> Consulta del uso de direcciones IP en una red especificada
Actualización más reciente 2023-02-03 GMT+08:00

Consulta del uso de direcciones IP en una red especificada

Función

Esta API se utiliza para consultar el uso de la dirección IP en una red especificada.

La información obtenida incluye el número total de direcciones IP en la red, el número de direcciones IP en uso en la red, el número total de direcciones IP en cada subred y el número de direcciones IP en uso en la subred.

  • El sistema reserva la primera y las dos últimas direcciones IP de cada subred para el gateway y el servicio DHCP.
  • El número total de direcciones IP y el número de direcciones IP en uso descritos en esta sección y en las secciones posteriores no incluyen las direcciones IP reservadas por el sistema.
  • Al asignar una dirección IP, puede especificar la dirección IP reservada para el sistema. Las direcciones IP reservadas no se incluirán en el número de direcciones IP en uso ni en el número total de direcciones IP, independientemente de cómo se asigne la dirección IP.

URI

GET /v2.0/network-ip-availabilities/{network_id}

Tabla 1 describe los parámetros.
Tabla 1 Descripción de parámetros

Parámetro

Tipo

Obligatorio

Descripción

network_id

String

Especifica el ID de red.

NOTA:

network_id indica el ID de subred utilizado cuando se llama a la API de subred de VPC.

Para obtener más información, consulte Cuál es la diferencia entre la API de subred de VPC y la API de subred de Neutron de OpenStack?.

Mensaje de solicitud

  • Parámetro de solicitud

    Ninguno

  • Ejemplo de solicitud
    GET https://{Endpoint}/v2.0/network-ip-availabilities/6b50d967-779c-40c9-a157-de1df3c17043

Mensaje de respuesta

  • Parámetro de respuesta
    Tabla 2 Parámetro de respuesta

    Nombre

    Tipo

    Descripción

    network_ip_availability

    network_ip_availability object

    Especifica los objetos de network_ip_availability. Para más detalles, consulte Tabla 3.

    Tabla 3 Objetos de network_ip_availability

    Nombre

    Tipo

    Descripción

    network_id

    String

    Especifica el ID de red.

    network_name

    String

    Especifica el nombre de red.

    tenant_id

    String

    Especifica el ID del proyecto.

    total_ips

    Integer

    Especifica el número total de direcciones IP de una red. (Las direcciones IP reservadas del sistema no están incluidas.)

    used_ips

    Integer

    Especifica el número de direcciones IP en uso en una red. (Las direcciones IP reservadas no están incluidas.)

    subnet_ip_availability

    Array of subnet_ip_availability objects

    Especifica los objetos de uso de direcciones IP de subred. Para más detalles, consulte Tabla 4.

    Tabla 4 Descripción del campo subnet_ip_availability

    Parámetro

    Tipo

    Descripción

    used_ips

    Integer

    Especifica el número de direcciones IP en uso en una subred. (Las direcciones IP reservadas del sistema no están incluidas.)

    subnet_id

    String

    Especifica el ID de subred.

    Si utiliza la consola de gestión, el valor de este parámetro es el valor Network ID.

    subnet_name

    String

    Especifica el nombre de subred.

    ip_version

    Integer

    Especifica la versión IP de la subred. Solo se admite IPv4.

    cidr

    String

    Especifica el bloque CIDR de subred.

    total_ips

    Integer

    Especifica el número total de direcciones IP de una subred. (Las direcciones IP reservadas del sistema no están incluidas.)

  • Ejemplo de respuesta
    {
      "network_ip_availability": {
        "used_ips": 4,
        "subnet_ip_availability": [
          {
            "used_ips": 4,
            "subnet_id": "98e343d1-3cb8-4f69-9cd1-00569819480f",
            "subnet_name": "",
            "ip_version": 4,
            "cidr": "10.0.0.0/8",
            "total_ips": 300
          }
        ],
        "network_id": "6b50d967-779c-40c9-a157-de1df3c17043",
        "tenant_id": "7c4b23cb125d481c95cbe4f91b2c11cd",
        "total_ips": 300,
        "network_name": "pch_test_003"
      }
    }

Código de estado

Consulte Códigos de estado.

Código de error

Consulte Códigos de error.