Consulta de grupos de AS
Função
Essa API é usada para listar grupos de AS com base em critérios de pesquisa. Os resultados são exibidos por página.
- Os critérios de pesquisa podem ser o nome do grupo de AS, o ID da configuração de AS, o status do grupo de AS, o ID do projeto empresarial, 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 grupos de AS podem ser listados por padrão.
URI
GET /autoscaling-api/v1/{project_id}/scaling_group
Você pode digitar o ponto de interrogação (?) e o e comercial (&) no final do URI para definir vários critérios de pesquisa. Os grupos de AS podem ser pesquisados por todos os parâmetros opcionais na tabela a seguir. Para obter detalhes, consulte a solicitação de exemplo.
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
project_id |
Sim |
String |
Especifica o ID do projeto. |
scaling_group_name |
Não |
String |
Especifica o nome do grupo de AS. Pesquisa difusa é suportada. |
scaling_configuration_id |
Não |
String |
Especifica o ID de configuração do AS, que pode ser obtido usando a API para listar as configurações do AS. Para mais detalhes, consulte Consulta das configurações do AS. |
scaling_group_status |
Não |
String |
Especifica o status do grupo de AS. As opções são as seguintes:
|
start_number |
Não |
Integer |
Especifica o número da linha inicial. O valor padrão é 0. O valor mínimo é 0 e não há limite para o valor máximo. |
limit |
Não |
Integer |
Especifica o número de registros de consulta. O valor padrão é 20. O valor varia de 0 a 100. |
enterprise_project_id |
Não |
String |
Especifica o ID do projeto empresarial. Se all_granted_eps for especificado, os grupos de AS em todos os projetos empresariais para os quais você tem permissões serão listados..
NOTA:
Uma conta da Huawei Cloud e seus usuários do IAM atribuídos com permissões globais podem visualizar todos os grupos de AS na conta. Se um usuário do IAM for atribuído com permissões para mais 100 projetos empresariais, o usuário só poderá exibir os grupos de AS nos primeiros 100 projetos empresariais. |
Mensagem de solicitação
- Parâmetros de solicitação
- Exemplo de solicitação
Este exemplo mostra como consultar grupos de AS com o nome as-group-test e o ID de configuração de 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
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 inicial de registros de consulta.
limit
Integer
Especifica o número de registros de consulta.
scaling_groups
Array of scaling_groups objects
Especifica a lista do grupo do AS.
Tabela 3 Descrição do campo scaling_groups Parâmetro
Tipo
Descrição
scaling_group_name
String
Especifica o nome do grupo de AS.
scaling_group_id
String
Especifica o ID do grupo de AS.
scaling_group_status
String
Especifica o status do grupo de AS.
scaling_configuration_id
String
Especifica o ID de configuração de AS.
scaling_configuration_name
String
Especifica o nome da configuração de AS.
current_instance_number
Integer
Especifica o número de instâncias atuais no grupo de AS.
desire_instance_number
Integer
Especifica o número esperado de instâncias no grupo de AS.
min_instance_number
Integer
Especifica o número mínimo de instâncias no grupo de AS.
max_instance_number
Integer
Especifica o número máximo de instâncias no grupo de AS.
cool_down_time
Integer
Especifica o(s) período(s) de resfriamento.
lb_listener_id
String
Especifica o ID de um ouvinte do ELB típico. IDs de ouvinte do ELB são separados usando uma vírgula (,).
lbaas_listeners
Array of lbaas_listeners objects
Especifica balanceadores de carga avançados. Para mais detalhes, consulte Tabela 4.
available_zones
Array of strings
Especifica as informações de AZ.
networks
Array of networks objects
Especifica as informações da rede. Para mais detalhes, consulte Tabela 5.
security_groups
Array of security_groups objects
Especifica as informações do grupo de segurança. Para mais detalhes, consulte Tabela 8.
create_time
String
Especifica a hora em que um grupo de AS foi criado. O formato de tempo está em conformidade com o UTC.
vpc_id
String
Especifica o ID da VPC à qual o grupo de AS pertence.
detail
String
Especifica detalhes sobre o grupo de AS. Se uma ação de dimensionamento falhar, esse parâmetro será usado para registrar erros.
is_scaling
Boolean
Especifica o sinalizador de dimensionamento do grupo de AS.
health_periodic_audit_method
String
Especifica o método de verificação de integridade.
health_periodic_audit_time
Integer
Especifica o intervalo de verificação de integridade.
health_periodic_audit_grace_period
Integer
Especifica o período de carência para a verificação de integridade.
instance_terminate_policy
String
Especifica a política de remoção de instância.
notifications
Array of strings
Especifica o modo de notificação.
EMAIL refere-se a notificação por e-mail.
Este modo de notificação foi cancelado. É aconselhável configurar a função de notificação para o grupo de AS. Para mais detalhes, consulte Notificações.
delete_publicip
Boolean
Especifica se o EIP vinculado ao ECS deve ser excluído ao excluir o ECS.
delete_volume
Boolean
Especifica se devem ser excluídos os discos de dados anexados a um ECS ao excluir o ECS.
cloud_location_id
String
Este parâmetro é reservado.
enterprise_project_id
String
Especifica o ID do projeto empresarial.
activity_type
String
Especifica o tipo da ação do AS.
multi_az_priority_policy
String
Especifica a política de prioridade usada para selecionar AZs de destino ao ajustar o número de instâncias em um grupo de AS.
description
String
Especifica a descrição do grupo de AS.
iam_agency_name
String
Especifica o nome da agência.
Tabela 4 Descrição do campo lbaas_listeners Parâmetro
Tipo
Descrição
listener_id
String
Especifica o ID do ouvinte.
pool_id
String
Especifica o ID do grupo de ECS de back-end.
protocol_port
Integer
Especifica o ID do protocolo de back-end, que é a porta na qual um ECS de back-end escuta o tráfego.
weight
Integer
Especifica o peso, que determina a parte das solicitações que um ECS de back-end processa ao ser comparado a outros ECSs de back-end adicionados ao mesmo ouvinte.
Tabela 5 Descrição do campo networks Parâmetro
Tipo
Descrição
id
String
Especifica o ID da sub-rede.
ipv6_enable
Boolean
Especifica se deve ser compatível com endereços IPv6. Se esse parâmetro for definido como true, a NIC oferecerá suporte a endereços IPv6. O valor padrão é false.
ipv6_bandwidth
ipv6_bandwidth object
Especifica a largura de banda compartilhada de um endereço IPv6. Este parâmetro é deixado em branco por padrão, indicando que nenhuma largura de banda IPv6 compartilhada está vinculada.
allowed_address_pairs
Array of allowed_address_pairs objects
Especifica se deve permitir que o sistema verifique os endereços de origem e de destino.
Tabela 6 Descrição do campo ipv6_bandwidth Parâmetro
Tipo
Descrição
id
String
Especifica o ID da largura de banda compartilhada de um endereço IPv6.
Tabela 7 Descrição do campo allowed_address_pairs Parâmetro
Tipo
Descrição
ip_address
String
Especifica se deve permitir que o sistema verifique os endereços de origem e de destino.
Essa função está ativada por padrão. Este parâmetro não pode ser deixado vazio.
- Para desativar esta função, defina o valor para 1.1.1.1/0.
- Para ativar esta função, defina um valor diferente de 1.1.1.1/0.
- Exemplo de resposta
{ "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 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.