CreateHostAvailability - Cloud Monitor: Central de Documentação do Alibaba Cloud

Cria uma tarefa de monitoramento de disponibilidade.

Descrição da operação

Este tópico fornece um exemplo de como criar uma tarefa de monitoramento de disponibilidade chamada task1 com o tipo de detecção definido como HTTP no grupo de aplicativos 123456. As notificações de alerta são enviadas por e-mail e chatbot do DingTalk.

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

cms:CreateHostAvailability

create

*HostAvailability.

acs:cms::{#accountId}:group/{#groupId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
GroupId	integer	Sim	O ID do grupo de aplicativos.	123456
TaskName	string	Sim	O nome da tarefa de monitoramento de disponibilidade. O nome deve ter de 4 a 100 caracteres e pode conter letras, dígitos, sublinhados (_) e caracteres chineses.	task1
TaskScope	string	Não	O escopo de detecção da tarefa de monitoramento de disponibilidade. Valores válidos: GROUP: usa todas as instâncias ECS no grupo de aplicativos atual como sondas de detecção. GROUP_SPEC_INSTANCE: usa instâncias ECS especificadas no grupo de aplicativos atual como sondas de detecção. Se você definir este parâmetro como GROUP_SPEC_INSTANCE, também deverá definir InstanceList para especificar as instâncias ECS que iniciam a detecção.	GROUP.
TaskType	string	Sim	O tipo de detecção da tarefa de monitoramento de disponibilidade. Valores válidos: PING TELNET HTTP	HTTP.
TaskOption.HttpURI	string	Não	O URI para detecção HTTP ou Telnet.	https://www.aliyun.com telnet://127.0.0.1:80
TaskOption.TelnetOrPingHost	string	Não	O nome de domínio ou endereço a ser detectado. Nota Se o tipo de detecção for PING, defina este parâmetro.	www.aliyun.com.
TaskOption.HttpResponseCharset	string	Não	O conjunto de caracteres de resposta para detecção HTTP. Nota Apenas UTF-8 é suportado.	UTF-8
TaskOption.HttpPostContent	string	Não	O conteúdo POST da solicitação de detecção HTTP.	params1=paramsValue1
TaskOption.HttpResponseMatchContent	string	Não	O conteúdo a ser correspondido na resposta.	ok
TaskOption.HttpMethod	string	Não	O método para o tipo de detecção. Valores válidos: GET POST HEAD Nota Se o tipo de detecção for HTTP, defina este parâmetro.	GET.
TaskOption.HttpNegative	boolean	Não	A regra de alerta para correspondência de conteúdo de resposta HTTP. Valores válidos: true: Um alerta é acionado se o conteúdo da resposta HTTP contiver o conteúdo da regra de alerta especificado. false: Um alerta é acionado se o conteúdo da resposta HTTP não contiver o conteúdo da regra de alerta especificado. Nota Este parâmetro entra em vigor apenas quando o tipo de detecção é HTTP.	true.
TaskOption.HttpHeader	string	Não	O cabeçalho da solicitação HTTP. O formato é `Nome do parâmetro:Valor do parâmetro`. Separe vários parâmetros com quebras de linha. Exemplo: `params1:value1 params2:value2`	token:testTokenValue.
TaskOption.Interval	integer	Não	A frequência de detecção. Unidade: segundos. Valores válidos: 15, 30, 60, 120, 300, 900, 1800 e 3600. Nota Apenas o agente do CloudMonitor versão 3.5.1 ou posterior suporta este parâmetro.	60
AlertConfig.NotifyType	integer	Sim	O tipo de notificação de alerta. Valores válidos: 0: e-mail + chatbot do DingTalk.	0
AlertConfig.StartTime	integer	Não	A hora de início em que o alerta entra em vigor. O valor é um número inteiro no intervalo de 0 a 23. Unidade: horas. O valor indica a hora em que o período efetivo começa. O ponto de início real é 00:00:00 da hora especificada. Por exemplo, um valor de 0 indica que o período efetivo começa às 00:00:00. O fuso horário é UTC+8. Nota Se a hora atual não estiver dentro da janela de tempo efetiva, as notificações de alerta não serão enviadas mesmo que o limite seja excedido.	0
AlertConfig.EndTime	integer	Não	A hora de término em que o alerta entra em vigor. O valor é um número inteiro no intervalo de 0 a 23. Unidade: horas. O valor indica a hora em que o período efetivo termina. O ponto de término real é 00:00:00 da hora especificada. Por exemplo, um valor de 22 indica que o período efetivo termina às 22:00:00. O fuso horário é UTC+8. Nota Se a hora atual não estiver dentro da janela de tempo efetiva, as notificações de alerta não serão enviadas mesmo que o limite seja excedido.	22
AlertConfig.SilenceTime	integer	Não	O período de silêncio. Unidade: segundos. Valor padrão: 86400 (1 dia).	86400
AlertConfig.WebHook	string	Não	O endereço do webhook.	https://www.aliyun.com/webhook.json.
AlertConfigEscalationList	array<object>	Sim	Nenhum.
	object	Não	Nenhum.
MetricName	string	Sim	A métrica para o alerta. Valores válidos de N: 1 a 21. Valores válidos: HttpStatus: Código de status HTTP. HttpLatency: Latência HTTP. TelnetStatus: Código de status Telnet. TelnetLatency: Latência Telnet. PingLostRate: Taxa de perda de pacotes Ping.	HttpStatus.
Value	string	Não	O limite de alerta. Valores válidos de N: 1 a 21.	90
Times	integer	Não	O número de novas tentativas de alerta. Valores válidos de N: 1 a 21.	3
Operator	string	Não	O operador de comparação para a regra de alerta. Valores válidos de N: 1 a 21. Valores válidos: `>` `>=` `<` `<=` `=`	>
Aggregate	string	Não	O método estatístico para o alerta. Valores válidos de N: 1 a 21. Os valores válidos variam de acordo com a métrica: HttpStatus: Value. HttpLatency: Average. TelnetStatus: Value. TelnetLatency: Average. PingLostRate: Average. Nota O método estatístico para métricas de código de status é o valor original (Value). O método estatístico para métricas de latência ou taxa de perda de pacotes é o valor médio (Average).	Value.
InstanceList	array	Não	A lista de instâncias ECS que iniciam a detecção. Valores válidos de N: 1 a 21. Nota Defina este parâmetro quando `TaskScope` estiver definido como `GROUP_SPEC_INSTANCE`.	i-absdfkwl321****
	string	Não	A lista de instâncias ECS que iniciam a detecção. Valores válidos de N: 1 a 21. Nota Defina este parâmetro quando `TaskScope` estiver definido como `GROUP_SPEC_INSTANCE`.	2
AlertConfigTargetList	array<object>	Não	Os alvos de acionamento de alerta.
	object	Não	Os alvos de acionamento de alerta.
Id	string	Não	O ID do alvo de acionamento de alerta.	1
Arn	string	Não	O ARN do recurso. Formato: `acs:{AbbreviatedCloudServiceName}:{regionId}:{userId}:/{ResourceType}/{ResourceName}/message`. Exemplo: `acs:mns:cn-hangzhou:120886317861**:/queues/test123/message`. A lista a seguir descreve os parâmetros: {AbbreviatedCloudServiceName}: Apenas Simple Message Queue (anteriormente MNS) é suportado. {userId}: O ID da conta Alibaba Cloud. {regionId}: A região onde a fila ou tópico do Simple Message Queue (anteriormente MNS) reside. {ResourceType}: O tipo de recurso que aceita alertas. Valores válidos: queues: fila. topics: tópico. {ResourceName}: O nome do recurso. Se o tipo de recurso for queues, o nome do recurso é o nome da fila. Se o tipo de recurso for topics**, o nome do recurso é o nome do tópico.	acs:mns:cn-hangzhou:120886317861****:/queues/test/message.
Level	string	Não	O nível de alerta. Valores válidos: INFO: informação. WARN: aviso. CRITICAL: crítico.	["INFO", "WARN", "CRITICAL"]
JsonParams	string	Não	Os parâmetros formatados em JSON do callback de alerta.	{"customField1":"value1","customField2":"$.name"}

Para mais informações sobre parâmetros de solicitação comuns, consulte Parâmetros comuns.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
Code	string	O código de status. Nota Um valor de 200 indica sucesso.	200
Message	string	A mensagem de erro.	The specified resource is not found.
RequestId	string	O ID da solicitação.	ACBDBB40-DFB6-4F4C-8957-51FFB233969C.
TaskId	integer	O ID da tarefa de monitoramento de disponibilidade.	12345
Success	boolean	Indica se a operação foi bem-sucedida. Valores válidos: true: A operação foi bem-sucedida. false: A operação falhou.	true.

Exemplos

Resposta de sucesso

JSON formato

{
  "Code": "200",
  "Message": "The specified resource is not found.",
  "RequestId": "ACBDBB40-DFB6-4F4C-8957-51FFB233969C",
  "TaskId": 12345,
  "Success": true
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	ParameterInvalid	Parameter invalid.	O parâmetro é inválido.
412	ResouceOverLimit	The task over limit
500	InternalError	The request processing has failed due to some unknown error.
403	AccessForbidden	User not authorized to operate on the specified resource.
404	ResourceNotFound	%s
409	ResourceConflict	Concurrent modification of resources.
409	ResourceExist	Resources already exist.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.