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

Este tópico descreve como criar o monitoramento de disponibilidade task1 no grupo de aplicativos 123456. O parâmetro TaskType da tarefa é definido como HTTP. Após iniciar a tarefa, o sistema envia alertas para o endereço de e-mail e o chatbot do DingTalk especificados.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer para maior conveniência. A ferramenta gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

Parâmetros de solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	CreateHostAvailability	Operação a ser executada. Defina o valor como CreateHostAvailability.
GroupId	Long	Sim	123456	ID do grupo de aplicativos.
TaskName	String	Sim	task1	Nome da tarefa de monitoramento de disponibilidade. Deve ter entre 4 e 100 caracteres e pode conter letras, dígitos e sublinhados (_).
TaskScope	String	Não	GROUP	Escopo de instâncias monitoradas pela tarefa de disponibilidade. Valores válidos: GROUP: Monitora todas as instâncias ECS no grupo de aplicativos. GROUP_SPEC_INSTANCE: Monitora apenas instâncias ECS específicas no grupo de aplicativos. Use este parâmetro em conjunto com InstanceList.N para especificar as instâncias ECS a serem monitoradas.
TaskType	String	Sim	HTTP	Tipo de monitoramento da tarefa de disponibilidade. Valores válidos: PING TELNET HTTP
TaskOption.HttpURI	String	Não	https://www.aliyun.com	URI a ser monitorada. Obrigatório se TaskType for HTTP.
TaskOption.TelnetOrPingHost	String	Não	www.aliyun.com	Nome de domínio ou endereço IP a ser monitorado. Nota Obrigatório se TaskType for PING ou TELNET.
TaskOption.HttpResponseCharset	String	Não	UTF-8	Conjunto de caracteres usado na resposta HTTP. Nota Valor válido: UTF-8.
TaskOption.HttpPostContent	String	Não	params1=paramsValue1	Conteúdo da solicitação HTTP POST.
TaskOption.HttpResponseMatchContent	String	Não	ok	Conteúdo esperado na resposta à solicitação HTTP.
TaskOption.HttpMethod	String	Não	GET	Método de solicitação HTTP. Valores válidos: GET POST HEAD Nota Obrigatório se TaskType for HTTP.
TaskOption.HttpNegative	Boolean	Não	true	Critério para acionar o alerta com base na presença da regra especificada no corpo da resposta. Valores válidos: true: Aciona o alerta se o corpo da resposta HTTP incluir a regra. false: Aciona o alerta se o corpo da resposta HTTP não incluir a regra. Nota Aplicável apenas se TaskType for HTTP.
TaskOption.HttpHeader	String	Não	token:testTokenValue	Cabeçalho da solicitação HTTP. Formato: `Nome do parâmetro:Valor do parâmetro`. Separe múltiplos parâmetros por caracteres de retorno de carro. Exemplo: `params1:value1 params2:value2`
TaskOption.Interval	Integer	Não	60	Intervalo de envio das solicitações de detecção. Unidade: segundos. Valores válidos: 15, 30, 60, 120, 300, 900, 1800 e 3600. Nota Disponível apenas para o agente do CloudMonitor V3.5.1 ou posterior.
AlertConfig.NotifyType	Integer	Sim	0	Métodos de notificação de alerta. Valores válidos: 0: Notificações enviadas por e-mail e chatbot do DingTalk.
AlertConfig.StartTime	Integer	Não	0	Hora inicial de vigência da regra de alerta. Valores válidos: 0 a 23. Por exemplo, se `AlertConfig.StartTime` for 0 e `AlertConfig.EndTime` for 22, a regra vigora das 00:00:00 às 22:00:00. Nota As notificações baseadas no limiar especificado são enviadas apenas durante o período de vigência da regra.
AlertConfig.EndTime	Integer	Não	22	Hora final de vigência da regra de alerta. Valores válidos: 0 a 23. Por exemplo, se `AlertConfig.StartTime` for 0 e `AlertConfig.EndTime` for 22, a regra vigora das 00:00:00 às 22:00:00. Nota As notificações baseadas no limiar especificado são enviadas apenas durante o período de vigência da regra.
AlertConfig.SilenceTime	Integer	Não	86400	Período de silêncio em que novos alertas não são enviados, mesmo se as condições de acionamento forem atendidas. Unidade: segundos. Valor padrão: 86400 (um dia).
AlertConfig.WebHook	String	Não	https://www.aliyun.com/webhook.json	URL de callback.
AlertConfigEscalationList.N.MetricName	String	Sim	HttpStatus	Métrica associada ao alerta. Valores válidos de N: 1 a 21. Valores válidos: HttpStatus: Código de status HTTP HttpLatency: Tempo de resposta HTTP TelnetStatus: Código de status Telnet TelnetLatency: Tempo de resposta Telnet PingLostRate: Taxa de perda de pacotes Ping
AlertConfigEscalationList.N.Value	String	Não	90	Limiar do alerta. Valores válidos de N: 1 a 21.
AlertConfigEscalationList.N.Times	Integer	Não	3	Número consecutivo de vezes que o valor da métrica deve atender à condição antes de acionar o alerta. Valores válidos de N: 1 a 21.
AlertConfigEscalationList.N.Operator	String	Não	>	Operador de comparação da regra de alerta. Valores válidos de N: 1 a 21. Valores válidos: `>` `>=` `<` `<=` `=`
AlertConfigEscalationList.N.Aggregate	String	Não	Value	Método de cálculo dos valores da métrica para acionar alertas. Valores válidos de N: 1 a 21. Valores válidos: HttpStatus: Value HttpLatency: Average TelnetStatus: Value TelnetLatency: Average PingLostRate: Average Nota Value representa o valor original (usado para códigos de status). Average representa a média (usada para latência e taxa de perda de pacotes).
InstanceList.N	String	Não	2	Instâncias ECS monitoradas. Valores válidos de N: 1 a 21. Nota Obrigatório se `TaskScope` for `GROUP_SPEC_INSTANCE`.
AlertConfigTargetList.N.Id	String	Não	1	ID do recurso alvo do alerta.
AlertConfigTargetList.N.Arn	String	Não	acs:mns:cn-hangzhou:120886317861****:/queues/test/message	Alibaba Cloud Resource Name (ARN) do recurso. Formato: `acs:{Abreviação do nome do serviço}:{regionId}:{userId}:/{Tipo de recurso}/{Nome do recurso}/message`. Exemplo: `acs:mns:cn-hangzhou:120886317861**:/queues/test123/message`. Campos: {Abreviação do nome do serviço}: abreviação do nome do serviço. Valor válido: mns. {userId}: ID da conta Alibaba Cloud. {regionId}: ID da região da fila de mensagens ou tópico. {Tipo de recurso}`: tipo do recurso alvo do alerta. Valores válidos: - queues - topics {Nome do recurso}: nome do recurso. - Se o tipo for queues, corresponde ao nome da fila de mensagens. - Se o tipo for topics**, corresponde ao nome do tópico.`
AlertConfigTargetList.N.Level	String	Não	["INFO", "WARN", "CRITICAL"]	Nível do alerta. Valores válidos: INFO: Informação WARN: Aviso CRITICAL: Crítico
AlertConfigTargetList.N.JsonParams	String	Não	{"customField1":"value1","customField2":"$.name"}	Parâmetros do callback de alerta em formato JSON.

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

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
Code	String	200	Código de status HTTP. Nota O código 200 indica sucesso na chamada.
Message	String	The specified resource is not found.	Mensagem de erro.
RequestId	String	ACBDBB40-DFB6-4F4C-8957-51FFB233969C	ID da solicitação.
TaskId	Long	12345	ID da tarefa de monitoramento de disponibilidade.
Success	Boolean	true	Indica se a chamada foi bem-sucedida. Valores válidos: true: Chamada bem-sucedida. false: Falha na chamada.

Exemplos

Exemplos de solicitações

http(s)://[Endpoint]/?Action=CreateHostAvailability
&AlertConfig.NotifyType=0
&AlertConfigEscalationList.1.MetricName=HttpStatus
&GroupId=123456
&TaskName=task1
&TaskType=HTTP
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateHostAvailabilityResponse>
	<TaskId>12345</TaskId>
	<RequestId>CDA78493-F10F-485F-98AD-B4C0B40AB225</RequestId>
	<Code>200</Code>
	<Success>true</Success>
</CreateHostAvailabilityResponse>

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TaskId" : "12345",
  "RequestId" : "CDA78493-F10F-485F-98AD-B4C0B40AB225",
  "Code" : 200,
  "Success" : true
}

Códigos de erro

Para obter uma lista de códigos de erro, visite o API Error Center.