Consulta de políticas de AS (V2)

Função

Essa API é usada para consultar as políticas do AS com base nos critérios de pesquisa. Os resultados são exibidos por página.

• A diferença entre as APIs V2 e V1 para consultar as políticas do AS é que a V2 contém tipos de recursos de dimensionamento nas mensagens de resposta.
• Os critérios de pesquisa podem ser o nome da política de AS, o tipo de política, o ID da política, o número da linha inicial e o número de registros.
• Se nenhum critério de pesquisa for especificado, um máximo de 20 políticas de AS para recursos especificados poderá ser consultado para um locatário por padrão.

URI

GET /autoscaling-api/v2/{project_id}/scaling_policy/{scaling_resource_id}/list

Você pode digitar o ponto de interrogação (?) e o e comercial (&) no final do URI para definir vários critérios de pesquisa. As políticas do AS podem ser pesquisadas por todos os parâmetros opcionais na tabela a seguir. Para obter detalhes, consulte a solicitação de exemplo.

Mensagem de solicitação

• Parâmetros de solicitação

  Nenhum

• Exemplo de solicitação
  Este exemplo mostra como consultar todas as políticas de AS periódicas para recursos com ID 8ade64b5-d685-40b8-8582-4ce306ea37a6.

  GET https://{Endpoint}/autoscaling-api/v2/{project_id}/scaling_policy/8ade64b5-d685-40b8-8582-4ce306ea37a6/list?scaling_policy_type=RECURRENCE

Mensagem de resposta

• Parâmetros de resposta

  Tabela 2 Parâmetros de resposta

  Parâmetro	Tipo	Descrição
  total_number	Integer	Especifica o número total de registros de consulta.
  start_number	Integer	Especifica o número da linha inicial.
  limit	Integer	Especifica o número máximo de recursos a serem consultados.
  scaling_policies	Array of scaling_policies objects	Especifica as políticas de AS. Para mais detalhes, consulte Tabela 3.

  Tabela 3 Descrição do campo scaling_policies

  Parâmetro	Tipo	Descrição
  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.
  scaling_resource_id	String	Especifica o ID do recurso de dimensionamento.
  scaling_resource_type	String	Especifica o tipo de recurso de dimensionamento. Grupo de AS: SCALING_GROUP Largura de banda: BANDWIDTH
  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. INTERVAL_ALARM: indica que a ação de dimensionamento é acionada por uma política de dimensionamento refinada. Um valor é retornado para alarm_id e nenhum valor é retornado para scheduled_policy.
  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.
  interval_alarm_actions	Array of interval_alarm_actions objects	Especifica a ação de dimensionamento aplicada quando scaling_policy_type é definida como INTERVAL_ALARM. Para mais detalhes, consulte Tabela 6.
  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.
  meta_data	meta_data object	Fornece informações adicionais. Para mais detalhes, consulte Tabela 7.
  description	String	Especifica a descrição da política de AS.

  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: indica a adição de instâncias. REDUCE: indica instâncias de redução. SET: indica definir o número de instâncias para um valor especificado.
  size	Integer	Especifica o número de instâncias a serem operadas.
  percentage	Integer	Especifica a porcentagem de instâncias a serem operadas.
  limits	Integer	Especifica as restrições de operação.

  Tabela 6 Descrição do campo interval_alarm_actions

  Parâmetro	Obrigatório	Tipo	Descrição
  lower_bound	Não	Double	Especifica o limite inferior do intervalo de valores.
  upper_bound	Não	Double	Especifica o limite superior do intervalo de valores.
  operation	Não	String	Especifica a operação a ser executada. ADD: indica a adição de instâncias. REDUCE: indica instâncias de redução. SET: indica definir o número de instâncias para um valor especificado.
  size	Não	Integer	Especifica o tamanho da operação.
  percentage	Não	Integer	Especifica a porcentagem de instâncias a serem operadas.
  limits	Não	Integer	Especifica as restrições de operação.

  Tabela 7 Descrição do campo meta_data

  Parâmetro	Tipo	Descrição
  metadata_bandwidth_share_type	String	Especifica o tipo de compartilhamento de largura de banda na política de dimensionamento de largura de banda.
  metadata_eip_id	String	Especifica o ID de EIP para a largura de banda na política de dimensionamento de largura de banda.
  metadata_eip_address	String	Especifica o EIP para a largura de banda na política de dimensionamento de largura de banda.

• Exemplo de resposta

  {
      "limit": 20,
      "total_number": 3,
      "start_number": 0,
      "scaling_policies": [
          {
              "scaling_policy_id": "803a35a5-38fb-4d27-a042-496c14bc1fb8",
              "scaling_policy_name": "as-policy-7a75",
              "scaling_resource_id": "8ade64b5-d685-40b8-8582-4ce306ea37a6",
              "scaling_resource_type": "SCALING_GROUP",
              "scaling_policy_type": "RECURRENCE",
              "scheduled_policy": {
                  "launch_time": "03:30",
                  "recurrence_type": "Daily",
                  "start_time": "2017-08-28T03:08Z",
                  "end_time": "2017-09-01T03:08Z"
              },
              "cool_down_time": 900,
              "scaling_policy_action": {
                  "operation": "ADD",
                  "size": 1
              },
              "policy_status": "INSERVICE",
              "create_time": "2017-08-31T03:02:41Z"
          },
          {
              "scaling_policy_id": "535fd67e-276b-409c-879e-52f4e09e14bb",
              "scaling_policy_name": "as-policy-7a75",
              "scaling_resource_id": "8ade64b5-d685-40b8-8582-4ce306ea37a6",
              "scaling_resource_type": "SCALING_GROUP",
              "scaling_policy_type": "RECURRENCE",
              "scheduled_policy": {
                  "launch_time": "21:30",
                  "recurrence_type": "Daily",
                  "start_time": "2017-08-27T21:08Z",
                  "end_time": "2017-08-31T21:08Z"
              },
              "cool_down_time": 900,
              "scaling_policy_action": {
                  "operation": "ADD",
                  "size": 1
              },
              "policy_status": "INSERVICE",
              "create_time": "2017-08-31T07:35:05Z"
          },
          {
              "scaling_policy_id": "37df92f8-73cb-469e-a420-c15f445d2ee1",
              "scaling_policy_name": "as-policy-7a75",
              "scaling_resource_id": "8ade64b5-d685-40b8-8582-4ce306ea37a6",
              "scaling_resource_type": "SCALING_GROUP",
              "scaling_policy_type": "RECURRENCE",
              "scheduled_policy": {
                  "launch_time": "22:30",
                  "recurrence_type": "Daily",
                  "start_time": "2017-08-27T22:08Z",
                  "end_time": "2017-08-31T22:08Z"
              },
              "cool_down_time": 900,
              "scaling_policy_action": {
                  "operation": "ADD",
                  "size": 1
              },
              "policy_status": "INSERVICE",
              "create_time": "2017-08-31T07:41:06Z"
          }
      ]
  }

Valores retornados

• Normal

  200

• 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.