CreateAlarm - Auto Scaling: Central de Documentação do Alibaba Cloud

Cria uma tarefa acionada por evento.

Descrição da operação

Se você criar uma tarefa acionada por evento do tipo de monitoramento personalizado (MetricType=custom), deverá reportar métricas de monitoramento personalizado ao CloudMonitor antecipadamente. Para mais informações, consulte Tarefas acionadas por evento do tipo de monitoramento personalizado.
Ao criar uma tarefa acionada por evento, você deve especificar uma métrica de monitoramento (MetricName) e usar informações de dimensão (Dimension.N.DimensionKey e Dimension.N.DimensionValue) para determinar o escopo de agregação dos dados da métrica de monitoramento no grupo de escalonamento. Por exemplo, você pode especificar user_id e scaling_group para agregar os dados da métrica de monitoramento de todas as instâncias ECS ou instâncias de contêiner elástico no grupo de escalonamento do usuário especificado.
- As métricas de monitoramento de tarefas acionadas por evento do tipo de monitoramento personalizado (MetricType=custom) dependem das suas métricas de monitoramento personalizado.
- Para mais informações sobre as métricas de monitoramento suportadas por tarefas acionadas por evento do tipo de monitoramento do sistema (MetricType=system), consulte Tarefas acionadas por evento do tipo de monitoramento do sistema.

Nota

Nas informações de dimensão, user_id e scaling_group são preenchidos automaticamente pelo sistema. Você deve especificar manualmente device e state. Para mais informações, consulte os parâmetros Dimension.N.DimensionKey e Dimension.N.DimensionValue.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

ess:CreateAlarm

create

*ScalingGroup

