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

Este tópico apresenta um exemplo de criação de uma tarefa de monitoramento de site chamada HanZhou_ECS1. A URL monitorada pela tarefa é https://www.aliyun.com e o tipo da tarefa é HTTPS.

Depuração

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

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	CreateSiteMonitor	A operação a ser executada. Defina o valor como CreateSiteMonitor.
Address	String	Sim	https://www.aliyun.com	A URL ou o endereço IP monitorado pela tarefa.
TaskType	String	Sim	HTTPS	O tipo da tarefa de monitoramento de site. Valores válidos: HTTP, HTTPS, PING, TCP, UDP, DNS, SMTP, POP3 e FTP.
TaskName	String	Sim	HanZhou_ECS1	O nome da tarefa de monitoramento de site. O nome deve ter de 4 a 100 caracteres e pode conter letras, dígitos e sublinhados (_).
Interval	String	Não	1	O intervalo de envio das solicitações de detecção. Valores válidos: 1, 5, 15, 30 e 60. Unidade: minutos. Valor padrão: 1.
IspCities	String	Não	[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]	As informações dos pontos de detecção. Se este parâmetro estiver vazio, o sistema seleciona aleatoriamente três pontos de detecção. O valor é um array JSON. Exemplo: `[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]`. Os valores do campo city indicam Pequim, Hangzhou e Qingdao. Para obter informações sobre como adquirir pontos de detecção, consulte DescribeSiteMonitorISPCityList.
OptionsJson	String	Não	{"time_out":5000}	As opções estendidas do protocolo usado pela tarefa de monitoramento de site. As opções variam conforme o protocolo.
AlertIds	String	Não	SystemDefault_acs_ecs_dashboard_InternetOutRate_Percent	O ID da regra de alerta. Para obter informações sobre como adquirir o ID de uma regra de alerta, consulte DescribeMetricRuleList.

As tabelas a seguir descrevem as opções estendidas dos protocolos HTTP, HTTPS, PING, TCP, UDP, DNS, SMTP, POP3 e FTP especificados pelo parâmetro TaskType.

HTTP ou HTTPS

Parâmetro	Tipo	Descrição
http_method	String	O método de solicitação HTTP ou HTTPS. Valores válidos: GET, POST e HEAD. Valor padrão: GET.
header	String	Os cabeçalhos HTTP personalizados separados por quebras de linha (\n). Cada cabeçalho deve estar em conformidade com o protocolo HTTP e ser um par chave-valor separado por dois pontos (:).
cookie	String	O cookie HTTP especificado em conformidade com o padrão de solicitação HTTP.
request_content	String	O conteúdo da solicitação. Pode estar no formato JSON ou form. Se este parâmetro não for especificado, o corpo da solicitação estará vazio.
response_content	String	O conteúdo esperado da resposta. O monitoramento do site verifica os primeiros 64 bytes do conteúdo retornado pelo servidor HTTP.
match_rule	String	0: A detecção terá êxito se a resposta não contiver o conteúdo especificado pelo parâmetro response_content. 1: A detecção terá êxito se a resposta contiver o conteúdo especificado pelo parâmetro response_content.
username	String	Se o parâmetro username for especificado, a solicitação HTTP incluirá o cabeçalho de autenticação básica.
password	String	A senha usada para autenticar a solicitação HTTP ou HTTPS.
time_out	int	O tempo limite. Unidade: milissegundos. Valor padrão: 5.
max_redirect	int	O número máximo de redirecionamentos. O valor padrão é 5 para pontos de detecção executados em instâncias do Elastic Compute Service (ECS) e 2 para pontos de detecção fornecidos por operadoras. Para desativar redirecionamentos, defina o valor como 0. Valores válidos: 0 a 50.

PING

Parâmetro

Tipo

Descrição

failure_rate

Text

Se a taxa de pings com falha exceder o valor deste parâmetro, a detecção falhará e retornará o código de status 610 ou 615. A mensagem de erro do código de status 610 é PingAllFail e a do código 615 é PingPartialFail.

Valor padrão: 0,1.

ping_num

int

O número de vezes que o endereço monitorado recebe ping. Valor padrão: 10.

Valores válidos: 1 a 100.

DNS

Parâmetro	Tipo	Descrição
dns_server	string	O nome de domínio ou o endereço IP do servidor Domain Name System (DNS).
dns_type	string	O tipo de registros DNS a consultar. Valores válidos: A, NS, CNAME, MX, TXT, ANY e AAAA.
expect_value	string	A lista de valores esperados. Separe os valores esperados com espaços.
match_rule	string	A relação entre a lista de valores esperados e a lista de resultados DNS. Se as duas listas não atenderem à relação especificada, a detecção falhará. Valores válidos: String vazia ou IN_DNS: A lista de valores esperados é um subconjunto da lista de resultados DNS. DNS_IN: A lista de resultados DNS é um subconjunto da lista de valores esperados. EQUAL: A lista de resultados DNS é igual à lista de valores esperados. ANY: A lista de resultados DNS tem interseção com a lista de valores esperados.

