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/ Elastic Load Balance/ Referencia de la API/ API del balanceador de carga dedicado/ Balanceador de carga/ Actualización de un balanceador de carga
Actualización más reciente 2022-11-17 GMT+08:00
Ver PDF
Compartir

Actualización de un balanceador de carga

Función

Esta API se utiliza para actualizar un balanceador de carga.

URI

PUT /v3/{project_id}/elb/loadbalancers/{loadbalancer_id}

Tabla 1 Parámetros de ruta

Parámetro

Obligatorio

Tipo

Descripción

loadbalancer_id

Sí

String

Especifica el ID del balanceador de carga.

Mínimo: 0

Máximo: 36

project_id

Sí

String

Especifica el ID del proyecto.

Mínimo: 0

Máximo: 36

Parámetros de solicitud

Tabla 2 Parámetros de cabecera de solicitud

Parámetro

Obligatorio

Tipo

Descripción

X-Auth-Token

Sí

String

Especifica el token utilizado para la autenticación IAM.

Mínimo: 0

Máximo: 4096
Tabla 3 Parámetros del cuerpo de solicitud

Parámetro

Obligatorio

Tipo

Descripción

loadbalancer

Sí

UpdateLoadBalancerOption object

Especifica el balanceador de carga.
Tabla 4 UpdateLoadBalancerOption

Parámetro

Obligatorio

Tipo

Descripción

name

No

String

Especifica el nombre del balanceador de carga.

Mínimo: 0

Máximo: 255

admin_state_up

No

Boolean

Especifica el estado administrativo del balanceador de carga. El valor solo puede ser true.

Este parámetro no es compatible. Por favor, no lo use.

description

No

String

Proporciona información adicional sobre el balanceador de carga.

Mínimo: 0

Máximo: 255

ipv6_vip_virsubnet_id

No

String

