Consulta de grupos AS

Función

Esta API se utiliza para enumerar grupos AS basados en criterios de búsqueda. Los resultados se muestran por página.

• Los criterios de búsqueda pueden ser el nombre del grupo AS, el ID de configuración AS, el estado del grupo AS, el ID del proyecto empresarial, el número de línea de inicio y la cantidad de registros.
• Si no se especifica ningún criterio de búsqueda, se puede enumerar un máximo de 20 grupos AS de forma predeterminada.

URI

GET /autoscaling-api/v1/{project_id}/scaling_group

Puede escribir el signo de interrogación (?) y ampersand (&) al final del URI para definir varios criterios de búsqueda. Los grupos AS pueden ser buscados por todos los parámetros opcionales en la siguiente tabla. Para obtener más información, consulte la solicitud de ejemplo.

Mensaje de solicitud

• Parámetros de solicitud

  No hay

• Ejemplo de la solicitud
  Este ejemplo muestra cómo consultar grupos AS con el nombre as-group-test e ID de configuración AS 1d281494-6085-4579-b817-c1f813be835f.

  GET https://{Endpoint}/autoscaling-api/v1/{project_id}/scaling_group?scaling_group_name=as-group-test&scaling_configuration_id=1d281494-6085-4579-b817-c1f813be835f

Mensaje de la respuesta

• Parámetros de respuesta

  Tabla 2 Parámetros de respuesta

  Parámetro	Tipo	Descripción
  total_number	Integer	Especifica el número total de registros de consulta.
  start_number	Integer	Especifica el número inicial de registros de consulta.
  limit	Integer	Especifica el número de registros de consulta.
  scaling_groups	Array of scaling_groups objects	Especifica la lista de grupos AS.

  Tabla 3 Descripción de campo scaling_groups

  Parámetro	Tipo	Descripción
  scaling_group_name	String	Especifica el nombre del grupo AS.
  scaling_group_id	String	Especifica el ID de grupo AS.
  scaling_group_status	String	Especifica el estado del grupo AS.
  scaling_configuration_id	String	Especifica el ID de configuración de AS.
  scaling_configuration_name	String	Especifica el nombre de configuración de AS.
  current_instance_number	Integer	Especifica el número de instancias actuales del grupo AS.
  desire_instance_number	Integer	Especifica el número esperado de instancias en el grupo AS.
  min_instance_number	Integer	Especifica el número mínimo de instancias del grupo AS.
  max_instance_number	Integer	Especifica el número máximo de instancias del grupo AS.
  cool_down_time	Integer	Especifica el período o los períodos de enfriamiento.
  lb_listener_id	String	Especifica el ID de un oyente ELB típico. Los ID de oyente de ELB se separan usando una coma (,).
  lbaas_listeners	Array of lbaas_listeners objects	Especifica los balanceadores de carga mejorados. Para más detalles, consulte Tabla 4.
  available_zones	Array of strings	Especifica la información de AZ.
  networks	Array of networks objects	Especifica la información de red. Para más detalles, consulte Tabla 5.
  security_groups	Array of security_groups objects	Especifica la información del grupo de seguridad. Para más detalles, consulte Tabla 8.
  create_time	String	Especifica la hora en que se creó un grupo AS. El formato de tiempo cumple con UTC.
  vpc_id	String	Especifica el ID de la VPC a la que pertenece el grupo AS.
  detail	String	Especifica detalles sobre el grupo AS. Si se produce un error en una acción de ajuste, este parámetro se utiliza para registrar errores.
  is_scaling	Boolean	Especifica el indicador de escala del grupo AS.
  health_periodic_audit_method	String	Especifica el método de comprobación de estado.
  health_periodic_audit_time	Integer	Especifica el intervalo de comprobación de estado.
  health_periodic_audit_grace_period	Integer	Especifica el período de gracia para la comprobación de estado.
  instance_terminate_policy	String	Especifica la política de eliminación de instancia.
  notifications	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	Boolean	Especifica si se eliminará el EIP enlazado al ECS al eliminar el ECS.
  delete_volume	Boolean	Especifica si se eliminarán los discos de datos adjuntos al ECS al eliminar el ECS.
  cloud_location_id	String	Este parámetro está reservado.
  enterprise_project_id	String	Especifica el ID del proyecto de empresa.
  activity_type	String	Especifica el tipo de la acción AS.
  multi_az_priority_policy	String	Especifica la política de prioridad utilizada para seleccionar AZ de destino al ajustar el número de instancias de un grupo AS.
  description	String	Especifica la descripción del grupo AS.
  iam_agency_name	String	Especifica el nombre de la delegación.

  Tabla 4 Descripción del campo lbaas_listeners

  Parámetro	Tipo	Descripción
  listener_id	String	Especifica el ID de oyente.
  pool_id	String	Especifica el ID del grupo ECS backend.
  protocol_port	Integer	Especifica el ID de protocolo de backend, que es el puerto en el que un ECS de backend escucha el tráfico.
  weight	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.

  Tabla 5 Descripción del campo networks

  Parámetro	Tipo	Descripción
  id	String	Especifica el ID de subred.
  ipv6_enable	Boolean	Especifica si se admiten direcciones IPv6. Si este parámetro se establece en true, la NIC admite direcciones IPv6. El valor predeterminado es false.This parameter is reserved.
  ipv6_bandwidth	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 compartido IPv6 enlazado.This parameter is reserved.
  allowed_address_pairs	Array of allowed_address_pairs objects	Especifica si se permite al sistema comprobar las direcciones de origen y destino.

  Tabla 6 Descripción del campo ipv6_bandwidth

  Parámetro	Tipo	Descripción
  id	String	Especifica el ID del ancho de banda compartido de una dirección IPv6.This parameter is reserved.

  Tabla 7 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 8 Descripción del campo security_groups

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

