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

Consulta a lista de tarefas de monitoramento de sites chamando a operação DescribeSiteMonitorList.

Descrição da operação

Este tópico fornece um exemplo de como consultar a lista de tarefas de monitoramento de sites da conta atual. A resposta mostra que a conta atual possui um registro de monitoramento de sites chamado HanZhou_ECS2.

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

get

*Todos os recursos.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
TaskId	string	Não	O ID da tarefa de monitoramento de sites.	a1ecd34a-8157-44d9-b060-14950837****
TaskType	string	Não	O tipo da tarefa de monitoramento de sites. O CloudMonitor oferece suporte aos seguintes tipos: HTTP, PING, TCP, UDP, DNS, SMTP, POP3 e FTP.	HTTP
Keyword	string	Não	A palavra-chave usada para pesquisar tarefas de monitoramento de sites. Nota Há suporte para correspondência aproximada com base no nome ou no endereço da tarefa.	site
Page	integer	Não	O número da página. Valor padrão: 1.	1
PageSize	integer	Não	O número de entradas por página. Valor padrão: 10.	10
TaskState	string	Não	O status da tarefa. Valores válidos: 1: Normal. 2: Desativada.	1
AgentGroup	string	Não	O tipo de nós de monitoramento usados pela tarefa. Valores válidos: PC: Pontos de detecção baseados em PC. MOBILE: Pontos de detecção baseados em dispositivos móveis. FC: Pontos de detecção internos. Valores válidos: PC : Pontos de detecção baseados em PC. FC : Pontos de detecção internos. MOBILE : Pontos de detecção baseados em dispositivos móveis.	PC

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

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Nenhum.
RequestId	string	O ID da solicitação.	A80DB41C-AF6C-50E1-ADB5-66DCBA3D266B
Success	string	Indica se a operação foi bem-sucedida. Valores válidos: true: Bem-sucedida. false: Falha.	true
Code	string	O código de status. Nota 200 indica sucesso.	200
Message	string	A mensagem retornada.	successful
PageNumber	integer	O número da página.	1
PageSize	integer	O número de entradas por página.	10
TotalCount	integer	O número total de entradas.	1
SiteMonitors	object
SiteMonitor	array<object>	A lista de tarefas de monitoramento de sites.
	array<object>	Nenhum.
