Modificación de un grupo de AS

Función

Esta API se utiliza para modificar un grupo AS especificado.

• Cuando se cambia la configuración de AS de un grupo de AS, las instancias existentes creadas con la configuración de AS original no se ven afectadas.
• Si no se realiza ninguna acción de ajuste, puede modificar sus configuraciones de subred, ELB y AZ.
• Si cambia el número de instancias esperadas en un grupo AS, se activará una acción de ajuste para agregar o quitar instancias hacia o desde el grupo AS. El número de instancias esperadas debe ser mayor o igual que el número mínimo de instancias y menor o igual que el número máximo de instancias.

URI

PUT /autoscaling-api/v1/{project_id}/scaling_group/{scaling_group_id}

Mensaje de solicitud

• Parámetros de solicitud

  Tabla 2 Parámetros de solicitud

  Parámetro	Obligatorio	Tipo	Descripción
  scaling_group_name	No	String	Especifica el nombre del grupo AS. El nombre solo contiene letras, dígitos, guiones bajos (_), y guiones (-) y no puede superar los 64 caracteres.
  desire_instance_number	No	Integer	Especifica el número esperado de instancias. El valor varía desde el número mínimo de instancias hasta el número máximo de instancias.
  min_instance_number	No	Integer	Especifica el número mínimo de instancias.
  max_instance_number	No	Integer	Especifica el número máximo de instancias, que es mayor o igual que el número mínimo de instancias.
  cool_down_time	No	Integer	Especifica el período de enfriamiento (en segundos). El valor oscila entre 0 y 86400 y es 300 de forma predeterminada.
  available_zones	No	Array of strings	Especifica la información de AZ. Las instancias agregadas en una acción de ajuste se crearán en un AZ especificado. Si no especifica una AZ, el sistema la especifica automáticamente. Para obtener más información, consulte Regiones y endpoint. Puede cambiar el AZ de un grupo AS sólo cuando no se está realizando ninguna acción de ajuste en el grupo.
  networks	No	Array of networks objects	Especifica la información de red. Puede seleccionar hasta cinco subredes. La primera subred que seleccione es utilizada por las NIC primarias de los ECS de forma predeterminada. Para obtener información acerca de las subredes, consulte Consulta de subredes. Para obtener información sobre la estructura de datos, consulte Tabla 4. El valor de este parámetro solo se puede cambiar si se cumplen todas las condiciones siguientes: No se activan acciones de ajuste en el grupo AS. El número de instancias en el grupo AS es 0. El grupo AS no está en servicio.
  security_groups	No	Array of security_groups objects	Especifica el grupo de seguridad. Se puede seleccionar un máximo de un grupo de seguridad. Para obtener información sobre grupos de seguridad, consulte Consulta de grupos de seguridad. Para obtener información sobre la estructura de datos, consulte Tabla 7. Si el grupo de seguridad se especifica tanto en la configuración de AS como en el grupo de AS, las instancias de ECS escaladas se agregarán al grupo de seguridad especificado en la configuración de AS. Si el grupo de seguridad no se especifica en ninguno de ellos, las instancias de ECS escaladas se agregarán al grupo de seguridad predeterminado. Para su comodidad, se recomienda especificar el grupo de seguridad en la configuración AS. El valor de este parámetro solo se puede cambiar si se cumplen todas las condiciones siguientes: No se activan acciones de ajuste en el grupo AS. El número de instancias en el grupo AS es 0. El grupo AS no está en servicio.
  lb_listener_id	No	String	Especifica el ID de un oyente de balanceador de carga clásico. El sistema admite la unión de hasta seis oyentes del balanceador de carga, cuyos identificadores se separan mediante una coma (,). Para obtener más información sobre cómo obtener el ID de oyente, consulte Consulta de balanceadores de carga. El valor de este parámetro solo se puede cambiar si se cumplen todas las condiciones siguientes: No se activan acciones de ajuste en el grupo AS. El número de instancias en el grupo AS es 0. El grupo AS no está en servicio.
  lbaas_listeners	No	Array of lbaas_listeners objects	Especifica información sobre un balanceador de carga mejorado. El sistema soporta la unión de hasta seis balanceadores de carga. Este parámetro está en la estructura de datos de lista. Para más detalles, consulte Tabla 3. Para obtener información sobre un balanceador de carga mejorado, consulte Consulta de grupos de servidores backend.
  health_periodic_audit_method	No	String	Especifica el método de comprobación de estado para las instancias del grupo AS. Los métodos de comprobación de estado incluyen ELB_AUDIT y NOVA_AUDIT. Cuando se configura el equilibrio de carga para un grupo AS, el valor predeterminado es ELB_AUDIT. De lo contrario, el valor predeterminado es NOVA_AUDIT. ELB_AUDIT: indica la comprobación de estado ELB, que tiene efecto en un grupo AS con un oyente. NOVA_AUDIT: indica la comprobación de estado de ECS, que es el método de comprobación de estado suministrado con AS.
  health_periodic_audit_time	No	Integer	Especifica el período de comprobación de estado para las instancias del grupo AS. El valor puede ser 1, 5, 15, 60 o 180 en la unidad de minutos. Si el valor se establece en 0, la comprobación de estado se realiza cada 10 segundos.
  instance_terminate_policy	No	String	Especifica la política de eliminación de instancia. OLD_CONFIG_OLD_INSTANCE (predeterminado): Las instancias creadas anteriormente basadas en las configuraciones de AS creadas anteriormente se eliminan primero. OLD_CONFIG_NEW_INSTANCE: Las instancias creadas más tarde basadas en las configuraciones de AS creadas anteriormente se eliminan primero. OLD_INSTANCE: Las instancias creadas anteriormente se eliminan primero. NEW_INSTANCE: Las instancias creadas posteriormente se eliminan primero.
  health_periodic_audit_grace_period	No	Integer	Especifica el período de gracia de la comprobación de estado de las instancias. La unidad es segunda y el rango de valores es 0-86400. El valor predeterminado es 600. El período de gracia de comprobación de estado comienza después de agregar una instancia a un grupo AS y está habilitado. El grupo AS comenzará a comprobar el estado de la instancia solo después de que finalice el período de gracia. Este parámetro sólo es válido cuando el método de comprobación de estado de instancia del grupo AS es ELB_AUDIT.
  scaling_configuration_id	No	String	Especifica el ID de configuración de AS, que se puede obtener mediante la API para consultar configuraciones de AS. Para más detalles, consulte Consulta de configuraciones de AS.
  notifications	No	Array of strings	Especifica el modo de notificación. EMAIL se refiere a la notificación por correo electrónico. Este modo de notificación ha sido cancelado. Se recomienda configurar la función de notificación para el grupo AS. Para más detalles, consulte Notificaciones.
  delete_publicip	No	Boolean	Especifica si se eliminará el EIP enlazado al ECS al eliminar el ECS. Si no desea eliminar el EIP, establezca este parámetro en false. Entonces, el sistema solo desvincula el EIP del ECS y reserva el EIP. true: elimina el EIP enlazado al ECS al eliminar el ECS. Si el EIP se factura anualmente/mensualmente, no se eliminará cuando se suprima el ECS. false: solo desvincula el EIP vinculado al ECS al eliminar el ECS.
  delete_volume	No	Boolean	Especifica si se eliminarán los discos de datos adjuntos al ECS al eliminar el ECS. El valor puede ser true o false. El valor predeterminado es false. true: elimina los discos de datos conectados al ECS al eliminar el ECS. Si los discos de datos se facturan anualmente/mensualmente, no se eliminarán cuando se elimine el ECS. false: solo separa los discos de datos conectados al ECS al eliminar el ECS.
  enterprise_project_id	No	String	Especifica el ID del proyecto de empresa, que se utiliza para especificar el proyecto de empresa al que pertenece el grupo AS. Si el valor es 0 o se deja en blanco, el grupo AS pertenece al proyecto de empresa predeterminado. Si el valor es un UUID, el grupo AS pertenece al proyecto de empresa correspondiente al UUID. Para obtener un ID de proyecto de empresa, consulte Consulta de proyectos de empresa. Si se configura un proyecto de empresa para un grupo AS, los ECS creados en este grupo AS también pertenecen a este proyecto de empresa. De lo contrario, se utilizará el proyecto de empresa predeterminado. NOTA: Para obtener más información acerca de las características del proyecto de empresa, consulte Servicio de Enterprise Project Management.
  multi_az_priority_policy	No	String	Especifica la política de prioridad utilizada para seleccionar AZ de destino al ajustar el número de instancias de un grupo AS. EQUILIBRIUM_DISTRIBUTE (predeterminado): Al ajustar el número de instancias, asegúrese de que las instancias en cada AZ de la lista available_zones estén distribuidas uniformemente. Si no se pueden agregar instancias en el AZ de destino, seleccione otra AZ basada en la política PICK_FIRST. PICK_FIRST: Al ajustar el número de instancias, los AZ de destino se determinan en el orden en la lista available_zones.
  description	No	String	Especifica la descripción del grupo AS. El valor puede contener de 1 a 256 caracteres.
  iam_agency_name	No	String	Especifica el nombre de la delegación, en 1 a 64 caracteres. Si iam_agency_name se establece en null, no es necesario modificarlo. Si iam_agency_name se deja en blanco o tiene un valor, es necesario modificarlo.

  Tabla 3 Descripción del campo lbaas_listeners

  Parámetro	Obligatorio	Tipo	Descripción
  pool_id	Sí	String	Especifica el ID del grupo ECS backend. El valor de este parámetro solo se puede cambiar si se cumplen todas las condiciones siguientes: No se activan acciones de ajuste en el grupo AS. El número de instancias en el grupo AS es 0. El grupo AS no está en servicio.
  protocol_port	Sí	Integer	Especifica el ID de protocolo de backend, que es el puerto en el que un ECS de backend escucha el tráfico. El ID de puerto oscila entre 1 y 65535.
  weight	Sí	Integer	Especifica el peso, que determina la porción de solicitudes que un ECS backend procesa cuando se compara con otros ECS backend agregados al mismo oyente. El valor de este parámetro varía de 0 a 100.

  Tabla 4 Descripción del campo networks

  Parámetro	Obligatorio	Tipo	Descripción
  id	Sí	String	Especifica el ID de subred.
  ipv6_enable	No	Boolean	Especifica si se admiten direcciones IPv6. true: indica que la NIC admite direcciones IPv6. false: indica que la NIC no admite direcciones IPv6. El valor predeterminado es false.
  ipv6_bandwidth	No	ipv6_bandwidth object	Especifica el ancho de banda compartido de una dirección IPv6. Este parámetro se deja en blanco de forma predeterminada, lo que indica que no hay ningún ancho de banda IPv6 compartido.
  allowed_address_pairs	No	Array of allowed_address_pairs objects	Especifica si se permite al sistema comprobar las direcciones de origen y destino.

  Tabla 5 Descripción del campo ipv6_bandwidth

  Parámetro	Obligatorio	Tipo	Descripción
  id	Sí	String	Especifica el ID del ancho de banda compartido de una dirección IPv6.

  Tabla 6 Descripción del campo allowed_address_pairs

  Parámetro	Tipo	Descripción
  ip_address	String	Especifica si se permite al sistema comprobar las direcciones de origen y destino. Por defecto, esta función está habilitada. Este parámetro no se puede dejar vacío. Para deshabilitar esta función, establezca el valor en 1.1.1.1/0. Para habilitar esta función, establezca un valor distinto de 1.1.1.1/0.

  Tabla 7 Descripción del campo security_groups

  Parámetro	Obligatorio	Tipo	Descripción
  id	Sí	String	Especifica el ID del grupo de seguridad.