• Ejemplo de la respuesta

  {
      "limit": 20,
      "scaling_groups": [
          {
              "networks": [
                  {
                      "id": "a8327883-6b07-4497-9c61-68d03ee193a",
                      "ipv6_enable": true,
                      "ipv6_bandwidth": 
                          {
                              "id": "076ee2ff-f23e-4338-b8ac-1bc7278532d5"
                          }
                  }
              ],
              "available_zones": [
                     "XXXa",
                     "XXXb"
              ],
              "detail": null,
              "scaling_group_name": "as-group-test",
              "scaling_group_id": "77a7a397-7d2f-4e79-9da9-6a35e2709150",
              "scaling_group_status": "INSERVICE",
              "scaling_configuration_id": "1d281494-6085-4579-b817-c1f813be835f",
              "scaling_configuration_name": "healthCheck",
              "current_instance_number": 0,
              "desire_instance_number": 1,
              "min_instance_number": 0,
              "max_instance_number": 500,
              "cool_down_time": 300,
              "lb_listener_id": "f06c0112570743b51c0e8fbe1f235bab",
              "security_groups": [
                  {
                      "id": "8a4b1d5b-0054-419f-84b1-5c8a59ebc829"
                  }
              ],
              "create_time": "2015-07-23T02:46:29Z",
              "vpc_id": "863ccae2-ee85-4d27-bc5b-3ba2a198a9e2",
              "health_periodic_audit_method": "ELB_AUDIT",
              "health_periodic_audit_time": 5,
              "health_periodic_audit_grace_period": 600,
              "instance_terminate_policy": "OLD_CONFIG_OLD_INSTANCE",
              "is_scaling": false,
              "delete_publicip": false
             "enterprise_project_id": "c92b1a5d-6f20-43f2-b1b7-7ce35e58e413",
              "multi_az_priority_policy": "PICK_FIRST"
              "iam_agency_name":"test"
  
          }
      ],
      "total_number": 1,
      "start_number": 0
  }

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