acs:ess:{#regionId}:{#accountId}:scalinggroup/{#ScalingGroupId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região do grupo de escalonamento.	cn-hangzhou
Name	string	Não	O nome da tarefa acionada por evento.	TestAlarmTask
Description	string	Não	A descrição da tarefa acionada por evento.	Test alarm task.
ScalingGroupId	string	Sim	O ID do grupo de escalonamento associado à tarefa acionada por evento.	asg-bp18p2yfxow2dloq****
MetricName	string	Não	O nome da métrica de monitoramento. Os valores válidos variam de acordo com o tipo de monitoramento da tarefa acionada por evento: Se a tarefa acionada por evento for do tipo de monitoramento personalizado (MetricType=custom), os valores válidos são as suas métricas de monitoramento personalizado. Se a tarefa acionada por evento for do tipo de monitoramento do sistema (MetricType=system), valores válidos: CpuUtilization: (ECS) utilização de CPU (%). ConcurrentConnections: (ECS) número de conexões simultâneas a uma instância ECS. IntranetTx: (ECS) tráfego de saída pela rede interna (Kbit/min). IntranetRx: (ECS) tráfego de entrada pela rede interna (Kbit/min). VpcInternetTx: (ECS) tráfego de saída pela Internet (Kbit/min). VpcInternetRx: (ECS) tráfego de entrada pela Internet (Kbit/min). SystemDiskReadBps: (ECS) BPS de leitura do disco em nuvem do sistema (byte/s). SystemDiskWriteBps: (ECS) BPS de gravação do disco em nuvem do sistema (byte/s). SystemDiskReadOps: (ECS) IOPS de leitura do disco em nuvem do sistema (contagem/s). SystemDiskWriteOps: (ECS) IOPS de gravação do disco em nuvem do sistema (contagem/s). CpuUtilizationAgent: (Agent) utilização de CPU (%). GpuUtilizationAgent: (Agent) utilização de GPU (%). GpuMemoryFreeUtilizationAgent: (Agent) taxa de ociosidade da memória da GPU (%). GpuMemoryUtilizationAgent: (Agent) utilização da memória da GPU (%). MemoryUtilization: (Agent) utilização de memória (%). LoadAverage: (Agent) carga média do sistema. TcpConnection: (Agent) número total de conexões TCP. TcpConnection: (Agent) número de conexões TCP estabelecidas. PackagesNetOut: (Agent) número de pacotes enviados pela NIC interna (contagem/s). PackagesNetIn: (Agent) número de pacotes recebidos pela NIC interna (contagem/s). PackagesNetOut: (Agent) número de pacotes enviados pela NIC pública (contagem/s). PackagesNetIn: (Agent) número de pacotes recebidos pela NIC pública (contagem/s). EciPodCpuUtilization: utilização de CPU (%). EciPodMemoryUtilization: utilização de memória (%). LoadBalancerRealServerAverageQps: (ALB) QPS médio por servidor em um grupo de servidores (contagem/s). Para mais informações, consulte Tarefas acionadas por evento do tipo de monitoramento do sistema.	CpuUtilization
MetricType	string	Não	O tipo da métrica de monitoramento. Valores válidos: system: usa métricas do sistema do CloudMonitor. custom: usa métricas personalizadas reportadas ao CloudMonitor.	system
Period	integer	Não	O período estatístico para os dados da métrica de monitoramento. Unidade: segundos. Valores válidos: 15 60 120 300 900 Nota Apenas grupos de escalonamento do tipo ECS suportam um período estatístico de 15 segundos. Valor padrão: 300.	300
Statistics	string	Não	O método usado para agregar os dados da métrica de monitoramento. Valores válidos: Average: valor médio. Minimum: valor mínimo. Maximum: valor máximo. Valor padrão: Average.	Average
Threshold	number	Não	O limite das métricas de monitoramento. Um alerta é acionado e a regra de escalonamento é executada quando a expressão de limite é atendida pelo número de vezes especificado.	80.0
ComparisonOperator	string	Não	O operador de comparação entre o valor agregado da métrica de monitoramento e o limite. Este parâmetro especifica a relação sob a qual a condição é atendida. Valores válidos: O valor agregado é maior ou igual ao limite. Valor: >=. O valor agregado é menor ou igual ao limite. Valor: <=. O valor agregado é maior que o limite. Valor: >. O valor agregado é menor que o limite. Valor: <. Valor padrão: >=.	>=
EvaluationCount	integer	Não	O número de vezes consecutivas que a expressão de limite deve ser atendida antes que a regra de escalonamento seja executada. Por exemplo, a utilização média de CPU deve ser maior ou igual a 80% por três períodos estatísticos consecutivos. Valor padrão: 3.	3
GroupId	integer	Não	O ID do grupo de aplicativos do CloudMonitor ao qual a métrica de monitoramento personalizado pertence. Este parâmetro é obrigatório apenas quando MetricType está definido como custom.	4055401
Effective	string	Não	O período de vigência da tarefa acionada por evento. Por padrão, a tarefa acionada por evento está em vigor o tempo todo. Este parâmetro segue expressões cron. O formato padrão é `X X X X X ?`, onde: X: um espaço reservado para um campo, que representa segundos, minutos, horas, dia do mês e mês em sequência. X pode ser um valor específico ou um caractere especial com significado lógico. Para mais informações sobre os valores válidos de X, consulte Expressão Cron. ?: especifica nenhum valor. Nota O valor deste parâmetro está no fuso horário UTC+8 por padrão. Você pode adicionar as informações de fuso horário `TZ=+yy` antes da expressão cron para especificar um fuso horário, onde y representa o valor numérico do fuso horário. Por exemplo, `TZ=+00 * * 1-2 * * ?` especifica que a tarefa acionada por evento estará em vigor entre 01:00 e 02:59 no fuso horário UTC+0 todos os dias. Exemplos: `* * * * * ?` : em vigor o tempo todo. `* * 17-18 * * ?` : em vigor entre 17:00 e 18:59 no fuso horário UTC+8 todos os dias. `TZ=+00 * * 1-2 * * ?`: em vigor entre 01:00 e 02:59 no fuso horário UTC+0 todos os dias.	TZ=+00 * * 1-2 * * ?
AlarmAction	array	Não	O identificador exclusivo da regra de escalonamento associada à tarefa acionada por evento.	ari:acs:ess:cn-hangzhou:1406926**:scalingrule/asr-bp163l21e07uhn**
	string	Não	O identificador exclusivo da regra de escalonamento associada à tarefa acionada por evento.	ari:acs:ess:cn-hangzhou:1406926**:scalingrule/asr-bp163l21e07uhn**
Dimension	array<object>	Não	A lista de dimensões associadas à métrica de monitoramento.
	object	Não	A lista de dimensões associadas à métrica de monitoramento.
DimensionKey	string	Não	A chave da dimensão associada à métrica de monitoramento. Os valores válidos variam de acordo com o tipo de monitoramento da tarefa acionada por evento: Se a tarefa acionada por evento for do tipo de monitoramento personalizado (MetricType=custom), você pode especificar qualquer valor. Se a tarefa acionada por evento for do tipo de monitoramento do sistema (MetricType=system), valores válidos: user_id: o ID da sua conta. scaling_group: o grupo de escalonamento a ser monitorado. device: o tipo do dispositivo de controlador de interface de rede (NIC). state: o estado da conexão TCP. rulePool: o grupo de servidores especificado para o nó de métricas de monitoramento de QPS do ALB.	device
DimensionValue	string	Não	O valor da dimensão associada à métrica de monitoramento. Os valores válidos são determinados por Dimension.N.DimensionKey: Se Dimension.N.DimensionKey for um valor personalizado, o que significa que a tarefa acionada por evento é do tipo de monitoramento personalizado (MetricType=custom), você pode especificar qualquer valor. Se Dimension.N.DimensionKey for um valor especificado pelo sistema, o que significa que a tarefa acionada por evento é do tipo de monitoramento do sistema (MetricType=system), valores válidos: user_id: preenchido automaticamente pelo sistema. scaling_group: preenchido automaticamente pelo sistema. device: eth0: para instâncias de rede clássica, eth0 representa a NIC interna. Para instâncias conectadas à VPC, apenas a NIC eth0 existe. eth1: para instâncias de rede clássica, eth1 representa a NIC pública. state: TCP_TOTAL: o número total de conexões TCP. ESTABLISHED: o número de conexões TCP estabelecidas. rulePool: o ID do grupo de servidores do ALB. Exemplo: sgp-xxxxx.	eth0
Expression	array<object>	Não	As informações sobre regras de alerta de múltiplas métricas.
	object	Não	As informações sobre regras de alerta de múltiplas métricas.
MetricName	string	Não	O nome da métrica de monitoramento na regra de alerta de múltiplas métricas. Os valores válidos variam de acordo com o tipo de monitoramento da tarefa acionada por evento: Se a tarefa acionada por evento for do tipo de monitoramento personalizado (MetricType=custom), os valores válidos são as suas métricas de monitoramento personalizado. Se a tarefa acionada por evento for do tipo de monitoramento do sistema (MetricType=system), valores válidos: CpuUtilization: (ECS) utilização de CPU (%). ConcurrentConnections: (ECS) número de conexões simultâneas a uma instância ECS. IntranetTx: (ECS) tráfego de saída pela rede interna (Kbit/min). IntranetRx: (ECS) tráfego de entrada pela rede interna (Kbit/min). VpcInternetTx: (ECS) tráfego de saída pela Internet (Kbit/min). VpcInternetRx: (ECS) tráfego de entrada pela Internet (Kbit/min). SystemDiskReadBps: (ECS) BPS de leitura do disco em nuvem do sistema (byte/s). SystemDiskWriteBps: (ECS) BPS de gravação do disco em nuvem do sistema (byte/s). SystemDiskReadOps: (ECS) IOPS de leitura do disco em nuvem do sistema (contagem/s). SystemDiskWriteOps: (ECS) IOPS de gravação do disco em nuvem do sistema (contagem/s). CpuUtilizationAgent: (Agent) utilização de CPU (%). GpuUtilizationAgent: (Agent) utilização de GPU (%). GpuMemoryFreeUtilizationAgent: (Agent) taxa de ociosidade da memória da GPU (%). GpuMemoryUtilizationAgent: (Agent) utilização da memória da GPU (%). MemoryUtilization: (Agent) utilização de memória (%). LoadAverage: (Agent) carga média do sistema. TcpConnection: (Agent) número total de conexões TCP. TcpConnection: (Agent) número de conexões TCP estabelecidas. PackagesNetOut: (Agent) número de pacotes enviados pela NIC interna (contagem/s). PackagesNetIn: (Agent) número de pacotes recebidos pela NIC interna (contagem/s). PackagesNetOut: (Agent) número de pacotes enviados pela NIC pública (contagem/s). PackagesNetIn: (Agent) número de pacotes recebidos pela NIC pública (contagem/s). EciPodCpuUtilization: utilização de CPU (%). EciPodMemoryUtilization: utilização de memória (%). LoadBalancerRealServerAverageQps: (ALB) QPS médio por servidor em um grupo de servidores (contagem/s). Para mais informações, consulte Tarefas acionadas por evento do tipo de monitoramento do sistema.	CpuUtilization
ComparisonOperator	string	Não	O operador de comparação entre o valor agregado da métrica de monitoramento e o limite na regra de alerta de múltiplas métricas. Este parâmetro especifica a relação sob a qual a condição é atendida. Valores válidos: O valor agregado é maior ou igual ao limite. Valor: >=. O valor agregado é menor ou igual ao limite. Valor: <=. O valor agregado é maior que o limite. Valor: >. O valor agregado é menor que o limite. Valor: <. Valor padrão: >=.	>=
Period	integer	Não	O período estatístico para os dados da métrica de monitoramento na regra de alerta de múltiplas métricas. Unidade: segundos. Valores válidos: 15 60 120 300 900 Nota Apenas grupos de escalonamento do tipo ECS suportam um período estatístico de 15 segundos. Valor padrão: 300.	900
Statistics	string	Não	O método usado para agregar os dados da métrica de monitoramento na regra de alerta de múltiplas métricas. Valores válidos: Average: valor médio. Minimum: valor mínimo. Maximum: valor máximo. Valor padrão: Average.	Average
Threshold	number	Não	O limite das métricas de monitoramento na regra de alerta de múltiplas métricas. Um alerta é acionado e a regra de escalonamento é executada quando a expressão de limite é atendida pelo número de vezes especificado.	40.0
ExpressionsLogicOperator	string	Não	A relação entre múltiplas condições de alerta de métricas. Valores válidos: `&&`: um alerta é acionado apenas quando todas as métricas de monitoramento atendem às condições de alerta. Um alerta é acionado apenas quando todas as expressões na regra de alerta de múltiplas métricas são avaliadas como `true`. `\|\|`: um alerta é acionado quando qualquer métrica de monitoramento atende à condição de alerta. Valor padrão: `&&`.	&&

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
AlarmTaskId	string	O ID da tarefa acionada por evento.	asg-bp1hvbnmkl10vll5**_f95ce797-dc2e-4bad-9618-14fee7d1**
RequestId	string	O ID da solicitação.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3****

Exemplos

Resposta de sucesso

JSON formato

{
  "AlarmTaskId": "asg-bp1hvbnmkl10vll5****_f95ce797-dc2e-4bad-9618-14fee7d1****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3****"
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.