Consulta de uma política de AS
Função
Esta API é usada para consultar detalhes sobre uma política de AS especificada por ID de política.
URI
GET /autoscaling-api/v1/{project_id}/scaling_policy/{scaling_policy_id}
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
project_id |
Sim |
String |
Especifica o ID do projeto. |
scaling_policy_id |
Sim |
String |
Especifica o ID da política de AS. |
Mensagem de solicitação
Mensagem de resposta
- Parâmetros de resposta
Tabela 2 Parâmetros de resposta Parâmetro
Tipo
Descrição
scaling_policy
scaling_policy object
Especifica detalhes sobre a política de AS. Para mais detalhes, consulte Tabela 3.
Tabela 3 Descrição do campo scaling_policy Parâmetro
Tipo
Descrição
scaling_group_id
String
Especifica o ID do grupo de AS.
scaling_policy_name
String
Especifica o nome da política de AS.
Suporta pesquisa difusa.
scaling_policy_id
String
Especifica o ID da política de AS.
policy_status
String
Especifica o status da política de AS.
- INSERVICE: a política de AS está ativada.
- PAUSED: a política de AS está desativada.
- EXECUTING: a política de AS está sendo executada.
scaling_policy_type
String
Especifica o tipo de política de AS.
- ALARM: indica que a ação de dimensionamento é acionada por um alarme. Um valor é retornado para alarm_id e nenhum valor é retornado para scheduled_policy.
- SCHEDULED: indica que a ação de dimensionamento é acionada conforme programado. Um valor é retornado para a scheduled_policy e nenhum valor é retornado para alarm_id, recurrence_type, recurrence_value, start_time ou end_time.
- RECURRENCE: indica que a ação de dimensionamento é acionada periodicamente. Os valores são retornados para scheduled_policy, recurrence_type, recurrence_value, start_time e end_time, e nenhum valor é retornado para alarm_id.
alarm_id
String
Especifica o ID do alarme.
scheduled_policy
scheduled_policy object
Especifica a política de AS periódica ou agendada. Para mais detalhes, consulte Tabela 4.
scaling_policy_action
scaling_policy_action object
Especifica a ação de dimensionamento da política de AS. Para mais detalhes, consulte Tabela 5.
cool_down_time
Integer
Especifica o(s) período(s) de resfriamento.
create_time
String
Especifica a hora em que uma política de AS foi criada. O formato de tempo está em conformidade com o UTC.
Tabela 4 Descrição do campo scheduled_policy Parâmetro
Tipo
Descrição
launch_time
String
Especifica a hora em que a ação de dimensionamento é acionada. O formato de tempo está em conformidade com o UTC.
- Se scaling_policy_type estiver definido como SCHEDULED, o formato de hora será YYYY-MM-DDThh:mmZ.
- Se scaling_policy_type for definido como RECURRENCE, o formato de hora será hh:mm.
recurrence_type
String
Especifica o tipo de uma ação de dimensionamento acionada periodicamente.
- Daily: indica que a ação de dimensionamento é acionada uma vez por dia.
- Weekly: indica que a ação de dimensionamento é acionada uma vez por semana.
- Monthly: indica que a ação de dimensionamento é acionada uma vez por mês.
recurrence_value
String
Especifica a frequência na qual as ações de dimensionamento são acionadas.
- Se recurrence_type estiver definido como Daily, o valor será null, indicando que a ação de dimensionamento é acionada uma vez por dia.
- Se recurrence_type for definido como Weekly, o valor varia de 1 (domingo) a 7 (sábado). Os dígitos referem-se a datas em cada semana e separados por uma vírgula, como 1,3,5.
- Se recurrence_type for definido como Monthly, o valor varia de 1 a 31. Os dígitos referem-se às datas em cada mês e separados por uma vírgula, como 1,10,13,28.
start_time
String
Especifica a hora de início da ação de dimensionamento acionada periodicamente. O formato de tempo está em conformidade com o UTC.
O formato da hora é YYYY-MM-DDThh:mmZ.
end_time
String
Especifica a hora de término da ação de dimensionamento acionada periodicamente. O formato de tempo está em conformidade com o UTC.
O formato da hora é YYYY-MM-DDThh:mmZ.
Tabela 5 Descrição do campo scaling_policy_action Parâmetro
Tipo
Descrição
operation
String
Especifica a ação de dimensionamento.
- ADD: adiciona um número especificado de instâncias ao grupo de AS.
- REMOVE: remove o número especificado de instâncias do grupo de AS.
- SET: define o número de instâncias no grupo de AS.
instance_number
Integer
Especifica o número de instâncias a serem operadas.
instance_percentage
Integer
Especifica a porcentagem de instâncias a serem operadas.
- Exemplo de resposta
{ "scaling_policy": { "scaling_policy_id": "fd7d63ce-8f5c-443e-b9a0-bef9386b23b3", "scaling_group_id": "e5d27f5c-dd76-4a61-b4bc-a67c5686719a", "scaling_policy_name": "Scheduled 1", "scaling_policy_type": "SCHEDULED", "scheduled_policy": { "launch_time": "2015-07-24T01:21Z" }, "cool_down_time": 300, "scaling_policy_action": { "operation": "REMOVE", "instance_number": 1 }, "policy_status": "INSERVICE", "create_time": "2015-07-24T01:09:30Z" } }
Valores retornados
- Normal
- Anormal
Valores retornados
Descrição
400 Bad Request
O servidor falhou ao processar a solicitação.
401 Unauthorized
Você deve digitar o nome de usuário e a senha para acessar a página solicitada.
403 Forbidden
Você está proibido de acessar a página solicitada.
404 Not Found
O servidor não conseguiu encontrar a página solicitada.
405 Method Not Allowed
Você não tem permissão para usar o método especificado na solicitação.
406 Not Acceptable
A resposta gerada pelo servidor não poderia ser aceita pelo cliente.
407 Proxy Authentication Required
Você deve usar o servidor proxy para autenticação para que a solicitação possa ser processada.
408 Request Timeout
A solicitação expirou o tempo limite.
409 Conflict
A solicitação não pôde ser processada devido a um conflito.
500 Internal Server Error
Falhou ao concluir a solicitação porque ocorre um erro de serviço interno.
501 Not Implemented
Falhou ao concluir a solicitação porque o servidor não suporta a função solicitada.
502 Bad Gateway
Falhou ao concluir a solicitação porque a solicitação é inválida.
503 Service Unavailable
Falhou ao concluir a solicitação porque o sistema não está disponível.
504 Gateway Timeout
Ocorreu um erro de tempo limite de gateway.
Códigos de erro
Consulte Códigos de erro.