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

Cria uma tarefa de monitoramento sintético única.

Descrição da operação

Apenas contas Alibaba Cloud que ativaram o Network Analysis and Monitoring podem criar tarefas de monitoramento sintético únicas.

Este tópico fornece um exemplo de como criar uma tarefa de monitoramento sintético única. O nome da tarefa é task1, o endereço monitorado é http://www.aliyun.com, o tipo de tarefa é HTTP e o número de pontos de detecção é 1.

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

create

*Todos os recursos.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Address	string	Sim	A URL ou endereço IP da tarefa de monitoramento sintético.	http://www.aliyun.com.
TaskType	string	Sim	O tipo da tarefa de monitoramento sintético. Valores válidos: HTTP, PING, TCP, UDP e DNS.	HTTP.
TaskName	string	Sim	O nome da tarefa de monitoramento sintético. O nome deve ter de 4 a 100 caracteres e pode conter letras, dígitos e sublinhados (_).	task1
IspCities	string	Não	As informações do ponto de detecção. Se este parâmetro for deixado vazio, o sistema selecionará aleatoriamente três pontos de detecção. O valor está no formato `JSONArray`. Exemplo: [{"city":"546","isp":"465", "type":"IDC"},{"city":"572","isp":"465", "type":"LASTMILE"},{"city":"738","isp":"465"}], que correspondem a Pequim, Hangzhou e Qingdao, respectivamente. O campo type especifica o tipo de ponto de detecção. Quando AgentGroup está definido como PC, os valores válidos são IDC e LASTMILE. IDC indica pontos de detecção implantados em data centers. LASTMILE indica pontos de detecção implantados em residências de usuários finais que utilizam redes fixas. O campo type é opcional e tem como padrão IDC. Quando AgentGroup está definido como MOBILE, não é necessário especificar este campo. Para obter informações sobre como obter as informações dos pontos de detecção, consulte DescribeSiteMonitorISPCityList. Nota Você deve especificar `IspCities` ou `RandomIspCity`.	[{"city":"546","isp":"465"},{"city":"572","isp":"465"},{"city":"738","isp":"465"}]
OptionsJson	string	Não	As opções avançadas estendidas para o tipo de protocolo da tarefa de monitoramento sintético. Diferentes tipos de protocolo correspondem a diferentes opções estendidas.	{"time_out":5000}
RandomIspCity	integer	Não	O número de pontos de detecção. Nota Você deve especificar `IspCities` ou `RandomIspCity`.- Se você definir o parâmetro `RandomIspCity`, o parâmetro `IspCities` se tornará inválido.	1
AgentGroup	string	Não	O tipo de pontos de detecção. Valores válidos: PC e MOBILE. PC indica pontos de detecção de rede fixa. MOBILE indica pontos de detecção de rede móvel. Valor padrão: PC. Valores válidos: PC : pontos de detecção de rede fixa. MOBILE : pontos de detecção de rede móvel.	PC

Configurações avançadas de parâmetros para TaskType

As tabelas a seguir descrevem como configurar os parâmetros avançados para HTTP, PING, TCP, UDP e DNS em TaskType.

HTTP

Parâmetro	Tipo	Descrição
http_method	String	O método de solicitação HTTP. Valores válidos: GET, POST e HEAD. Valor padrão: GET.
header	String	Cabeçalhos HTTP personalizados separados por quebras de linha (\n). Cada linha de cabeçalho deve estar em conformidade com o formato do protocolo HTTP (pares chave-valor separados por dois pontos de meia largura).
cookie	String	O cookie, escrito no formato padrão de solicitação HTTP.
request_content	String	O conteúdo da solicitação. Dois formatos são suportados: JSON e formulário. Se não fornecido, a solicitação não contém um corpo.
response_content	String	O conteúdo de resposta esperado. Durante a detecção, os primeiros 64 bytes retornados pelo servidor HTTP são verificados.
match_rule	String	0: A detecção é bem-sucedida se a resposta não contiver response_content. 1: A detecção é bem-sucedida se a resposta contiver response_content.
username	String	Se um nome de usuário for fornecido, um cabeçalho BasicAuth será incluído na solicitação HTTP.
password	String	A senha para autenticação da solicitação HTTP.
time_out	int	O período de tempo limite. Unidade: milissegundos. Valor padrão: 30000.
max_redirect	int	O número máximo de redirecionamentos. O valor padrão é 5 para sondas ECS e 2 para pontos de detecção de operadoras. Defina este parâmetro como 0 para desativar redirecionamentos. Valores válidos: 0 a 50.

