Este conteúdo foi traduzido por máquina para sua conveniência e a Huawei Cloud não pode garantir que o conteúdo foi traduzido com precisão. Para exibir o conteúdo original, use o link no canto superior direito para mudar para a página em inglês.
Central de ajuda/ Auto Scaling/ Referência de API/ APIs/ Políticas do AS/ Consulta de políticas de AS (V2)
Atualizado em 2023-07-04 GMT+08:00

Consulta de políticas de AS (V2)

Função

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

  • Os critérios de pesquisa podem ser o ID do recurso AS, o tipo de recurso de AS, o nome da política de AS, o ID da política de AS, o ID do alarme, o ID do projeto empresarial, o número da linha inicial, o número de registros e o método de classificação.
  • Se nenhum critério de pesquisa for especificado, um máximo de 20 políticas de AS podem ser consultadas para um locatário por padrão.

A política de dimensionamento de largura de banda configurada para um EIP liberado ainda ocupa a cota da política de dimensionamento de largura de banda. A política é visível apenas para a conta da Huawei Cloud e seus usuários do IAM com as permissões globais.

URI

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

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.

Tabela 1 Descrição do parâmetro

Parâmetro

Obrigatório

Tipo

Descrição

project_id

Sim

String

Especifica o ID do projeto.

scaling_resource_id

Não

String

Especifica o ID do recurso de dimensionamento.

scaling_resource_type

Não

String

Especifica o tipo de recurso de dimensionamento.

  • Grupo de AS: SCALING_GROUP
  • Largura de banda: BANDWIDTH

scaling_policy_name

Não

String

Especifica o nome da política de AS.

Suporta pesquisa difusa.

scaling_policy_id

Não

String

Especifica o ID da política de AS.

scaling_policy_type

Não

String

Especifica o tipo de política de AS.

  • ALARM: política de alarme
  • SCHEDULED: política programada
  • RECURRENCE: política periódica
  • INTERVAL_ALARM (correspondente a alarm_id): indica que a ação de dimensionamento é acionada por uma política de dimensionamento refinada.

start_number

Não

Integer

Especifica o número da linha inicial. O valor padrão é 0. O valor mínimo do parâmetro é 0.

limit

Não

Integer

Especifica o número de registros de consulta. O valor padrão é 20. O valor varia de 0 a 100.

sort_by

Não

String

Especifica o método de classificação.

  • POLICY_NAME: as políticas de AS são classificadas por nome.
  • TRIGGER_CONDITION: as políticas de AS são classificadas por condição de disparador. Por exemplo, em ordem crescente, as políticas de alarme são as primeiras e outras são classificadas em ordem crescente com base no horário de disparo mais recente.
  • CREATE_TIME: as políticas de AS são classificadas com base no tempo de criação.

order

Não

String

Especifica a ordem de classificação.

  • ASC: ordem crescente
  • DESC: ordem decrescente

enterprise_project_id

Não

String

Especifica o ID do projeto empresarial.

  • Se scaling_resource_type for definido como SCALING_GROUP e

    all_granted_eps é transferido:

    • Quando você usa uma conta na Huawei Cloud ou seu usuário do IAM com permissões globais, essa API consultará políticas de dimensionamento dos grupos de AS em todos os projetos empresariais.
    • Quando você usa um usuário do IAM com permissões para projetos corporativos específicos, essa API consultará políticas de dimensionamento dos grupos de AS nesses projetos corporativos.
      NOTA:

      Se o usuário do IAM tiver permissões para mais de 100 projetos corporativos, essa API consultará apenas as políticas de AS dos grupos de AS nos primeiros 100 projetos corporativos.

  • Se scaling_resource_type for definido como BANDWIDTH e

    all_granted_eps é transferido:

    • Quando você usa uma conta na Huawei Cloud ou seu usuário do IAM com permissões globais, essa API consultará políticas de dimensionamento das larguras de banda em todos os projetos corporativos.
    • Quando você usa um usuário do IAM com permissões para projetos corporativos específicos, essa API consulta as políticas de dimensionamento de larguras de banda nos projetos corporativos especificados por all_granted_eps.
  • Se scaling_resource_type não for especificado e

    all_granted_eps é transferido:

    • Quando você usa uma conta na Huawei Cloud ou seu usuário do IAM com permissões globais, essa API consultará políticas de dimensionamento dos grupos de AS e larguras de banda em todos os projetos corporativos.
    • Quando você usa um usuário do IAM com permissões para projetos corporativos específicos, esta API consultará as políticas de dimensionamento de grupos de AS e larguras de banda nos projetos corporativos.
      NOTA:

      Se o usuário do IAM tiver permissões para mais de 100 projetos corporativos, essa API só consultará as políticas de dimensionamento de grupos de AS nos primeiros 100 projetos corporativos, bem como as políticas de dimensionamento de larguras de banda nos projetos corporativos especificados por all_granted_eps.

alarm_id

Não

String

Especifica o ID da regra de alarme.

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?scaling_resource_id=8ade64b5-d685-40b8-8582-4ce306ea37a6&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.

    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",
    "meta_data": {
                    "metadata_eip_id": "263f0886-de6a-4e21-ad83-814ca9f3844e",
                    "metadata_eip_address": "255.255.255.255"
                }
            },
            {
                "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",
    "meta_data": {
                    "metadata_eip_id": "263f0886-de6a-4e21-ad83-814ca9f3844e",
                    "metadata_eip_address": "255.255.255.255"
                }
            }
        ]
    }

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.