TaskType	string	O tipo da tarefa de monitoramento de sites. O CloudMonitor oferece suporte aos seguintes tipos: HTTP, PING, TCP, UDP, DNS, SMTP, POP3 e FTP.	TCP
UpdateTime	string	A hora da última atualização da tarefa de monitoramento de sites, no formato AAAA-MM-DD HH:mm:ss.	2022-03-08 17:14:31
Interval	string	O intervalo de monitoramento. Unidade: minutos.	1
TaskState	string	O status da tarefa. Valores válidos: 1: Normal. 2: Desativada.	1
CreateTime	string	A hora em que a tarefa foi criada, no formato AAAA-MM-DD HH:mm:ss.	2021-11-01 11:05:18
TaskName	string	O nome da tarefa de monitoramento de sites.	Nova tarefa de monitoramento
Address	string	O URL ou endereço IP monitorado pela tarefa.	https://aliyun.com
TaskId	string	O ID da tarefa de monitoramento de sites.	f5783760-1b39-4b6b-80e8-453d962a****
OptionsJson	object	As opções estendidas. Cada tipo de monitoramento possui opções estendidas diferentes. Para mais informações, consulte CreateSiteMonitor.
password	string	A senha para o tipo de monitoramento SMTP, POP3 ou FTP.	123****
request_format	string	O formato do conteúdo da solicitação HTTP. Valores válidos: hex: formato hexadecimal. txt: formato de texto.	hex
response_content	string	O conteúdo da resposta correspondente. Formato hexadecimal: quando o conteúdo da solicitação é uma string de bytes que não pode ser representada por caracteres visíveis, você pode converter a string de bytes em uma string hexadecimal. A regra de conversão é a seguinte: um byte é convertido em uma string hexadecimal de dois caracteres. Por exemplo, 1 byte (1B) é convertido em `01` em hexadecimal, e 27 bytes (27B) são convertidos em `1B` em hexadecimal. A matriz binária (no formato Java) `{(byte)1, (byte)27}` é convertida em `011b` ou `011B` em hexadecimal. O monitoramento de sites não diferencia maiúsculas de minúsculas para valores hexadecimais. Insira a string `011B` no conteúdo da solicitação e selecione o formato hexadecimal para o formato do conteúdo da solicitação. Formato de texto: texto simples refere-se a uma string composta por caracteres visíveis.	cf0f85
failure_rate	number	A taxa de perda de pacotes. Nota Este parâmetro se aplica apenas ao tipo de monitoramento PING.	0.5
time_out	integer	O período de tempo limite. Unidade: milissegundos.	3000
header	string	O cabeçalho da solicitação HTTP. O formato é `chave1:valor1`, com quebras de linha separando as entradas.	testKey:testValue
cookie	string	O texto do cookie para a solicitação HTTP.	lang=en
port	integer	A porta para o tipo de monitoramento TCP, UDP, SMTP ou POP3.	80
ping_num	integer	O número de tentativas de PING.	20
authentication	integer	Especifica se a autenticação de segurança deve ser ativada. Valores válidos: 0: Ativada. 1: Desativada.	1
http_method	string	O método de solicitação HTTP. Valores válidos: get post head	get
match_rule	integer	Especifica se as regras de alerta estão incluídas. Valores válidos: 0: Incluídas. 1: Não incluídas.	0
dns_match_rule	string	A regra de correspondência de DNS. Valores válidos: IN_DNS: Todos os aliases ou endereços IP esperados estão incluídos na resposta de DNS. DNS_IN: Todas as respostas de DNS estão incluídas nos aliases ou endereços IP esperados. EQUAL: A resposta de DNS corresponde exatamente aos aliases ou endereços IP esperados. ANY: A resposta de DNS e os aliases ou endereços IP esperados possuem uma interseção.	IN_DNS
request_content	string	O conteúdo da solicitação HTTP.	cf0f85
username	string	O nome de usuário para FTP, SMTP ou POP3.	testUser
response_format	string	O formato do conteúdo da resposta HTTP. Valores válidos: hex: formato hexadecimal. txt: formato de texto.	hex
dns_type	string	O tipo de resolução de DNS. Este parâmetro se aplica apenas ao tipo de monitoramento DNS. Valores válidos: A (padrão): Especifica o endereço IP correspondente ao nome do host ou nome de domínio. CNAME: Mapeia vários nomes de domínio para outro nome de domínio. NS: Especifica o servidor DNS que resolve o nome de domínio. MX: Aponta o nome de domínio para um endereço de servidor de e-mail. TXT: A descrição do nome do host ou nome de domínio. O comprimento do texto é limitado a 512 bytes e é normalmente usado para registros SPF (Sender Policy Framework) para fins antispam. AAAA: O registro DNS que resolve um nome de domínio para um endereço IPv6.	A
dns_server	string	O nome de domínio ou endereço IP do servidor DNS especificado.	192.168.XX.XX
enable_operator_dns	boolean	Especifica se o DNS da operadora deve ser usado. Valores válidos: true (padrão): Usa o DNS da operadora. false: Não usa o DNS da operadora. Usa o DNS padrão ou o DNS do servidor especificado.	true
attempts	integer	O número de novas tentativas após uma falha de DNS.	3
protocol	string	O tipo de protocolo DNS. Valores válidos: udp (padrão) tcp tcp-tls	udp
proxy_protocol	boolean	Especifica se o ProxyProtocol deve ser ativado. Valores válidos: false (padrão): Desativa o ProxyProtocol. true: Ativa o ProxyProtocol.	false
acceptable_response_code	string	Os códigos de status aceitáveis. Nota Use configurações de asserção em seu lugar.	400
isBase64Encode	string	Especifica se a senha deve ser decodificada e armazenada usando Base64. Valores válidos: true: Decodifica e armazena a senha usando Base64. false (padrão): Não decodifica e armazena a senha usando Base64.	false
cert_verify	boolean	Especifica se o certificado deve ser verificado. Valores válidos: false (padrão): Ignora a verificação do certificado. true: Verifica o certificado.	false
unfollow_redirect	boolean	Especifica se os redirecionamentos devem ser seguidos quando um código de status 301 ou 302 é retornado. Valores válidos: true: Não segue redirecionamentos. false (padrão): Segue redirecionamentos.	false
diagnosis_mtr	boolean	Especifica se o diagnóstico de rede MTR automático deve ser ativado após uma falha de tarefa. Valores válidos: false (padrão): Desativa o diagnóstico de rede MTR automático. true: Ativa o diagnóstico de rede MTR automático.	false
diagnosis_ping	boolean	Especifica se a detecção automática de latência de rede Ping deve ser ativada após uma falha de tarefa de monitoramento. Valores válidos: false (padrão): Desativada. true: Ativada.	false
retry_delay	integer	O número de novas tentativas após uma falha de monitoramento.	1
assertions	object
assertions	array<object>	O grupo de configurações de asserção.
	object	O grupo de configurações de asserção.
