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

Cria uma tarefa de monitoramento de site.

Descrição da operação

Este tópico descreve como criar uma tarefa de monitoramento de site. O exemplo cria uma tarefa chamada HanZhou_ECS1 para monitorar a URL https://www.aliyun.com via HTTPS.

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:CreateSiteMonitor

create

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Address	string	Sim	A URL ou o endereço IP a ser monitorado.	https://www.aliyun.com
TaskType	string	Sim	O tipo de tarefa de monitoramento. Os protocolos válidos incluem HTTP(S), PING, TCP, UDP, DNS, SMTP, POP3, FTP e WEBSOCKET.	HTTP
TaskName	string	Sim	O nome da tarefa de monitoramento. O nome deve ter de 4 a 100 caracteres e pode conter letras, dígitos, sublinhados (_) e caracteres chineses.	HanZhou_ECS1
Interval	string	Não	A frequência de monitoramento em minutos. Valores válidos: 1, 5, 15, 30 e 60. Valor padrão: 1.	1
IspCities	string	Não	Os pontos de detecção. Se você não especificar este parâmetro, o sistema selecionará aleatoriamente três pontos de detecção de diferentes provedores de serviços de Internet (ISPs). O valor deve ser uma matriz JSON. Exemplo: [{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]. Os valores correspondem a Pequim, Hangzhou e Qingdao. Para mais informações, consulte DescribeSiteMonitorISPCityList.	[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]
OptionsJson	string	Não	As opções avançadas para o protocolo especificado. As opções disponíveis variam de acordo com o tipo de protocolo.	{"time_out":5000}
AlertIds	string	Não	O ID da regra de alerta. Para mais informações, consulte DescribeMetricRuleList.	SystemDefault_acs_ecs_dashboard_InternetOutRate_Percent
AgentGroup	string	Não	O grupo de pontos de detecção para a tarefa de sondagem de rede. PC indica pontos de detecção em PCs. MOBILE indica pontos de detecção em dispositivos móveis. FC indica pontos de detecção em uma VPC. O valor padrão é PC.	PC
CustomSchedule	string	Não	A programação de detecção personalizada. Especifique um período de tempo e os dias da semana para a detecção.	{"start_hour":0,"end_hour":24, "days":[0], "time_zone":"Local"}
VpcConfig	string	Não	As informações de rede necessárias para criar uma tarefa de sondagem de rede em uma VPC. Deve ser um objeto JSON que contenha os campos vpcId, vswitchId, securityGroupId e region.	{"vpcId": "vpc-xxxxxx", "vswitchId": "vsw-xxxxxx", "securityGroupId": "sg-xxxxxx", "region": "cn-beijing"}

As tabelas a seguir descrevem os parâmetros avançados para os tipos de tarefa HTTP(S), PING, TCP, UDP, DNS, WEBSOCKET, SMTP, POP3 e FTP.

HTTP(S)

Parâmetro	Tipo	Descrição
http_method	String	O método de solicitação HTTP ou HTTPS. Valores válidos: GET, POST e HEAD. Padrão: GET.
header	String	O cabeçalho HTTP personalizado. Separe vários cabeçalhos com quebras de linha (\n). Cada cabeçalho deve estar no formato key:value e seguir o protocolo HTTP.
cookie	String	O cookie, formatado como um cookie de solicitação HTTP padrão.
request_content	String	O conteúdo da solicitação, no formato JSON ou de formulário. Se você não especificar este parâmetro, o corpo da solicitação ficará vazio.
response_content	String	O conteúdo de resposta esperado. O sistema verifica os primeiros 64 bytes da resposta do servidor.
match_rule	String	0: A sondagem é bem-sucedida se a resposta não contiver o valor response_content. 1: A sondagem é bem-sucedida se a resposta contiver o valor response_content.
username	String	O nome de usuário para autenticação Básica. Se especificado, um cabeçalho BasicAuth é incluído na solicitação HTTP.
password	String	A senha para autenticação Básica.
time_out	int	O período de tempo limite em milissegundos. Padrão: 5000.
max_redirect	int	O número máximo de redirecionamentos. Padrão: 5 para pontos de detecção ECS e 2 para pontos de detecção de operadora. Defina como 0 para desativar redirecionamentos. Valores válidos: 0 a 50.

PING.

Parâmetro	Tipo	Descrição
failure_rate	Text	O limite da taxa de falha. Se a taxa de falha do ping exceder este valor, a sondagem falhará e retornará o código de erro 610 (PingAllFail) ou 615 (PingPartialFail). Padrão: 0.1.
ping_num	int	O número de pacotes ping a serem enviados. Padrão: 10. Valores válidos: 1 a 100.

DNS.

Parâmetro	Tipo	Descrição
dns_server	string	O endereço do servidor DNS. Pode ser um nome de domínio ou um endereço IP.
dns_type	string	O tipo de consulta DNS. Valores válidos: A, NS, CNAME, MX, TXT, ANY e AAAA.
expect_value	string	Uma lista de valores esperados separados por espaços.
match_rule	string	A regra de correspondência entre os valores esperados e os resultados da consulta DNS. A sondagem falha se esta regra não for atendida. IN_DNS ou string vazia: Os valores esperados devem ser um subconjunto dos resultados DNS. DNS_IN: Os resultados DNS devem ser um subconjunto dos valores esperados. EQUAL: Os resultados DNS devem ser idênticos aos valores esperados. ANY: Os resultados DNS e os valores esperados devem ter pelo menos um valor em comum.

FTP.

Parâmetro	Tipo	Descrição
port	int	A porta do servidor FTP. Padrão: 21 para FTP e 990 para FTPS.
username	string	O nome de usuário para login FTP. Se não for especificado, o login anônimo será usado.
password	string	A senha para login FTP.

POP3 ou SMTP.

Parâmetro	Tipo	Descrição
port	int	A porta do servidor. Padrão: 110 para POP3, 995 para POP3S e 25 para SMTP.
username	string	O nome de usuário para login POP3 ou SMTP. O nome de usuário e a senha são obrigatórios.
password	string	A senha para login POP3 ou SMTP. O nome de usuário e a senha são obrigatórios.

TCP ou UDP.

Parâmetro	Tipo	Descrição
port	int	A porta do servidor TCP ou UDP.
request_content	string	O conteúdo da solicitação. Se request_format for hex, este valor deve estar no formato hexadecimal compacto.
request_format	string	O formato do conteúdo da solicitação. Se não for hex, o request_content é enviado como uma string comum.
response_content	string	O conteúdo de resposta esperado. A sondagem falha se a resposta do servidor não contiver este valor. Se request_format for hex, este valor deve estar no formato hexadecimal compacto. Caso contrário, é tratado como uma string comum.

WEBSOCKET.

Parâmetro	Tipo	Descrição
request_content	string	O conteúdo da mensagem a ser enviado.
empty_message	boolean	Especifica se uma mensagem vazia ou nenhuma mensagem do servidor é considerada um sucesso.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	N/A.
Code	string	O código de status da operação. Nota Um valor 200 indica sucesso.	200
Message	string	A mensagem retornada para a solicitação.	Successful
RequestId	string	O ID da solicitação.	68192f5d-0d45-4b98-9724-892813f86c71
Success	string	Indica se a solicitação foi bem-sucedida. Valores válidos: true: A solicitação foi bem-sucedida. false: A solicitação falhou.	true
Data	object	Os resultados da tarefa de monitoramento.
AttachAlertResult	object
Contact	array<object>	The results of associating the alert rules.
	object	The result for a single alert rule association.
Code	string	The status code for the association operation. Nota A value of `200` indicates success.	200
Message	string	The message returned for the association operation.	successful
RequestId	string	The request ID for the association operation.	5dd33455-4f65-4b0c-9200-33d66f3f340b
Success	string	Indicates whether the alert rule was successfully associated. Valid values: true: The association was successful. false: The association failed.	true
RuleId	string	The ID of the alert rule.	SystemDefault_acs_ecs_dashboard_InternetOutRate_Percent
CreateResultList	object
CreateResultList	array<object>	Uma lista de resultados para cada tarefa criada. Isso é retornado apenas se a criação da tarefa for bem-sucedida.
	object	O resultado para uma única tarefa criada. Isso é retornado apenas se a criação da tarefa for bem-sucedida.
TaskId	string	The ID of the created monitoring task.	2c8dbdf9-a3ab-46a1-85a4-f094965e****
TaskName	string	The name of the created monitoring task.	HanZhou_ECS1

Exemplos

Resposta de sucesso

JSON formato

{
  "Code": "200",
  "Message": "Successful",
  "RequestId": "68192f5d-0d45-4b98-9724-892813f86c71",
  "Success": "true",
  "Data": {
    "AttachAlertResult": {
      "Contact": [
        {
          "Code": "200",
          "Message": "successful",
          "RequestId": "5dd33455-4f65-4b0c-9200-33d66f3f340b",
          "Success": "true",
          "RuleId": "SystemDefault_acs_ecs_dashboard_InternetOutRate_Percent"
        }
      ]
    }
  },
  "CreateResultList": {
    "CreateResultList": [
      {
        "TaskId": "2c8dbdf9-a3ab-46a1-85a4-f094965e****",
        "TaskName": "HanZhou_ECS1"
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidQueryParameter	%s
400	IllegalAddress	Illegal HTTP address
400	OperationError	Operation failed
400	TaskNotExists	Task does not exist
400	OperatorInvalid	Operator invalid
400	NameRepeat	Task name repeat
400	CreateAlarmError	Create alarm error
400	NameNotExists	Task name not exists
400	OperatorCityInvalid	Invalid Isp.	Invalid Isp
401	AccessDeniedException	You donot have sufficient access to perform this action.
500	InternalError	The request processing has failed due to some unknown error.
402	LimitExceeded	The quota for this customer had been reached.
403	Forbidden	%s
403	RestrictedUser	The user's operation is restricted, please register NAAM product code
503	%s	%s
406	ExceedingQuota	Exceeding quota limits.	The number of tasks exceeds the limit
409	%s	%s

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.