• Ejemplo de la solicitud
  Este ejemplo muestra cómo cambiar el nombre, la configuración de AS, el proyecto de empresa, el número esperado de instancias, el número mínimo de instancias, el número máximo de instancias, y período de enfriamiento del grupo AS con ID a8327883-6b07-4497-9c61-68d03ee193a1.

  PUT https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group/a8327883-6b07-4497-9c61-68d03ee193a1
  
  {
      "scaling_group_name": "group_1",
      "scaling_configuration_id": "f8327883-6a07-4497-9a61-68c03e8e72a2",
      "enterprise_project_id": "c92b1a5d-6f20-43f2-b1b7-7ce35e58e413",
      "desire_instance_number": 1,
      "min_instance_number": 1,
      "max_instance_number": 3,
      "cool_down_time": 200,
      "multi_az_priority_policy": "PICK_FIRST"
   ":"test"
  }

Mensaje de la respuesta

• Parámetros de respuesta

  Tabla 8 Parámetros de respuesta

  Parámetro	Tipo	Descripción
  scaling_group_id	String	Especifica el ID de grupo AS.

• Ejemplo de la respuesta

  {
      "scaling_group_id": "a8327883-6b07-4497-9c61-68d03ee193a1"
  }

Valores devueltos

• Normal

  200