property	string	O caminho de análise para o conteúdo da asserção. Se o tipo de asserção for `body_json`, o caminho será um `json path`. Se o tipo de asserção for `body_xml`, o caminho será um `xml path`.	json path
type	string	O tipo de asserção. Valores válidos: response_time: Verifica se o tempo de resposta atende às expectativas. status_code: Verifica se o código de status da resposta HTTP atende às expectativas. header: Verifica se um campo no cabeçalho da resposta atende às expectativas. body_text: Verifica se o conteúdo do corpo da resposta atende às expectativas por meio de correspondência de string de texto. body_json: Verifica se o conteúdo do corpo da resposta atende às expectativas por meio de análise JSON (JSON Path). body_xml: Verifica se o conteúdo do corpo da resposta atende às expectativas por meio de análise XML (XPath).	response_time
operator	string	O operador de comparação de asserção. Valores válidos: contains: contém. doesNotContain: não contém. matches: corresponde a uma expressão regular. doesNotMatch: não corresponde a uma expressão regular. is: igual a (numérico ou string). isNot: diferente de. lessThan: menor que. moreThan: maior que.	lessThan
target	string	O valor ou string de destino para comparação de asserção.	1000
AgentGroup	string	O tipo de sonda. Valores válidos: PC: Baseado em PC. MOBILE: Baseado em dispositivos móveis.	PC

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "A80DB41C-AF6C-50E1-ADB5-66DCBA3D266B",
  "Success": "true",
  "Code": "200",
  "Message": "successful",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 1,
  "SiteMonitors": {
    "SiteMonitor": [
      {
        "TaskType": "TCP",
        "UpdateTime": "2022-03-08 17:14:31",
        "Interval": "1",
        "TaskState": "1",
        "CreateTime": "2021-11-01 11:05:18",
        "TaskName": "新的探测任务",
        "Address": "https://aliyun.com",
        "TaskId": "f5783760-1b39-4b6b-80e8-453d962a****",
        "OptionsJson": {
          "password": "123****",
          "request_format": "hex",
          "response_content": "cf0f85",
          "failure_rate": 0.5,
          "time_out": 3000,
          "header": "testKey:testValue",
          "cookie": "lang=en",
          "port": 80,
          "ping_num": 20,
          "authentication": 1,
          "http_method": "get",
          "match_rule": 0,
          "dns_match_rule": "IN_DNS",
          "request_content": "cf0f85",
          "username": "testUser",
          "response_format": "hex",
          "dns_type": "A",
          "dns_server": "192.168.XX.XX",
          "enable_operator_dns": true,
          "attempts": 3,
          "protocol": "udp",
          "proxy_protocol": false,
          "acceptable_response_code": "400",
          "isBase64Encode": "false",
          "cert_verify": false,
          "unfollow_redirect": false,
          "diagnosis_mtr": false,
          "diagnosis_ping": false,
          "retry_delay": 1,
          "assertions": {
            "assertions": [
              {
                "property": "json path",
                "type": "response_time",
                "operator": "lessThan",
                "target": "1000"
              }
            ]
          }
        },
        "AgentGroup": "PC"
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidQueryParameter	%s
401	AccessDeniedException	You donot have sufficient access to perform this action.
500	%s	%s
500	InternalError	%s
402	LimitExceeded	The quota for this customer had been reached.
403	Forbidden	You are not authorized to operate the specified resource.	Você não tem as permissões necessárias. Use o RAM para conceder as permissões.
503	%s	%s
406	ExceedingQuota	Exceeding quota limits.	Você excedeu a cota de tarefas.
429	ThrottlingException	The request was denied due to request throttling.
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.