Padrões de API e SDKs predefinidos multilíngues
A OpenAPI deste produto (Ess/2014-08-28) utiliza o estilo de assinatura RPC. Encapsulamos SDKs para linguagens de programação comuns para desenvolvedores. Os desenvolvedores podem baixar o SDK para chamar diretamente a OpenAPI deste produto sem se preocupar com detalhes técnicos. Se o SDK existente não atender às suas necessidades, você pode usar o mecanismo de assinatura para integração com assinatura própria. Como os detalhes da autoassinatura são muito complexos, isso pode levar cerca de 5 dias úteis. Portanto, recomendamos ingressar em nosso grupo de serviço DingTalk (147535001692) e realizar a integração de assinatura sob orientação especializada.
Antes de usar a API, você precisa preparar sua conta de identidade e chave de acesso (AccessKey) para acessar efetivamente a API por meio de ferramentas cliente (SDK, CLI, etc.). Para obter detalhes, consulte Obter um AccessKey.
Cenários de assinatura personalizada
Se o seu cenário de negócios tiver requisitos especiais e você precisar integrar a API por meio de autoassinatura, recomendamos consultar primeiro nossa equipe de suporte técnico (grupo de serviço DingTalk: 147535001692) para obter orientação profissional e garantir uma integração eficiente.
Preparação de conta e segurança
As contas da Alibaba Cloud têm permissões administrativas completas sobre todos os recursos. Quando um AccessKey é comprometido, todos os recursos associados estarão em risco de acesso não autorizado. Para garantir a segurança, recomenda-se criar um usuário RAM com apenas permissões de acesso à API e configurar seu AccessKey, além de configurar políticas RAM com base no princípio do menor privilégio (PoLP). Use a conta da Alibaba Cloud apenas em cenários específicos em que as permissões da conta da Alibaba Cloud sejam explicitamente necessárias.
Grupo de dimensionamento
|
API |
Título |
Descrição |
| CreateScalingGroup | Criar um grupo de escalonamento. | Cria um grupo de escalonamento para ajustar automaticamente a capacidade de computação (o número de instâncias) com base nas mudanças de negócios e políticas, caso você precise aumentar ou diminuir automaticamente o número de instâncias de um tipo especificado. |
| DeleteScalingGroup | Excluir um grupo de escalonamento. | Exclui um grupo de escalonamento. |
| ModifyScalingGroup | Modifica um grupo de escalonamento. | Se você precisar aumentar ou diminuir automaticamente o número de instâncias de um tipo específico com base em mudanças de negócios e políticas, poderá configurar um grupo de escalonamento para ajustar automaticamente sua capacidade de computação (ou seja, o número de instâncias). Se os atributos atuais do grupo de escalonamento não atenderem mais aos seus requisitos de negócios, você pode chamar a operação ModifyScalingGroup para modificar atributos do grupo de escalonamento, como o número máximo de instâncias, o número mínimo de instâncias ou o número esperado de instâncias. Dessa forma, você não precisa criar um grupo de escalonamento novamente ou reconfigurar atributos relacionados, o que economiza tempo e recursos. |
| EnableScalingGroup | Ativar um grupo de escalonamento. | Ativa um grupo de escalonamento. |
| DisableScalingGroup | Desativar um grupo de escalonamento. | Desativa um grupo de escalonamento. |
| SetGroupDeletionProtection | Ativar ou desativar a proteção contra exclusão para um grupo de escalonamento. | Ativa ou desativa a proteção contra exclusão para um grupo de escalonamento. |
| AttachLoadBalancers | Adicionar uma ou mais instâncias de load balancer | Adiciona uma ou mais instâncias de load balancer. |
| DetachLoadBalancers | Remoção de uma ou mais instâncias de load balancer | Remove uma ou mais instâncias de load balancer. |
| DetachDBInstances | Remove uma ou mais instâncias RDS. | Remove uma ou mais instâncias do ApsaraDB RDS. |
| AttachDBInstances | Adicionar uma ou mais instâncias do ApsaraDB RDS | Adiciona uma ou mais instâncias do ApsaraDB RDS a um grupo de escalonamento. |
| AttachVServerGroups | Adicionar grupos de servidores virtuais a um grupo de escalonamento. | Adiciona um ou mais grupos de servidores virtuais a uma instância de load balancer associada a um grupo de escalonamento. |
| DetachVServerGroups | Remover um ou mais grupos de servidores virtuais. | Remove um ou mais grupos de servidores virtuais. |
| DescribeScalingGroups | Consulta de grupos de escalonamento. | Consulta grupos de escalonamento. Você pode chamar esta operação para visualizar informações básicas sobre grupos de escalonamento, instâncias em grupos de escalonamento e configurações de escalonamento. |
| DescribeScalingInstances | Consulta de instâncias ECS em um grupo de escalonamento. | Consulta a lista de instâncias ECS em um grupo de escalonamento e as informações das instâncias pelo ID do grupo de escalonamento, incluindo o número total de instâncias spot em execução, o número total de instâncias ECS, o estado de aquecimento das instâncias ECS e o estado do ciclo de vida no grupo de escalonamento atual. Você também pode filtrar instâncias ECS por status de verificação de integridade, estado do ciclo de vida ou tipo de criação. |
| DescribeScalingActivities | Consulta de atividades de escalonamento. | Consulta os detalhes das atividades de escalonamento chamando a operação DescribeScalingActivities. Você pode usar esta operação para visualizar os resultados das atividades de escalonamento acionadas por tarefas agendadas, tarefas acionadas por eventos ou execução manual de regras de escalonamento. Por exemplo, você pode visualizar o status, a causa e o número total de instâncias após a execução de uma atividade de escalonamento. |
| DescribeScalingActivityDetail | Consulta dos detalhes de uma atividade de escalonamento. | Consulta os detalhes de uma atividade de escalonamento. |
| DescribeLimitation | Consulta de limites de cota de recursos. | Consulta os limites de cota de recursos. |
| DescribeElasticStrength | Consultar a força elástica de um grupo de escalabilidade. | A validade da configuração de um grupo de escalabilidade determina em grande parte a taxa de sucesso das operações de expansão. O Auto Scaling utiliza a força elástica para descrever a validade das configurações de escalabilidade, quantificando a qualidade da configuração e ajudando você a otimizar as configurações de escalabilidade adequadamente. |
| VerifyAuthentication | Verifica se o Auto Scaling está autorizado a operar recursos ECS | Verifica se o Auto Scaling está autorizado a operar recursos ECS. |
| SuspendProcesses | Suspensão de processos de escalabilidade especificados em um grupo de escalabilidade. | Suspende os processos de escalabilidade especificados em um grupo de escalabilidade. |
| ResumeProcesses | Retomada dos processos de dimensionamento pausados em um grupo de dimensionamento. | Retoma os processos de dimensionamento pausados em um grupo de dimensionamento. |
| VerifyUser | Verificar se o Auto Scaling está ativado. | Verifica se o Auto Scaling está ativado. |
Configuração de dimensionamento
|
API |
Título |
Descrição |
| CreateScalingConfiguration | Criar uma configuração de escalonamento. | Cria uma configuração de dimensionamento do tipo ECS para um grupo de dimensionamento chamando a operação CreateScalingConfiguration com o ID do grupo de dimensionamento, o tipo de instância, a imagem da instância e outras informações. |
| DeleteScalingConfiguration | Excluir uma configuração de dimensionamento. | Exclui uma configuração de dimensionamento. |
| ModifyScalingConfiguration | Modifica uma configuração de dimensionamento do tipo ECS. | Modifica uma configuração de dimensionamento do tipo ECS (o tipo de instância ECS para scale-out) caso a configuração de dimensionamento atual não atenda aos seus requisitos de negócios. Você pode invocar esta operação de API para modificar a configuração de dimensionamento. |
| DescribeScalingConfigurations | Consulta configurações de escalonamento do tipo ECS. | Consulta informações sobre configurações de escalonamento do tipo ECS, incluindo tipos de instância e imagens, para ajudar você a entender antecipadamente os detalhes dos modelos de instância ECS usados para scale-out. |
| DeactivateScalingConfiguration | Invalidar uma configuração de dimensionamento especificada | Invalida uma configuração de dimensionamento especificada. |
Regra de dimensionamento
|
API |
Título |
Descrição |
| CreateScalingRule | Criar uma regra de escalonamento. | Cria uma regra de escalonamento. |
| DeleteScalingRule | Excluir uma regra de escalonamento | Exclui uma regra de escalonamento. |
| ModifyScalingRule | Modifica uma regra de escalonamento | Modifica um ou mais atributos de uma regra de escalonamento. Se uma regra de escalonamento existente não atender mais aos seus requisitos, você pode chamar esta operação para modificar seus atributos em vez de criar uma nova. Isso evita repetições desnecessárias e economiza tempo e recursos. |
| DescribeScalingRules | Consultar regras de escalabilidade. | Consulta as regras de escalabilidade em um grupo de escalabilidade e retorna informações sobre as regras de escalabilidade. |
Tarefa acionada por evento
|
API |
Título |
Descrição |
| AttachInstances | Adicionar manualmente instâncias ECS a um grupo de escalonamento | Adiciona manualmente instâncias ECS a um grupo de escalonamento. |
| DetachInstances | Remoção de uma ou mais instâncias ECS de um grupo de escalonamento. | Remove uma ou mais instâncias ECS de um grupo de escalonamento. |
| ExecuteScalingRule | Executar uma regra de escalonamento | Executa uma regra de escalonamento. |
| RemoveInstances | RemoveInstances | Se o grupo de escalabilidade atual estiver no estado habilitado e nenhuma atividade de escalabilidade estiver no estado de execução no grupo de escalabilidade, você pode invocar a operação de API RemoveInstances para excluir uma ou mais instâncias desnecessárias de um grupo de escalabilidade. |
Tarefa agendada
|
API |
Título |
Descrição |
| CreateScheduledTask | Criar uma tarefa agendada | Cria uma tarefa agendada. |
| DeleteScheduledTask | Excluir uma tarefa agendada | Exclui uma tarefa agendada. |
| ModifyScheduledTask | Modificar uma tarefa agendada. | Modifica as informações de uma tarefa agendada. |
| DescribeScheduledTasks | Lista de tarefas agendadas | Consulta os detalhes das tarefas agendadas. Uma tarefa agendada é uma tarefa predefinida que executa uma regra de dimensionamento especificada em um horário especificado para dimensionar automaticamente os recursos de computação. Após criar uma tarefa agendada, você pode invocar a operação DescribeScheduledTasks para consultar seus detalhes, como o horário de acionamento, o número total de tarefas agendadas e o ID do grupo de dimensionamento que executa a tarefa agendada. |
Hook de ciclo de vida
|
API |
Título |
Descrição |
| CreateLifecycleHook | Criar um ou mais ganchos de ciclo de vida para um grupo de escalonamento | Cria um ou mais ganchos de ciclo de vida para um grupo de escalonamento. |
| DeleteLifecycleHook | Excluir um hook de ciclo de vida | Exclui um hook de ciclo de vida. |
| ModifyLifecycleHook | Modifica um hook de ciclo de vida | Modifica as informações de um hook de ciclo de vida. |
| DescribeLifecycleActions | Consulta de tokens de ciclo de vida. | Consulta tokens de ciclo de vida por ID e status da atividade de escalonamento. |
| DescribeLifecycleHooks | Consulta os detalhes de hooks de ciclo de vida | Consulta os detalhes de hooks de ciclo de vida especificando IDs de hooks de ciclo de vida ou IDs de grupos de dimensionamento. Os detalhes incluem a próxima ação a ser executada após o término do estado de espera, o tipo de atividade de dimensionamento associado ao hook de ciclo de vida, o identificador do destinatário da notificação e o tempo de espera de suspensão. |
| RecordLifecycleActionHeartbeat | Estende o tempo de espera de uma instância ECS no estado de espera após o acionamento de um hook de ciclo de vida | Estende o tempo de espera de uma instância ECS suspensa após o acionamento de um hook de ciclo de vida. |
| CompleteLifecycleAction | Encerra o estado de espera de uma atividade de escalonamento antecipadamente | Encerra o estado de espera de uma atividade de escalonamento antecipadamente. |
Notificação de evento
|
API |
Título |
Descrição |
| CreateNotificationConfiguration | Criar uma regra de notificação de eventos | As notificações de eventos suportam o envio automático de mensagens para o serviço de monitoramento CloudMonitor, tópicos do MNS e filas do MNS após a ocorrência de tipos especificados de eventos, o que ajuda você a acompanhar a dinâmica do grupo de dimensionamento e implementar ainda mais o gerenciamento automatizado. Se os tipos atuais de notificação de eventos não atenderem mais aos seus requisitos de negócios, você pode invocar a operação de API ModifyNotificationConfiguration para modificar as notificações de eventos e alterações de recursos do Auto Scaling. Você não precisa criar uma nova notificação de evento, mas a modificação do método de notificação de uma notificação de evento não é suportada. |
| DeleteNotificationConfiguration | Excluir uma configuração de notificação para eventos do Auto Scaling e alterações de recursos | Exclui uma configuração de notificação para eventos do Auto Scaling e alterações de recursos. |
| ModifyNotificationConfiguration | Modificação de uma notificação de evento e alteração de recurso do Auto Scaling | Modifica uma notificação de evento e alteração de recurso do Auto Scaling. |
| DescribeNotificationConfigurations | DescribeNotificationConfigurations | Consulta as configurações de notificação para eventos do Auto Scaling e alterações de recursos de um grupo de escalonamento, incluindo tipos de notificação de eventos e métodos de notificação. |
| DescribeNotificationTypes | Consulta dos tipos de eventos do Auto Scaling e notificações de alteração de recursos. | Consulta os tipos de eventos do Auto Scaling e notificações de alteração de recursos. |
Instância
|
API |
Título |
Descrição |
| SetInstancesProtection | Ativação ou desativação da proteção para instâncias ECS em um grupo de escalonamento | Ativa ou desativa a proteção para uma ou mais instâncias ECS em um grupo de escalonamento. |
| SetInstanceHealth | Definir o status de integridade de uma instância ECS em um grupo de escalonamento. | Define o status de integridade de uma instância ECS em um grupo de escalonamento. |
| EnterStandby | Definir instâncias ECS em um grupo de escalabilidade para o estado de standby. | Define instâncias ECS em um grupo de escalabilidade para o estado de standby. |
| ExitStandby | Restaurar instâncias do estado de espera para o estado de execução | Restaura instâncias ECS em um grupo de escalonamento do estado de espera para o estado de execução. |
| RebalanceInstances | Reequilíbrio da distribuição de instâncias ECS | Reequilibra a distribuição de instâncias ECS em um grupo de escalonamento multizona. |
Região
|
API |
Título |
Descrição |
| DescribeRegions | Consulta das regiões onde o Auto Scaling está disponível. | Consulta as regiões onde o Auto Scaling está disponível. |
Tag
|
API |
Título |
Descrição |
| ListTagResources | Consulta de tags associadas a recursos do Auto Scaling. | Consulta as tags associadas a um ou mais recursos do Auto Scaling. |
| ListTagKeys | Lista as chaves de tag dos recursos do Auto Scaling | Consulta as chaves de tag dos recursos do Auto Scaling. |
| ListTagValues | Consulta de valores de tag para uma chave de tag de recurso do Auto Scaling | Consulta os valores de tag correspondentes a uma chave de tag de recursos do Auto Scaling. |
| TagResources | Criar e vincular tags a uma lista de recursos. | Cria e vincula tags a uma lista de recursos do Auto Scaling especificados. |
| UntagResources | Desvincular tags de recursos especificados do Auto Scaling. | Após a desvinculação de uma tag, ela é automaticamente excluída se não estiver vinculada a nenhum outro recurso. |
Alertas
|
API |
Título |
Descrição |
| CreateAlarm | Cria uma tarefa acionada por evento. | Cria uma tarefa acionada por evento. |
| DeleteAlarm | Excluir uma tarefa acionada por evento | Exclui uma tarefa acionada por evento. |
| DisableAlarm | Desativar uma tarefa acionada por evento | Desativa uma tarefa acionada por evento. |
| EnableAlarm | Ativar uma tarefa acionada por evento | Ativa uma tarefa acionada por evento. |
| ModifyAlarm | Modifica uma tarefa acionada por evento. | Modifica uma tarefa acionada por evento. |
| DescribeAlarms | Consulta de tarefas acionadas por eventos | Consulta as informações das tarefas acionadas por eventos. |
Outros
|
API |
Título |
Descrição |
| AttachAlbServerGroups | Adicionar um ou mais grupos de servidores ALB | Adiciona um ou mais grupos de servidores do Application Load Balancer (ALB) a um grupo de escalonamento. |
| CreateEciScalingConfiguration | Criar uma configuração de dimensionamento | Cria uma configuração de dimensionamento de ECI. |
| DeleteEciScalingConfiguration | Excluir uma configuração de dimensionamento | Exclui uma configuração de dimensionamento do ECI. |
| DescribeEciScalingConfigurations | DescribeEciScalingConfigurations | Invoca a operação DescribeEciScalingConfigurations. Você pode especificar parâmetros como o ID do grupo de escalonamento e os IDs ou nomes das configurações de escalonamento para realizar uma consulta de parâmetros sobre as informações de configuração de escalonamento do ECI, como a política de preempção de instâncias, os tipos de instância do grupo de contêineres, as políticas de pull de imagens de contêiner e o peso da instância ECI quando atua como servidor backend. |
| DetachAlbServerGroups | Remove um ou mais grupos de servidores ALB. | Remove um ou mais grupos de servidores do Application Load Balancer (ALB) de um grupo de escalonamento. |
| ModifyEciScalingConfiguration | Modificar uma configuração de dimensionamento | Modifica uma configuração de dimensionamento do tipo ECI. |
| ScaleWithAdjustment | Acionar escalonamento elástico com base em uma regra de ajuste especificada. | Aciona o escalonamento elástico com base em uma regra de ajuste especificada. |
| ChangeResourceGroup | Alteração do grupo de recursos de um grupo de escalonamento | Altera o grupo de recursos de um grupo de escalonamento. |
| AttachServerGroups | Adicionar um ou mais grupos de servidores de balanceamento de carga | Adiciona um ou mais grupos de servidores de balanceamento de carga a um grupo de escalonamento. Os tipos de grupos de servidores suportados incluem Application Load Balancer (ALB) e Network Load Balancer (NLB). |
| DetachServerGroups | Desanexar grupos de servidores | Invoca a API DetachServerGroups para remover um ou mais grupos de servidores de balanceamento de carga de um grupo de escalonamento. Os tipos de grupos de servidores suportados incluem balanceamento de carga Application Load Balancer (ALB), balanceamento de carga Network Load Balancer (NLB) e balanceamento de carga Gateway Load Balancer (GWLB). Esta operação ajusta dinamicamente a política de balanceamento de carga e melhora a alta disponibilidade do sistema para cenários que exigem escalonamento dinâmico de instâncias para lidar com cargas de trabalho flutuantes e garantir que as aplicações permaneçam ativas. |
| ModifyInstanceAttribute | Modificar atributos da instância | Modifica atributos específicos de uma instância ECS em um grupo de dimensionamento especificando parâmetros como o ID da instância, o ID do grupo de dimensionamento e o ID da região. Atualmente, apenas o atributo de gerenciamento de ciclo de vida das instâncias adicionadas manualmente ao grupo de dimensionamento pode ser modificado. |
| DescribePatternTypes | Consulta de tipos de instância por atributos de instância. | Consulta os tipos de instância que correspondem aos atributos de instância especificados, como o número de vCPUs, o tamanho da memória, o nível da família de instâncias e o preço máximo aceitável, ao definir uma configuração de dimensionamento especificando atributos de instância. Esta operação chama a operação de API DescribePatternTypes. |
| ApplyScalingGroup | Gerenciar grupos de escalonamento usando um arquivo de configuração. | Cria e gerencia grupos de escalonamento baseados em Elastic Container Instance (ECI) usando um arquivo de configuração. Você pode chamar a operação ApplyScalingGroup para implementar esse recurso. |
| ModifyAlertConfiguration | Definição dos status de atividade de escalonamento para notificações de mensagens em um grupo de escalonamento. | Configura os status de atividade de escalonamento para os quais o Auto Scaling envia notificações por SMS e e-mail em um grupo de escalonamento. Quando uma atividade de escalonamento é bem-sucedida, falha ou é rejeitada, o Auto Scaling pode enviar notificações por SMS ou e-mail. Você deve lidar com os eventos relacionados após receber as notificações. Você pode chamar a operação ModifyAlertConfiguration para definir os status de atividade de escalonamento que acionam notificações por SMS e e-mail em um grupo de escalonamento, para que você possa se manter informado sobre as alterações nas atividades de escalonamento e responder prontamente para melhorar a eficiência do escalonamento. |
| DescribeAlertConfiguration | Consulta o status de atividades de dimensionamento para notificações em um grupo de dimensionamento. | Quando uma atividade de dimensionamento é bem-sucedida, falha ou é rejeitada, o Auto Scaling pode enviar notificações por SMS e e-mail. Você deve tratar os eventos relacionados após receber as notificações. Você pode chamar a operação DescribeAlertConfiguration para consultar o status das atividades de dimensionamento para as quais notificações por SMS e e-mail são enviadas em um grupo de dimensionamento. Isso ajuda você a se manter informado sobre as alterações nas atividades de dimensionamento e a responder rapidamente para melhorar a eficiência do dimensionamento. |
| SuspendInstanceRefresh | Pausar uma tarefa de atualização de instância. | Pausa uma tarefa de atualização de instância. Durante a execução de uma tarefa de atualização de instância, se você suspeitar que a configuração apresenta problemas, mas não tiver certeza se um rollback é necessário, poderá chamar esta operação para pausar a tarefa de atualização de instância. Durante a pausa, você pode verificar se a configuração está correta. |
| ResumeInstanceRefresh | Retomar uma tarefa de atualização de instância pausada. | Retoma uma tarefa de atualização de instância que está no estado pausado. |
| CancelInstanceRefresh | Cancelar uma tarefa de atualização de instâncias. | Cancela uma tarefa de atualização de instâncias. As instâncias que já foram substituídas ou adicionadas durante o scale-out são mantidas. |
| DescribeInstanceRefreshes | Consulta de tarefas de atualização de instâncias. | Consulta as tarefas de atualização de instâncias de um grupo de escalonamento, incluindo informações básicas e o progresso das tarefas. |
| RollbackInstanceRefresh | Reversão de tarefa de atualização de instância. | Reverte uma tarefa de atualização de instância durante a execução. Se a configuração desejada não atender mais aos seus requisitos durante uma tarefa de atualização de instância, chame esta operação para reverter a tarefa. Durante a reversão, o sistema cria novas instâncias com base na configuração atualmente ativa do grupo de escalonamento para substituir as instâncias que foram criadas com base na configuração desejada. |
| StartInstanceRefresh | Inicia uma tarefa de atualização de instâncias. | Atualiza instâncias em um grupo de escalonamento quando é necessário aplicar uma nova configuração de escalonamento ou atualizar a imagem das instâncias no grupo de escalonamento. |