Asignación de una dirección IP privada
Función
Esta API se utiliza para asignar una dirección IP privada.
URI
POST /v1/{project_id}/privateips
Nombre |
Obligatorio |
Descripción |
---|---|---|
project_id |
Sí |
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. |
Mensaje de solicitud
- Parámetro de solicitud
Tabla 2 Parámetro de solicitud Nombre
Obligatorio
Tipo
Descripción
privateips
Sí
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
Obligatorio
Tipo
Descripción
subnet_id
Sí
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.
ip_address
No
String
- Especifica la dirección IP de destino.
- El valor puede ser una dirección IP disponible en la subred. Si no se especifica, el sistema asigna automáticamente una dirección IP.
- Ejemplo de la solicitud
POST https://{Endpoint}/v1/{project_id}/privateips { "privateips": [ { "subnet_id": "531dec0f-3116-411b-a21b-e612e42349fd" }, { "subnet_id": "531dec0f-3116-411b-a21b-e612e42349fd", "ip_address": "192.168.1.17" } ] }
Mensaje de la respuesta
- Parámetro de respuesta
Tabla 4 Parámetro de respuesta 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 5.
Tabla 5 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": "c60c2ce1-1e73-44bd-bf48-fd688448ff7b", "subnet_id": "531dec0f-3116-411b-a21b-e612e42349fd", "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c", "device_owner": "", "ip_address": "192.168.1.10" }, { "status": "DOWN", "id": "4b123c18-ae92-4dfa-92cd-d44002359aa1", "subnet_id": "531dec0f-3116-411b-a21b-e612e42349fd", "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c", "device_owner": "", "ip_address": "192.168.1.17" } ] }
Código de estado
Véase Códigos de estado.
Código de error
Véase Códigos de error.