Especifica el ID de la subred IPv6 donde reside el balanceador de carga. Puede consultar el parámetro id en la respuesta llamando a la API (GET https://{VPC_Endpoint}/v1/{project_id}/subnets).

La subred IPv6 se puede actualizar mediante ipv6_vip_virsubnet_id, y la dirección IPv6 privada del balanceador de carga se cambiará en consecuencia.

Nota:

  • Este parámetro solo se pasará cuando IPv6 esté habilitado para la subred. La subred especificada por ipv6_vip_virsubnet_id debe estar en la VPC especificada por vpc_id.
  • Este parámetro solo se puede actualizar si se establece guaranteed en true.
  • El valor se convertirá en null si la dirección IPv6 no está enlazada del balanceador de carga.
  • La subred IPv4 no cambiará si se actualiza el subconjunto IPv6. Este parámetro no es compatible. Por favor, no lo use.

vip_subnet_cidr_id

No

String

Especifica el ID de la subred IPv4 donde reside el balanceador de carga. Puede consultar el parámetro neutron_subnet_id en la respuesta llamando a la API (GET https://{VPC_Endpoint}/v1/{project_id}/subnets).

  • La subred IPv4 se puede actualizar usando vip_subnet_cidr_id, y la dirección IPv4 privada del balanceador de carga se cambiará en consecuencia. Nota:
  • Si también se especifica vip_address, la dirección IP especificada por vip_address debe estar en la subred especificada por vip_subnet_cidr_id y se utilizará como la dirección IPv4 privada del balanceador de carga.
  • La subred IPv4 debe estar en la VPC donde reside el balanceador de carga.
  • Este parámetro solo se puede actualizar si se establece guaranteed en true.
  • El valor se convertirá en null si la dirección IPv4 privada no está vinculada del balanceador de carga.
  • La subred IPv6 no cambiará si se actualiza el subconjunto IPv4.

Mínimo: 1

Máximo: 36

vip_address

No

String

Especifica la dirección IPv4 privada enlazada al balanceador de carga. La dirección IP debe provenir de la subred IPv4 donde reside el balanceador de carga y no debe estar ocupada por otros servicios.

vip_address solo se puede actualizar cuando se establece guaranteed en true.

Mínimo: 1

Máximo: 36

l4_flavor_id

No

String

Especifica el ID de una variante en la capa 4.

Nota:

  • Este parámetro solo se puede actualizar si se establece guaranteed en true.
  • El valor no se puede cambiar de null a un valor específico, o al revés.
  • Si cambia la variante, solo puede seleccionar una más alta o más baja. Si selecciona una inferior, parte de las conexiones persistentes se interrumpirá.
  • Si autoscaling.enable se establece en true, la actualización de este parámetro no tendrá efecto.

Mínimo: 1

Máximo: 255

l7_flavor_id

No

String

Especifica el ID de una variante en la capa 7.

Nota:

  • Este parámetro solo se puede actualizar si se establece guaranteed en true.
  • El valor no se puede cambiar de null a un valor específico, o al revés.
  • Si cambia la variante, solo puede seleccionar una más alta o más baja. Si selecciona una inferior, parte de las conexiones persistentes se interrumpirá.
  • Si autoscaling.enable se establece en true, la actualización de este parámetro no tendrá efecto.

Mínimo: 1

Máximo: 36

ipv6_bandwidth

No

BandwidthRef object

Especifica el identificador del ancho de banda utilizado por una dirección IPv6. Este parámetro sólo está disponible cuando se crea o actualiza un balanceador de carga con una dirección IPv6 pública. Si utiliza una nueva dirección IPv6 y especifica un ancho de banda compartido, la dirección IPv6 se agregará al ancho de banda compartido.

IPv6 no es compatible. Por favor, no utilice este parámetro.

ip_target_enable

No

Boolean

Especifica si se habilitará el backend entre VPC.

Si habilita esta función, puede agregar servidores en una VPC conectada a través de un interconexión de VPC, en una VPC conectada a través de una conexión a la nube o en un centro de datos local en el otro extremo de una conexión Direct Connect o VPN, utilizando sus direcciones IP.

Esta función solo es compatible con balanceadores de carga dedicados.

El valor puede ser true (habilitar backend cruzado de VPC) o false (habilitar backend cruzado de VPC).

El valor solo se puede actualizar a true.

Este parámetro no está disponible en la región eu-nl. Por favor, no lo use.

elb_virsubnet_ids

No

Array of strings

Especifica los identificadores de las subredes en el plano descendente. Puede consultar el parámetro neutron_network_id en la respuesta llamando a la API (GET https://{VPC_Endpoint}/v1/{project_id}/subnets).

  • Si los ID de las subredes requeridas por el balanceador de carga se especifican en elb_virsubnet_ids, las subredes seguirán enlazadas al balanceador de carga.
  • Si los ID de las subredes requeridas por el balanceador de carga no se especifican en elb_virsubnet_ids, las subredes estarán libres de los balanceadores de carga. No desvincule las subredes utilizadas por el balanceador de carga. De lo contrario, se devolverá un error.
  • Si los ID de las subredes se especifican en elb_virsubnet_ids, pero no en el plano descendente, un nuevo balanceador de carga se enlazará al plano descendente.

Nota:

  • Todas las subredes pertenecen a la misma VPC donde reside el balanceador de carga.
  • No se admiten subredes perimetrales.

Mínimo: 1

Máximo: 64

deletion_protection_enable

No

Boolean

Especifica si se habilitará la protección de eliminación para el balanceador de carga.

  • true: Habilitar la protección de eliminación.
  • false: Desactivar la protección de eliminación.
NOTA:

Desactiva la protección de eliminación de todos tus recursos antes de eliminar tu cuenta.

Este parámetro no está disponible en la región eu-nl. Por favor, no lo use.

prepaid_options

No

PrepaidUpdateOption object

Muestra la información de facturación anual/mensual durante el cambio de variantes del balanceador de carga.

autoscaling

No

UpdateLoadbalancerAutoscalingOption object

Especifica la información sobre la escala elástica. Si está habilitado el ajuste elástico, las especificaciones del balanceador de carga se pueden ajustar automáticamente en función del tráfico entrante.

Nota:

  • Este parámetro solo está disponible para los usuarios de la lista blanca.
  • Si se habilita la escala elástica, l4_flavor_id indica la variante máximo de la capa 4 para la escala elástica. l7_flavor_id indica la variante máximo de la capa 7 para el ajuste elástico.

waf_failure_action

No

String

Especifica las políticas de distribución de tráfico cuando el WAF es defectuoso.

discard: el tráfico no se distribuirá.

forward (predeterminado): El tráfico se distribuirá a los servidores backend.

Nota: Este parámetro solo tiene efecto cuando WAF está habilitado para el balanceador de carga.

QUIC_CID no es compatible.

Mínimo: 0

Máximo: 36
Tabla 5 BandwidthRef

Parámetro

Obligatorio

Tipo

Descripción

id

Sí

String

Especifica el ID de ancho de banda compartido.
Tabla 6 PrepaidUpdateOption

Parámetro

Obligatorio

Tipo

Descripción

auto_pay

No

Boolean

Especifica si el pago se deducirá automáticamente de la cuenta del cliente después de realizar un pedido.

  • true: El pago se deducirá automáticamente de la cuenta del cliente.
  • false (predeterminado): El pago no se deducirá automáticamente de la cuenta del cliente.

Si desea utilizar cupones, envíe su solicitud. El sistema cambiará automáticamente al centro de facturación, donde podrá utilizar los cupones.

Predeterminado: false

change_mode

No

String

Especifica el tipo de cambio de variante. Valores: immediate (predeterminado) indica que el cambio entra en vigor inmediatamente. delay indica que el cambio entra en efecto después de que finaliza el período actual.

Predeterminado: immediate

Mínimo: 0

Máximo: 10

period_num

No

Integer

Especifica el número de períodos de suscripción. El valor varía con la política de operación y el valor predeterminado es 1.

  • Si period_type se establece en month, el valor varía de 1 a 9.
  • Si period_type se establece en year, el valor varía de 1 a 3.

Mínimo: 1

Máximo: 9

Predeterminado: 1

period_type

No

String

Especifica el período de suscripción.

  • month (predeterminado): suscripción mensual
  • year: suscripción anual

Predeterminado: month
Tabla 7 UpdateLoadbalancerAutoscalingOption

Parámetro

Obligatorio

Tipo

Descripción

enable

Sí

Boolean

Especifica si se activa el ajuste elástico del balanceador de carga.

Las opciones son las siguientes:

  • true: Habilitar la protección de eliminación.
  • false: Desactivar la protección de eliminación.

Predeterminado: false

min_l7_flavor_id

No

String

Especifica el ID del tipo mínimo de capa 7 para la escala elástica. Este parámetro no se puede dejar en blanco si hay oyentes HTTP o HTTPS.

Mínimo: 1

Máximo: 36

Parámetros de respuesta

Código de estado: 200

Tabla 8 Parámetros del cuerpo de respuesta

Parámetro

Tipo

Descripción

loadbalancer

LoadBalancer object

Especifica el balanceador de carga. (Este parámetro se devuelve cuando se cambian las variantes de un balanceador de carga de pago por uso.)

loadbalancer_id

String

Especifica el ID del balanceador de carga. (Este parámetro se devuelve cuando el modo de facturación del balanceador de carga es anual/mensual.)

Mínimo: 0

Máximo: 36

order_id

String

Especifica el número de pedido. (Este parámetro se devuelve cuando el modo de facturación del balanceador de carga es anual/mensual.)

Mínimo: 0

Máximo: 36

request_id

String

Especifica el ID de la solicitud. El valor se genera automáticamente.

Mínimo: 0

Máximo: 36
Tabla 9 LoadBalancer

Parámetro

Tipo

Descripción

id

String

Especifica el ID del balanceador de carga.

description

String

Proporciona información adicional sobre el balanceador de carga.

Mínimo: 1

Máximo: 255

provisioning_status

String

Especifica el estado de aprovisionamiento del balanceador de carga. El valor puede ser uno de los siguientes:

  • ACTIVE: El balanceador de carga se aprovisiona correctamente.
  • PENDING_DELETE: Se está eliminando el balanceador de carga.

admin_state_up

Boolean

Especifica el estado administrativo del balanceador de carga. El valor solo puede ser true.

provider

String

Especifica el proveedor del balanceador de carga. El valor solo puede ser vlb.

pools

Array of PoolRef objects

Muestra los ID de los grupos de servidores backend asociados con el balanceador de carga.

listeners

Array of ListenerRef objects

Muestra los ID de oyentes agregados al balanceador de carga.

operating_status

String

Especifica el estado de funcionamiento del balanceador de carga. El valor solo puede ser ONLINE, lo que indica que el balanceador de carga se está ejecutando normalmente.

name

String

Especifica el nombre del balanceador de carga.

project_id

String

Especifica el ID del proyecto del balanceador de carga.

vip_subnet_cidr_id

String

Especifica el ID de la subred IPv4 donde reside el balanceador de carga.

vip_address

String

Especifica la dirección IPv4 privada enlazada al balanceador de carga.

vip_port_id

String

Especifica el ID del puerto enlazado a la dirección IPv4 privada del balanceador de carga. Cuando se crea un balanceador de carga, el sistema crea automáticamente un puerto y lo asocia a un grupo de seguridad. Sin embargo, el grupo de seguridad no tendrá efecto.

tags

Array of Tag objects

Muestra las etiquetas agregadas al balanceador de carga.

created_at

String

Especifica la hora en que se creó el balanceador de carga, con el formato yyyy-MM-dd''T''HH:mm:ss''Z''.

updated_at

String

Especifica la hora en que se actualizó el balanceador de carga, con el formato yyyy-MM-dd''T''HH:mm:ss''Z''.

guaranteed

Boolean

Especifica si el balanceador de carga es un balanceador de carga dedicado.

  • true (predeterminado): El balanceador de carga es un balanceador de carga dedicado.
  • false: El balanceador de carga es un balanceador de carga compartido.

vpc_id

String

Especifica el ID de la VPC donde reside el balanceador de carga.

eips

Array of EipInfo objects

Especifica el EIP enlazado al balanceador de carga. Solo se puede vincular un EIP a un balanceador de carga.

Este parámetro tiene el mismo significado que publicips.

ipv6_vip_address

String

Especifica la dirección IPv6 enlazada al balanceador de carga.

IPv6 no es compatible. Por favor, no utilice este parámetro.

ipv6_vip_virsubnet_id

String

Especifica el ID de la subred IPv6 donde reside el balanceador de carga.

IPv6 no es compatible. Por favor, no utilice este parámetro.

ipv6_vip_port_id

String

Especifica el ID del puerto enlazado a la dirección IPv6 del balanceador de carga.

IPv6 no es compatible. Por favor, no utilice este parámetro.

availability_zone_list

Array of strings

Especifica la lista de AZ donde se crea el balanceador de carga.

enterprise_project_id

String

Especifica el ID del proyecto de empresa.

Si este parámetro no se pasa durante la creación de recursos, se devolverá "0" y el recurso pertenece al proyecto de empresa predeterminado.

"0" no es un ID de proyecto empresarial válido y no se puede usar en las API para crear, actualizar el balanceador de carga o consultar detalles del balanceador de carga.

Este parámetro no es compatible. Por favor, no lo use.

billing_info

String

Proporciona información de facturación de recursos.

  • Si el valor se deja en blanco, el recurso se factura en modo de pago por uso.
  • Si el valor no se deja en blanco, el recurso se factura anualmente/mensualmente. El valor tiene el formato order_id:product_id:region_id:project_id, por ejemplo, CS2107161019CDJZZ:OFFI569702121789763584:az1:057ef081eb00d2732fd1c01a9be75e6f.

Este parámetro no es compatible. Por favor, no lo use.

Mínimo: 1

Máximo: 1024

l4_flavor_id

String

Especifica el ID de una variante en la capa 4.

Mínimo: 1

Máximo: 255

l4_scale_flavor_id

String

Especifica el ID de la variante reservada en la capa 4.

Este parámetro no es compatible. Por favor, no lo use.

Mínimo: 1

Máximo: 255

l7_flavor_id

String

Especifica el ID de una variante en la capa 7.

Mínimo: 1

Máximo: 255

l7_scale_flavor_id

String

Especifica el ID dla variante reservado en la capa 7.

Este parámetro no es compatible. Por favor, no lo use.

Mínimo: 1

Máximo: 255

publicips

Array of PublicIpInfo objects

Especifica el EIP enlazado al balanceador de carga. Solo se puede vincular un EIP a un balanceador de carga.

Este parámetro tiene el mismo significado que eips.

global_eips

Array of GlobalEipInfo objects

Especifica el ID del EIP global enlazado al balanceador de carga. Solo se enlazará el primer EIP global especificado en iglobal_eips.

Este parámetro no es compatible. Por favor, no lo use.

elb_virsubnet_ids

Array of strings

Muestra los identificadores de las subredes en el plano descendente.

elb_virsubnet_type

String

Especifica el tipo de subred en el plano descendente.

  • ipv4: subred IPv4
  • dualstack: subred que admite IPv4/IPv6 doble pila

ip_target_enable

Boolean

Especifica si se habilitará el backend entre VPC.

Si habilita esta función, puede agregar servidores en una VPC conectada a través de un interconexión de VPC, en una VPC conectada a través de una conexión a la nube o en un centro de datos local en el otro extremo de una conexión Direct Connect o VPN, utilizando sus direcciones IP.

Esta función solo es compatible con balanceadores de carga dedicados.

El valor puede ser true (habilitar backend cruzado de VPC) o false (habilitar backend cruzado de VPC).

El valor solo se puede actualizar a true.

Este parámetro no está disponible en la región eu-nl. Por favor, no lo use.

frozen_scene

String

Especifica el escenario en el que el balanceador de carga está congelado. Se separan varios valores mediante comas.

  • POLICE: El balanceador de carga está congelado debido a razones de seguridad.
  • ILLEGAL: El balanceador de carga está congelado debido a la violación de las leyes y regulaciones.
  • VERIFY: Su cuenta no ha completado la autenticación de nombre real.
  • RTNER: El balanceador de carga es congelado por el socio.
  • REAR: Su cuenta está en mora.

Este parámetro no es compatible. Por favor, no lo use.

ipv6_bandwidth

BandwidthRef object

Especifica el identificador del ancho de banda utilizado por una dirección IPv6. Este parámetro sólo está disponible cuando se crea o actualiza un balanceador de carga con una dirección IPv6 pública. Si utiliza una nueva dirección IPv6 y especifica un ancho de banda compartido, la dirección IPv6 se agregará al ancho de banda compartido.

IPv6 no es compatible. Por favor, no utilice este parámetro.

deletion_protection_enable

Boolean

Especifica si está habilitada la protección de eliminación.

  • false: la protección de eliminación no está habilitada.
  • true: La protección de eliminación está habilitada.
NOTA:

Desactiva la protección de eliminación de todos tus recursos antes de eliminar tu cuenta.

Este parámetro solo se devuelve cuando la protección de eliminación está habilitada en el sitio.

Este parámetro no está disponible en la región eu-nl. Por favor, no lo use.

autoscaling

AutoscalingRef object

Especifica información sobre la escala elástica. Si está habilitado el ajuste elástico, las especificaciones del balanceador de carga se pueden ajustar automáticamente en función del tráfico entrante.

Nota:

  • Este parámetro solo está disponible para los usuarios de la lista blanca.
  • Si se habilita la escala elástica, l4_flavor_id indica la variante máximo de la capa 4 para la escala elástica. l7_flavor_id indica la variante máximo de la capa 7 para el ajuste elástico.

public_border_group

String

Especifica el grupo de AZ al que pertenece el balanceador de carga.

waf_failure_action

String

Especifica las políticas de distribución de tráfico cuando el WAF es defectuoso.

discard: el tráfico no se distribuirá.

forward (predeterminado): El tráfico se distribuirá a los servidores backend.

Nota: Este parámetro solo tiene efecto cuando WAF está habilitado para el balanceador de carga.

Este parámetro no es compatible. Por favor, no lo use.
Tabla 10 PoolRef

Parámetro

Tipo

Descripción

id

String

Especifica el ID del grupo de servidores backend.
Tabla 11 ListenerRef

Parámetro

Tipo

Descripción

id

String

Especifica el ID de oyente.
Tabla 12 Tag

Parámetro

Tipo

Descripción

key

String

Especifica la clave de etiqueta.

Mínimo: 1

Máximo: 36

value

String

Especifica el valor de etiqueta.

Mínimo: 0

Máximo: 43
Tabla 13 EipInfo

Parámetro

Tipo

Descripción

eip_id

String

eip_id

eip_address

String

eip_address

ip_version

Integer

Especifica la versión IP. 4 indica IPv4 y 6 indica IPv6.

IPv6 no es compatible. El valor no puede ser 6.
Tabla 14 PublicIpInfo

Parámetro

Tipo

Descripción

publicip_id

String

Especifica el ID de EIP.

publicip_address

String

Especifica la dirección IP.

ip_version

Integer

Especifica la versión IP. El valor puede ser 4 (IPv4) o 6 (IPv6).

IPv6 no es compatible. El valor no puede ser 6.
Tabla 15 GlobalEipInfo

Parámetro

Tipo

Descripción

global_eip_id

String

Especifica el ID del EIP global.

global_eip_address

String

Especifica el EIP global.

ip_version

Integer

Especifica la versión IP. El valor puede ser 4 y 6. 4 indica una dirección IPv4, y 6 indica una dirección IPv6. [IPv6 no es compatible. No establezca este parámetro en 6.]
Tabla 16 BandwidthRef

Parámetro

Tipo

Descripción

id

String

Especifica el ID de ancho de banda compartido.
Tabla 17 AutoscalingRef

Parámetro

Tipo

Descripción

enable

Boolean

Especifica si se activa la escala elástica para el balanceador de carga.

  • true: Habilitar el ajuste elástico.
  • false: Deshabilita el ajuste elástico.

Predeterminado: false

min_l7_flavor_id

String

Especifica el ID del tipo mínimo de capa 7 para la escala elástica. Este parámetro no se puede dejar en blanco si hay oyentes HTTP o HTTPS.

Mínimo: 1

Máximo: 36

Ejemplo de las solicitudes

Actualización de un balanceador de carga

PUT https://{ELB_Endpoint}/v3/{project_id}/elb/loadbalancers/{loadbalancer_id}

{
  "loadbalancer" : {
    "description" : "loadbalancer",
    "name" : "loadbalancer-update"
  }
}

Ejemplo de las respuestas

Código de estado: 200

Solicitud exitosa.

{
  "request_id" : "010dad1e-32a3-4405-ab83-62a1fc5f8722",
  "loadbalancer" : {
    "id" : "2e073bf8-edfe-4e51-a699-d915b0b8af89",
    "project_id" : "b2782e6708b8475c993e6064bc456bf8",
    "name" : "loadbalancer-update",
    "description" : "loadbalancer",
    "vip_port_id" : null,
    "vip_address" : null,
    "admin_state_up" : true,
    "provisioning_status" : "ACTIVE",
    "operating_status" : "ONLINE",
    "listeners" : [ {
      "id" : "41937176-bf64-4b58-8e0d-9ff2d0d32c54"
    }, {
      "id" : "abc6ac93-ad0e-4765-bd5a-eec632efde56"
    }, {
      "id" : "b9d8ba97-6d60-467d-838d-f3550b54c22a"
    }, {
      "id" : "fd797ebd-263d-4b18-96e9-e9188d36c69e"
    } ],
    "pools" : [ {
      "id" : "0aabcaa8-c35c-4ddc-a60c-9032d0ac0b80"
    }, {
      "id" : "165d9092-396e-4a8d-b398-067496a447d2"
    } ],
    "tags" : [ ],
    "provider" : "vlb",
    "created_at" : "2019-04-20T03:10:37Z",
    "updated_at" : "2019-05-24T02:11:58Z",
    "vpc_id" : "2037c5bb-e04b-4de2-9300-9051af18e417",
    "enterprise_project_id" : "0",
    "availability_zone_list" : [ "AZ1", "AZ2", "dc3" ],
    "ipv6_vip_address" : null,
    "ipv6_vip_virsubnet_id" : null,
    "ipv6_vip_port_id" : null,
    "eips" : [ ],
    "guaranteed" : true,
    "billing_info" : null,
    "l4_flavor_id" : null,
    "l4_scale_flavor_id" : null,
    "l7_flavor_id" : null,
    "l7_scale_flavor_id" : null,
    "vip_subnet_cidr_id" : null,
    "deletion_protection_enable" : false,
    "public_border_group" : "center"
  }
}

Códigos de estado

Código de estado

Descripción

200

Solicitud exitosa.

Códigos de error

Consulte Códigos de error.

Tema principal: Balanceador de carga