• Anormal

  Valor devuelto	Descripción
  400 Bad Request	Se produjo un error en el servidor al procesar la solicitud.
  401 Unauthorized	Debe introducir el nombre de usuario y la contraseña para acceder a la página solicitada.
  403 Forbidden	Está prohibido el acceso a la página solicitada.
  404 Not Found	No se pudo encontrar la página solicitada.
  405 Method Not Allowed	No se le permite utilizar el método especificado en la solicitud.
  406 Not Acceptable	El cliente no pudo aceptar la respuesta generada por el servidor.
  407 Proxy Authentication Required	Debe utilizar el servidor proxy para la autenticación para que la solicitud pueda procesarse.
  408 Request Timeout	Se agotó el tiempo de espera de la solicitud.
  409 Conflict	La solicitud no se pudo procesar debido a un conflicto.
  500 Internal Server Error	Se produjo un error al completar la solicitud debido a un problema de servicio interno.
  501 Not Implemented	Error al completar la solicitud porque el servidor no admite la función solicitada.
  502 Bad Gateway	Error al completar la solicitud porque la solicitud no es válida.
  503 Service Unavailable	Error al completar la solicitud porque el sistema no está disponible.
  504 Gateway Timeout	Se ha producido un error de tiempo de espera de la puerta de enlace.

Códigos de error

Consulte Códigos de error