FTP

Parâmetro	Tipo	Descrição
port	int	O número da porta do servidor FTP. Se este parâmetro não for especificado, o sistema usará o valor padrão. A porta padrão é 21 para FTP e 990 para FTPS.
username	string	O nome de usuário para fazer login no servidor FTP. Se este parâmetro não for especificado, o sistema usará login anônimo.
password	string	A senha para fazer login no servidor FTP.

POP3 ou SMTP

Parâmetro	Tipo	Descrição
port	int	O número da porta do servidor POP3 ou SMTP. A porta padrão é 110 para POP3, 995 para POP3S e 25 para SMTP.
username	string	O nome de usuário para fazer login no servidor POP3 ou SMTP. O nome de usuário e a senha são obrigatórios.
password	string	A senha para fazer login no servidor 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	O número da porta do servidor TCP ou UDP.
request_content	string	O conteúdo da solicitação. Se o parâmetro request_format estiver definido como hex, o valor do parâmetro request_content será analisado no formato hexadecimal.
request_format	string	Se o parâmetro request_format tiver outro valor, o valor do parâmetro request_content será enviado ao servidor TCP ou UDP como uma string comum.
response_content	string	O conteúdo da resposta. Se a resposta do servidor TCP ou UDP não contiver o conteúdo especificado pelo parâmetro response_content, a detecção falhará. Se o parâmetro response_format estiver definido como hex, o valor do parâmetro response_content será analisado no formato hexadecimal. Se o parâmetro response_format tiver outro valor, o valor do parâmetro response_content será analisado como uma string comum.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
Code	String	200	O código de status HTTP. Nota O código de status 200 indica que a chamada foi bem-sucedida.
Message	String	Successful	A mensagem retornada.
RequestId	String	68192f5d-0d45-4b98-9724-892813f86c71	O ID da solicitação.
Success	String	true	Indica se a chamada foi bem-sucedida. Valores válidos: true: A chamada foi bem-sucedida. false: A chamada falhou.
Data	Object		O resultado da tarefa de monitoramento de site.
AttachAlertResult	Array of Contact		O resultado retornado após a associação da regra de alerta existente à tarefa de monitoramento de site.
Contact
Code	String	200	O código de status retornado após a associação da regra de alerta existente à tarefa de monitoramento de site. Nota O código de status 200 indica que a chamada foi bem-sucedida.
Message	String	successful	A mensagem retornada após a associação da regra de alerta existente à tarefa de monitoramento de site.
RequestId	String	5dd33455-4f65-4b0c-9200-33d66f3f340b	O ID da solicitação enviada para associar a regra de alerta existente à tarefa de monitoramento de site.
Success	String	true	Indica se a regra de alerta existente foi associada à tarefa de monitoramento de site. Valores válidos: true false
RuleId	String	SystemDefault_acs_ecs_dashboard_InternetOutRate_Percent	O ID da regra de alerta.
CreateResultList	Array of CreateResultList		O resultado da solicitação. Se a tarefa de monitoramento de site for criada, o resultado será retornado. Caso contrário, nenhum resultado será retornado.
CreateResultList
TaskId	String	2c8dbdf9-a3ab-46a1-85a4-f094965e****	O ID da tarefa de monitoramento de site.
TaskName	String	HanZhou_ECS1	O nome da tarefa de monitoramento de site.

Exemplos

Exemplos de solicitações

http(s)://[Endpoint]/?Action=CreateSiteMonitor
&Address=https://www.aliyun.com
&TaskName=HanZhou_ECS1
&TaskType=HTTPS
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

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

<CreateSiteMonitorResponse>
	<Message>successful</Message>
	<RequestId>68192f5d-0d45-4b98-9724-892813f86c71</RequestId>
	<Data>
		<AttachAlertResult>
			<Contact>
				<Message>successful</Message>
				<RequestId>5dd33455-4f65-4b0c-9200-33d66f3f340b</RequestId>
				<RuleId>SystemDefault_acs_ecs_dashboard_InternetOutRate_Percent</RuleId>
				<Code>200</Code>
				<Success>true</Success>
			</Contact>
		</AttachAlertResult>
	</Data>
	<Code>200</Code>
	<CreateResultList>
		<CreateResultList>
			<TaskId>2c8dbdf9-a3ab-46a1-85a4-f094965e****</TaskId>
			<TaskName>HanZhou_ECS1</TaskName>
		</CreateResultList>
	</CreateResultList>
	<Success>true</Success>
</CreateSiteMonitorResponse>

Formato JSON

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

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

Códigos de erro

Para obter uma lista de códigos de erro, consulte Códigos de erro do serviço.