Actualización de un grupo de servidores backend
Función
Esta API se utiliza para actualizar un grupo de servidores backend.
Restricciones
El grupo de servidores backend solo se puede actualizar cuando el estado de aprovisionamiento del equilibrador de carga asociado es ACTIVE.
URI
PUT /v3/{project_id}/elb/pools/{pool_id}
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
pool_id |
Sí |
String |
Especifica el ID de grupo del servidor backend. |
project_id |
Sí |
String |
Especifica el ID del proyecto. |
Parámetros de solicitud
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
X-Auth-Token |
Sí |
String |
Especifica el token utilizado para la autenticación IAM. |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
pool |
Sí |
UpdatePoolOption object |
Especifica el grupo de servidores backend. |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
admin_state_up |
No |
Boolean |
Especifica el estado administrativo del grupo de servidores backend. El valor solo se puede actualizar a true. Este parámetro no es compatible. Por favor, no lo use. |
description |
No |
String |
Proporciona información adicional sobre el grupo de servidores backend. Mínimo: 0 Máximo: 255 |
lb_algorithm |
No |
String |
Especifica el algoritmo de equilibrio de carga utilizado por el equilibrador de carga para enrutar las solicitudes a los servidores backend del grupo de servidores backend asociado. El valor puede ser uno de los siguientes:
Nota:
El protocolo QUIC no se admite en la región eu-nl. |
name |
No |
String |
Especifica el nombre del grupo del servidor backend. Mínimo: 0 Máximo: 255 |
session_persistence |
No |
Especifica la sesión adhesiva. |
|
slow_start |
No |
UpdatePoolSlowStartOption object |
Especifica los detalles de inicio lento. Después de habilitar el inicio lento, los nuevos servidores backend agregados al grupo de servidores backend se calientan y el número de solicitudes que pueden recibir aumenta linealmente durante la duración de inicio lento configurada. Este parámetro se puede utilizar cuando el protocolo del grupo de servidores backend es HTTP o HTTPS. Se devolverá un error si el protocolo no es HTTP o HTTPS. Este parámetro no está disponible en la región eu-nl. Por favor, no lo use. |
member_deletion_protection_enable |
No |
Boolean |
Especifica si se habilitará la protección de eliminación para el equilibrador de carga.
NOTA:
Desactive la protección de eliminación de todos sus recursos antes de eliminar su cuenta. Este parámetro no está disponible en la región eu-nl. Por favor, no lo use. |
vpc_id |
No |
String |
Especifica el ID de la VPC donde funciona el grupo de servidores backend. Este parámetro solo se puede actualizar cuando vpc_id se deja en blanco. Mínimo: 0 Máximo: 36 |
type |
No |
String |
Especifica el tipo del grupo de servidores backend. Valores:
Nota: Este parámetro solo se puede actualizar cuando el type se deja en blanco. |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
cookie_name |
No |
String |
Especifica el nombre de la cookie. El valor puede contener solo letras, dígitos, guiones (-) guiones bajos (_), y puntos (.). Nota: Este parámetro solo tendrá efecto cuando type se establece en APP_COOKIE. |
type |
No |
String |
Especifica el tipo de sesión adhesiva. El valor puede ser SOURCE_IP, HTTP_COOKIE, o APP_COOKIE.Nota:
|
persistence_timeout |
No |
Integer |
Especifica la duración de la pegajosidad, en minutos. Este parámetro no tendrá efecto cuando type se establezca en APP_COOKIE.
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
enable |
No |
Boolean |
Especifica si se habilitará el inicio lento.
|
duration |
No |
Integer |
Especifica la duración de inicio lento, en segundos. El valor oscila entre 30 y 1200, y el valor predeterminado es 30. Mínimo: 30 Máximo: 1200 |
Parámetros de respuesta
Código de estado: 200
Parámetro |
Tipo |
Descripción |
---|---|---|
request_id |
String |
Especifica el ID de la solicitud. El valor se genera automáticamente. |
pool |
Pool object |
Especifica el grupo de servidores backend. |
Parámetro |
Tipo |
Descripción |
---|---|---|
admin_state_up |
Boolean |
Especifica el estado administrativo del grupo de servidores backend. El valor solo puede ser true. Este parámetro no es compatible. Por favor, no lo use. |
description |
String |
Proporciona información adicional sobre el grupo de servidores backend. |
healthmonitor_id |
String |
Especifica el ID de la comprobación de estado configurada para el grupo de servidores backend. |
id |
String |
Especifica el ID de grupo del servidor backend. |
lb_algorithm |
String |
Especifica el algoritmo de equilibrio de carga utilizado por el equilibrador de carga para enrutar las solicitudes a los servidores backend del grupo de servidores backend asociado. El valor puede ser uno de los siguientes:
Nota:
El protocolo QUIC no se admite en la región eu-nl. |
listeners |
Array of ListenerRef objects |
Especifica los identificadores de los listeners con los que está asociado el grupo de servidores backend. |
loadbalancers |
Array of LoadBalancerRef objects |
Especifica los ID de los equilibradores de carga con los que está asociado el grupo de servidores backend. |
members |
Array of MemberRef objects |
Especifica los ID de los servidores backend del grupo de servidores backend. |
name |
String |
Especifica el nombre del grupo del servidor backend. |
project_id |
String |
Especifica el ID del proyecto. |
protocol |
String |
Especifica el protocolo utilizado por el grupo de servidores backend para recibir solicitudes. El valor puede ser TCP, UDP, HTTP, HTTPS, o QUIC.
El protocolo QUIC no se admite en la región eu-nl. |
session_persistence |
SessionPersistence object |
Especifica la sesión adhesiva. |
ip_version |
String |
Especifica la versión de la dirección IP admitida por el grupo de servidores backend. IPv6 no es compatible. Solo se devolverá v4. |
slow_start |
SlowStart object |
Especifica los detalles de inicio lento. Después de habilitar el inicio lento, los nuevos servidores backend agregados al grupo de servidores backend se calientan y el número de solicitudes que pueden recibir aumenta linealmente durante la duración de inicio lento configurada. Este parámetro se puede utilizar cuando el protocolo del grupo de servidores backend es HTTP o HTTPS. Se devolverá un error si el protocolo no es HTTP o HTTPS. Este parámetro no está disponible en la región eu-nl. Por favor, no lo use. |
member_deletion_protection_enable |
Boolean |
Especifica si se habilitará la protección de eliminación.
NOTA:
Desactive la protección de eliminación de todos sus recursos antes de eliminar su cuenta. Este parámetro no está disponible en la región eu-nl. Por favor, no lo use. |
created_at |
String |
Especifica la hora a la que se creó un grupo de servidores backend. El formato es yyyy-MM-dd'T'HH:mm:ss'Z' (hora UTC). Este es un campo nuevo en esta versión, y no se devolverá para los recursos asociados con balanceadores de carga dedicados existentes y para los recursos asociados con balanceadores de carga compartidos existentes y nuevos. |
updated_at |
String |
Especifica la hora a la que se actualizó un grupo de servidores backend. El formato es yyyy-MM-dd'T'HH:mm:ss'Z' (hora UTC). Este es un campo nuevo en esta versión, y no se devolverá para los recursos asociados con balanceadores de carga dedicados existentes y para los recursos asociados con balanceadores de carga compartidos existentes y nuevos. |
vpc_id |
String |
Especifica el ID de la VPC donde funciona el grupo de servidores backend. |
type |
String |
Especifica el tipo del grupo de servidores backend. Valores:
|
Parámetro |
Tipo |
Descripción |
---|---|---|
id |
String |
Especifica el ID del equilibrador de carga. |
Parámetro |
Tipo |
Descripción |
---|---|---|
cookie_name |
String |
Especifica el nombre de la cookie. El valor puede contener solo letras, dígitos, guiones (-) guiones bajos (_), y puntos (.). Nota: Este parámetro solo tendrá efecto cuando type se establece en APP_COOKIE. |
type |
String |
Especifica el tipo de sesión adhesiva. El valor puede ser SOURCE_IP, HTTP_COOKIE, o APP_COOKIE.Nota:
|
persistence_timeout |
Integer |
Especifica la duración de la pegajosidad, en minutos. Este parámetro no tendrá efecto cuando type se establezca en APP_COOKIE.
|
Parámetro |
Tipo |
Descripción |
---|---|---|
enable |
Boolean |
Especifica si se habilitará el inicio lento.
Predeterminado: false |
duration |
Integer |
Especifica la duración de inicio lento, en segundos. El valor oscila entre 30 y 1200, y el valor predeterminado es 30. Mínimo: 30 Máximo: 1200 Predeterminado: 30 |
Solicitudes de ejemplo
PUT https://{ELB_Endpoint}/v3/99a3fff0d03c428eac3678da6a7d0f24/elb/pools/36ce7086-a496-4666-9064-5ba0e6840c75 { "pool" : { "name" : "My pool.", "description" : "My pool update", "lb_algorithm" : "LEAST_CONNECTIONS" } }
Ejemplo de respuestas
Código de estado: 200
Solicitud exitosa.
{ "pool" : { "type" : "", "vpc_id" : "", "lb_algorithm" : "LEAST_CONNECTIONS", "protocol" : "TCP", "description" : "My pool update", "admin_state_up" : true, "member_deletion_protection_enable" : false, "loadbalancers" : [ { "id" : "098b2f68-af1c-41a9-8efd-69958722af62" } ], "project_id" : "99a3fff0d03c428eac3678da6a7d0f24", "session_persistence" : null, "healthmonitor_id" : null, "listeners" : [ { "id" : "0b11747a-b139-492f-9692-2df0b1c87193" }, { "id" : "61942790-2367-482a-8b0e-93840ea2a1c6" }, { "id" : "fd8f954c-f0f8-4d39-bb1d-41637cd6b1be" } ], "members" : [ ], "id" : "36ce7086-a496-4666-9064-5ba0e6840c75", "name" : "My pool.", "ip_version" : "dualstack" }, "request_id" : "8f40128b-c72b-4b64-986a-f7e2c633d75f" }
Códigos de estado
Código de estado |
Descripción |
---|---|
200 |
Solicitud exitosa. |
Códigos de error
Consulte Códigos de error.