Actualización de un puerto
Función
Esta API se utiliza para actualizar un puerto.
URI
PUT /v1/{project_id}/ports/{port_id}
Nombre |
Obligatorio |
Descripción |
---|---|---|
port_id |
Sí |
Especifica el ID de puerto, que identifica el puerto de forma exclusiva. |
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
Nombre
Obligatorio
Tipo
Descripción
port
Sí
port object
Especifica los objetos de puerto. Para obtener más información, véase Tabla 2.
Tabla 2 Descripción del campo port Nombre
Obligatorio
Tipo
Descripción
name
No
String
- Especifica el nombre del puerto.
- El valor no puede contener más de 255 caracteres. Este parámetro se deja en blanco por defecto.
security_groups
No
Array of strings
Especifica el UUID del grupo de seguridad. Este es un atributo extendido.
allowed_address_pairs
No
Array of allow_address_pair objects
- Especifica un conjunto de cero o más pares de direcciones permitidos. Un par de direcciones consiste en una dirección IP y una dirección MAC. Para obtener más información, consulte el parámetro allow_address_pair de Tabla 3.
- Restricciones:
- La dirección IP no puede ser 0.0.0.0/0.
- Configure un grupo de seguridad dedicado para el puerto si el parámetro allowed_address_pairs tiene un bloque CIDR grande (máscara de subred menor que 24).
- Si el valor de allowed_address_pairs es de 1.1.1.1/0 la comprobación de origen/destino está deshabilitada.
- Para asignar una dirección IP virtual a un ECS, la dirección IP configurada en allowed_address_pairs debe ser una dirección IP NIC ECS existente. De lo contrario, la dirección IP virtual no se puede utilizar para la comunicación.
- Establezca el allowed_address_pairs del servidor en la nube en 1.1.1.1/0.
extra_dhcp_opts
No
Array of extra_dhcp_opt objects
Especifica la opción extendida (atributo extendido) de DHCP. Para obtener más información, véase Tabla 4.
Tabla 3 Objeto de allow_address_pair Nombre
Obligatorio
Tipo
Descripción
ip_address
Sí
String
- Especifica la dirección IP.
- No se puede establecer en 0.0.0.0/0.
- Configure un grupo de seguridad dedicado para el puerto si el parámetro allowed_address_pairs tiene un bloque CIDR grande (máscara de subred menor que 24).
- Si el valor de allowed_address_pairs es 1.1.1.1/0, la comprobación de origen/destino está deshabilitada.
- Establezca el allowed_address_pairs del servidor en la nube en 1.1.1.1/0.
- Si se especifica el valor de parámetro allowed_address_pairs, el parámetro ip_address es obligatorio.
mac_address
No
String
Especifica la dirección MAC.
Tabla 4 Objeto de extra_dhcp_opt Nombre
Obligatorio
Tipo
Descripción
opt_name
No
String
Especifica el nombre de la opción DHCP. El valor de este parámetro sólo puede ser 51, lo que indica el tiempo de concesión DHCP.
opt_value
No
String
Especifica el valor de la opción DHCP.
Si el valor de opt_name es 51, el formato de valor de opt_value es Xh, lo que indica que el tiempo de concesión DHCP es X horas.
El valor de X es -1 o de 1 a 30000. Si el valor es -1, el tiempo de concesión DHCP es infinito.
- Ejemplo de la solicitud
PUT https://{Endpoint}/v1/{project_id}/ports/7204e0da-40de-4207-a536-6f59b84f6f0e { "port": { "name": "adc" } }
Mensaje de la respuesta
- Parámetro de respuesta
Tabla 5 Parámetro de respuesta Nombre
Tipo
Descripción
port
port object
Especifica los objetos de puerto. Para obtener más información, véase Tabla 6.
Tabla 6 Descripción del campo port Parámetro
Tipo
Descripción
id
String
Especifica el ID de puerto, que identifica el puerto de forma exclusiva.
name
String
- Especifica el nombre del puerto.
- El valor no puede contener más de 255 caracteres. Este parámetro se deja en blanco por defecto.
network_id
String
- Especifica el ID de la red a la que pertenece el puerto.
- El ID de red debe ser real en el entorno de red.
NOTA:Para obtener el ID de red:
- Método 1: Inicie sesión en la consola de VPC y haga clic en la subred de destino en la página Subnets. Puede ver el ID de red en la página mostrada.
- Método 2: llame a la API para consultar subredes. Para obtener más información, véase la sección Consulta de subredes.
admin_state_up
Boolean
- Especifica el estado administrativo del puerto.
- El valor solo puede ser true y el valor predeterminado es true.
mac_address
String
- Especifica la dirección MAC del puerto.
- El sistema establece automáticamente este parámetro y no se le permite configurar el valor del parámetro.
fixed_ips
Array of fixed_ip objects
- Especifica la dirección IP del puerto. Por ejemplo, el valor es "fixed_ips": [{"subnet_id": "4dc70db6-cb7f-4200-9790-a6a910776bba", "ip_address": "192.169.25.79"}]. Para obtener más información, véase Tabla 7.
- En escenarios IPv4, un puerto solo admite una dirección IP fija que no se puede cambiar. En escenarios IPv6, un puerto admite un máximo de dos direcciones IP fijas que no se pueden cambiar.
device_id
String
- Especifica el ID del dispositivo al que pertenece el puerto.
- El sistema establece automáticamente este parámetro y no se le permite configurar ni cambiar el valor del parámetro.
device_owner
String
- Especifica el dispositivo perteneciente, que puede ser el servidor DHCP, el enrutador, el balanceador de carga o Nova.
- El sistema establece automáticamente este parámetro y no se le permite configurar ni cambiar el valor del parámetro.
tenant_id
String
Especifica el ID del proyecto.
status
String
- Especifica el estado del puerto. El estado de un puerto HANA SR-IOV VM es siempre DOWN.
- El valor puede ser ACTIVE, BUILD o DOWN.
Si el valor de allowed_address_pairs es la dirección IP de la NIC de ECS, el puerto correspondiente a la dirección IP virtual está enlazado.
security_groups
Array of strings
Especifica el UUID del grupo de seguridad (atributo extendido).
allowed_address_pairs
Array of allow_address_pair objects
- Especifica un conjunto de cero o más pares de direcciones permitidos. Un par de direcciones consiste en una dirección IP y una dirección MAC. Para obtener más información, véase Tabla 8.
- La dirección IP no puede ser 0.0.0.0/0.
- Configure un grupo de seguridad dedicado para el puerto si el parámetro allowed_address_pairs tiene un bloque CIDR grande (máscara de subred menor que 24).
- Si el valor de allowed_address_pairs es de 1.1.1.1/0 la comprobación de origen/destino está deshabilitada.
- Establezca el allowed_address_pairs del servidor en la nube en 1.1.1.1/0.
extra_dhcp_opts
Array of extra_dhcp_opt objects
Especifica la opción extendida (atributo extendido) de DHCP. Para obtener más información, véase Tabla 9.
binding:vif_details
binding:vif_details object
Para obtener más información, véase Tabla 10.
binding:profile
Object
- Especifica la información personalizada configurada por los usuarios. Este es un atributo extendido.
binding:vnic_type
String
- Especifica el tipo de vNIC enlazado.
- El valor puede ser normal o direct.
- El parámetro normal indica la conmutación de software. El parámetro direct indica el paso a través de SR-IOV PCIe, que no es compatible.
dns_assignment
Array of dns_assignment objects
- Especifica la información de nombre de dominio privado predeterminada de la NIC principal.
- El sistema establece automáticamente este parámetro y no se le permite configurar ni cambiar el valor del parámetro.
dns_name
String
- Specifies the default private network DNS name of the primary NIC.
- The system automatically sets this parameter, and you are not allowed to configure or change the parameter value.
instance_id
String
- Especifica el ID de la instancia a la que pertenece el puerto, por ejemplo, el ID de instancia de RDS.
- El sistema establece automáticamente este parámetro y no se le permite configurar ni cambiar el valor del parámetro.
instance_type
String
- Especifica el tipo de instancia a la que pertenece el puerto, por ejemplo, RDS.
- El sistema establece automáticamente este parámetro y no se le permite configurar ni cambiar el valor del parámetro.
port_security_enabled
Boolean
- Especifica si la opción de seguridad está habilitada para el puerto. Si la opción no está habilitada, el grupo de seguridad y la indagación DHCP no tienen efecto.
zone_id
String
Especifica la zona de disponibilidad a la que pertenece el puerto.
Tabla 7 Objeto de fixed_ip Nombre
Tipo
Descripción
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.
No se puede cambiar el valor del parámetro.
ip_address
String
Especifica la dirección IP del puerto.
Tabla 8 Objeto de allow_address_pair Nombre
Tipo
Descripción
ip_address
String
- Especifica la dirección IP.
- No se puede establecer en 0.0.0.0/0.
- Configure un grupo de seguridad dedicado para el puerto si el parámetro allowed_address_pairs tiene un bloque CIDR grande (máscara de subred menor que 24).
- Si el valor de allowed_address_pairs es 1.1.1.1/0, la comprobación de origen/destino está deshabilitada.
- Establezca el allowed_address_pairs del servidor en la nube en 1.1.1.1/0.
mac_address
String
Especifica la dirección MAC.
Tabla 9 Objeto de extra_dhcp_opt Nombre
Tipo
Descripción
opt_name
String
Especifica el nombre de la opción DHCP. El valor de este parámetro sólo puede ser 51, lo que indica el tiempo de concesión DHCP.
opt_value
String
Especifica el valor de la opción DHCP.
Si el valor de opt_name es 51, el formato de valor de opt_value es Xh, lo que indica que el tiempo de concesión DHCP es X horas.
El valor de X es -1 o de 1 a 30000. Si el valor es -1, el tiempo de concesión DHCP es infinito.
Tabla 10 objeto binding:vif_details Nombre
Tipo
Descripción
primary_interface
Boolean
Si el valor es true, esta es la NIC principal.
port_filter
Boolean
Especifica el puerto utilizado para filtrar en grupos de seguridad para protegerse contra la suplantación de MAC o IP.
ovs_hybrid_plug
Boolean
Especifica que el conector híbrido OVS debe ser utilizado por las API de Nova.
- Ejemplo de la respuesta
{ "port": { "id": "7204e0da-40de-4207-a536-6f59b84f6f0e", "name": "adc", "status": "DOWN", "admin_state_up": "true", "fixed_ips": [ { "subnet_id": "689156ca-038f-4478-b265-fd26aa8bbe31", "ip_address": "192.168.0.9" } ], "mac_address": "fa:16:3e:d7:f2:6c", "network_id": "b4152e98-e3af-4e49-bb7f-7766e2b5ec63", "tenant_id": "caa6cf4337ea47fb823b15709ebe8591", "device_id": "", "device_owner": "", "security_groups": [ "59b39002-e79b-4bac-8e27-aa884ab1beb6" ], "extra_dhcp_opts": [], "allowed_address_pairs": [], "binding:vnic_type": "normal" } }
Código de estado
Véase Códigos de estado.
Código de error
Véase Códigos de error.