Consulta de una política AS (V2)
Función
Esta API se utiliza para consultar detalles sobre una política AS especificada por ID de política.
La diferencia entre las API V2 y V1 para consultar detalles de una política AS es que V2 contiene tipos de recursos de ajuste en mensajes de respuesta.
URI
GET /autoscaling-api/v2/{project_id}/scaling_policy/{scaling_policy_id}
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
project_id |
Yes |
String |
Specifies the project ID. |
scaling_policy_id |
Yes |
String |
Specifies the AS policy ID. |
Request Message
Response Message
- Response parameters
Tabla 2 Response parameters Parámetro
Tipo
Descripción
scaling_policy
scaling_policy object
Especifica detalles sobre la política AS. Para más detalles, consulte Tabla 3.
Tabla 3 Descripción del campo scaling_policy Parámetro
Tipo
Descripción
scaling_resource_id
String
Especifica el ID del recurso de ajuste.
scaling_resource_type
String
Especifica el tipo de recurso de ajuste.
- Grupo de AS: SCALING_GROUP
- Ancho de banda: BANDWIDTH
scaling_policy_name
String
Especifica el nombre de política AS.
Soporta búsqueda difusa.
scaling_policy_id
String
Especifica el ID de política AS.
policy_status
String
Especifica el estado de la política AS.
- INSERVICE: La política AS está habilitada.
- PAUSED: La política AS está deshabilitada.
- EXECUTING: Se está ejecutando la política AS.
scaling_policy_type
String
Especifica el tipo de política AS.
- ALARM: indica que la acción de ajuste se activa mediante una alarma. Se devuelve un valor para alarm_id y no se devuelve ningún valor para scheduled_policy.
- SCHEDULED: indica que la acción de ajuste se activa según lo programado. Se devuelve un valor para scheduled_policy y no se devuelve ningún valor para alarm_id, recurrence_type, recurrence_value, start_time, o end_time.
- RECURRENCE: indica que la acción de ajuste se activa periódicamente. Los valores se devuelven para scheduled_policy, recurrence_type, recurrence_value, start_time, y end_time, y no se devuelve ningún valor para alarm_id.
- INTERVAL_ALARM: indica que la acción de ajuste se desencadena mediante una política de ajuste refinada. Se devuelve un valor para alarm_id y no se devuelve ningún valor para scheduled_policy.
alarm_id
String
Especifica el ID de alarma.
scheduled_policy
scheduled_policy object
Especifica la política AS periódica o programada. Para más detalles, consulte Tabla 4.
scaling_policy_action
scaling_policy_action object
Especifica la acción de ajuste de la política AS. Para más detalles, consulte Tabla 5.
interval_alarm_actions
Array of interval_alarm_actions objects
Especifica la acción de escala aplicada cuando se establece scaling_policy_type en INTERVAL_ALARM. Para más detalles, consulte Tabla 6
cool_down_time
Integer
Especifica el período o los períodos de enfriamiento.
create_time
String
Especifica la hora en que se creó una política AS. El formato de tiempo cumple con UTC.
meta_data
meta_data object
Proporciona información adicional. Para más detalles, consulte Tabla 7.
description
String
Especifica la descripción de la política AS.
Tabla 4 Descripción del campo scheduled_policy Parámetro
Tipo
Descripción
launch_time
String
Especifica la hora a la que se activa la acción de ajuste. El formato de tiempo cumple con UTC.
- Si el valor scaling_policy_type es SCHEDULED, el formato de tiempo es YYYY-MM-DDThh:mmZ.
- Si se establece scaling_policy_type a RECURRENCE, el formato de hora es hh:mm.
recurrence_type
String
Especifica el tipo de una acción de ajuste desencadenada periódicamente.
- Daily: indica que la acción de ajuste se activa una vez al día.
- Weekly: indica que la acción de ajuste se activa una vez a la semana.
- Monthly: indica que la acción de ajuste se activa una vez al mes.
recurrence_value
String
Especifica la frecuencia con la que se activan las acciones de ajuste.
- Si recurrence_type se establece en Diario, el valor es null, lo que indica que la acción de ajuste se activa una vez al día.
- Si recurrence_type se establece en Weekly, el valor oscila entre 1 (domingo) y 7 (sábado). Los dígitos se refieren a las fechas de cada semana y separados por una coma, como 1,3,5.
- Si recurrence_type se establece en Monthly, el valor varía de 1 a 31. Los dígitos se refieren a las fechas de cada mes y separados por una coma, como 1,10,13,28.
start_time
String
Especifica la hora de inicio de la acción de escala que se activa periódicamente. El formato de tiempo cumple con UTC.
El formato de hora es YYYY-MM-DDThh:mmZ.
end_time
String
Especifica la hora de finalización de la acción de escala que se activa periódicamente. El formato de tiempo cumple con UTC.
El formato de hora es YYYY-MM-DDThh:mmZ.
Tabla 5 Descripción del campo scaling_policy_action Parámetro
Tipo
Descripción
operation
String
Especifica la acción de ajuste.
- ADD: indica la adición de instancias.
- REDUCE: indica la reducción de instancias.
- SET: indica establecer el número de instancias en un valor especificado.
size
Integer
Especifica el tamaño de la operación.
percentage
Integer
Especifica el porcentaje de instancias que se van a operar.
limits
Integer
Especifica las restricciones de operación.
Tabla 6 Descripción del campo interval_alarm_actions Parámetro
Obligatorio
Tipo
Descripción
lower_bound
No
Double
Especifica el límite inferior del rango de valores.
upper_bound
No
Double
Especifica el límite superior del rango de valores.
operation
No
String
Especifica la operación que se va a realizar.- ADD: indica la adición de instancias.
- REDUCE: indica la reducción de instancias.
- SET: indica establecer el número de instancias en un valor especificado.
size
No
Integer
Especifica el tamaño de la operación.
percentage
No
Integer
Especifica el porcentaje de instancias que se van a operar.
limits
No
Integer
Especifica las restricciones de operación.
Tabla 7 Descripción del campo meta_data Parámetro
Tipo
Descripción
metadata_bandwidth_share_type
String
Especifica el tipo de uso compartido de ancho de banda en la política de escala de ancho de banda.
metadata_eip_id
String
Especifica el ID de EIP para el ancho de banda en la política de escala de ancho de banda.
metadata_eip_address
String
Especifica el EIP para el ancho de banda en la política de escala de ancho de banda.
- Ejemplo de la respuesta
{ "scaling_policy": { "scaling_policy_id": "906f73ff-56e8-41b2-a005-8157d0c60361", "scaling_policy_name": "hth_aspolicy_1", "scaling_resource_id": "8ade64b5-d685-40b8-8582-4ce306ea37a6", "scaling_resource_type": "BANDWIDTH", "scaling_policy_type": "ALARM", "alarm_id": "al1513822380493GvlJKZwA8", "scheduled_policy": { }, "cool_down_time": 900, "scaling_policy_action": { "operation": "ADD", "size": 1, "limits": 111 }, "policy_status": "INSERVICE", "create_time": "2018-03-21T08:03:35Z", "meta_data": { "metadata_eip_id": "263f0886-de6a-4e21-ad83-814ca9f3844e", "metadata_eip_address": "255.255.255.255" } } }
Valores devueltos
- Normal.
- 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