Consulta de direcciones IP privadas
Función
Esta API se utiliza para consultar direcciones IP privadas mediante criterios de búsqueda y para mostrar las direcciones IP privadas en una lista.
URI
GET /v1/{project_id}/subnets/{subnet_id}/privateips
GET https://{Endpoint}/v1/{project_id}/subnets/{subnet_id}/privateips?limit=10&marker=4779ab1c-7c1a-44b1-a02e-93dfc361b32d
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. |
subnet_id |
Sí |
String |
Especifica el identificador único de la subred a la que pertenece la dirección IP privada. Si utiliza la consola de gestión, el valor de este parámetro es el valor Network ID. |
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.
|
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. |
Mensaje de solicitud
Mensaje de la respuesta
- Parámetro de solicitud
Tabla 2 Parámetro de solicitud Nombre
Tipo
Descripción
privateips
Array of privateip objects
Especifica los objetos de dirección IP privada. Para obtener más información, véase Tabla 3.
Tabla 3 Descripción del campo privateip Nombre
Tipo
Descripción
status
String
- Especifica el estado de la dirección IP privada.
- Los valores posibles son los siguientes:
- ACTIVE
- DOWN
id
String
Especifica el ID de la dirección IP privada, que identifica de forma exclusiva la dirección IP privada.
subnet_id
String
Especifica el ID de la subred desde la que se asignan las direcciones IP.
Si utiliza la consola de gestión, el valor de este parámetro es el valor Network ID.
tenant_id
String
Especifica el ID del proyecto.
device_owner
String
- Especifica el recurso que utiliza la dirección IP privada. El parámetro se deja en blanco si no se utiliza.
- El valor puede ser network:dhcp, network:router_interface_distributed, compute:xxx o neutron:VIP_PORT. (En el valor compute:xxx, xxx especifica el nombre de la AZ, por ejemplo, compute:aa-bb-cc indica que la dirección IP privada es utilizada por un ECS en la AZ aa-bb-cc).
- El intervalo de valores especifica solo el tipo de direcciones IP privadas admitidas por el servicio actual.
ip_address
String
Especifica la dirección IP privada asignada.
- Ejemplo de la respuesta
{ "privateips": [ { "status": "DOWN", "id": "d600542a-b231-45ed-af05-e9930cb14f78", "subnet_id": "531dec0f-3116-411b-a21b-e612e42349fd", "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c", "device_owner": "", "ip_address": "192.168.1.11" }, { "status": "DOWN", "id": "d600542a-b231-45ed-af05-e9930cb14f79", "subnet_id": "531dec0f-3116-411b-a21b-e612e42349fd", "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c", "device_owner": "", "ip_address": "192.168.1.12" } ] }
Código de estado
Véase Códigos de estado.
Código de error
Véase Códigos de error.