PING

Parâmetro	Tipo	Descrição
failure_rate	int	Se a taxa de falha do PING exceder este valor, a detecção falhará e retornará 610 (PingAllFail) ou 615 (PingPartialFail). Valor padrão: 0.1.
ping_num	int	O número de tentativas de PING. Valor padrão: 20. Valores válidos: 1 a 100.

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. Quando request_format está definido como hex, o valor de request_content está no formato compacto hexadecimal.
request_format	string	Quando request_format está definido com outros valores, request_content é enviado ao servidor TCP ou UDP como uma string de caracteres simples.
response_content	string	O conteúdo da resposta. Se o conteúdo retornado pelo servidor TCP ou UDP não contiver response_content, a detecção falhará. Quando response_format está definido como hex, o valor de response_content está no formato compacto hexadecimal. Quando response_content está definido com outros valores, response_content é uma string de caracteres simples.

Parâmetro	Tipo	Descrição
dns_server	string	O endereço do servidor DNS, que 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 e ANY.
expect_value	string	A lista de valores esperados separados por caracteres de espaço em branco.
match_rule	string	A relação entre a lista de valores esperados e a lista DNS. Se a relação especificada não for atendida, a detecção falhará. String vazia ou IN_DNS: A lista de valores esperados é um subconjunto da lista DNS. DNS_IN: A lista DNS é um subconjunto da lista de valores esperados. EQUAL: A lista DNS é igual à lista de valores esperados. ANY: A lista DNS e a lista de valores esperados têm uma interseção não vazia.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
Code	string	O código de status. Nota Um valor 200 indica sucesso.	200
Message	string	A mensagem retornada.	successful.
RequestId	string	O ID da solicitação.	68192f5d-0d45-4b98-9724-892813f86c71
Success	string	Indica se a operação foi bem-sucedida. Valores válidos: true: Bem-sucedido. false: Falha.	true.
CreateResultList	array<object>	A lista de resultados da criação da tarefa de monitoramento sintético única.
	object	A lista de resultados da criação da tarefa de monitoramento sintético única.
TaskId	string	O ID da tarefa de monitoramento sintético.	2c8dbdf9-a3ab-46a1-85a4-f094965e****
TaskName	string	O nome da tarefa de monitoramento sintético.	task1

Exemplos

Resposta de sucesso

JSON formato

{
  "Code": "200",
  "Message": "successful",
  "RequestId": "68192f5d-0d45-4b98-9724-892813f86c71",
  "Success": "true",
  "CreateResultList": [
    {
      "TaskId": "2c8dbdf9-a3ab-46a1-85a4-f094965e****",
      "TaskName": "task1"
    }
  ]
}

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	OperatorCityInvalid	Operator City invalid
400	NameRepeat	Task name repeat
400	CreateAlarmError	Create alarm error
400	NameNotExists	Task name not exists
400	Illegal Task Name	The task name of the sitemonitor task is illegal.	O nome da tarefa de monitoramento de site é inválido.
401	AccessDeniedException	You donot have sufficient access to perform this action.
500	InternalError	%s
402	LimitExceeded	The quota for this customer had been reached.
403	%s	%s
403	Forbidden	%s
503	%s	%s
406	ExceedingQuota	Exceeding quota limits.	O número de tarefas excede a cota.
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.