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

Consulta tarefas de monitoramento de sites.

Este tópico apresenta um exemplo de consulta a todas as tarefas de monitoramento de sites da sua conta Alibaba Cloud. Neste exemplo, o resultado indica que a conta possui uma tarefa de monitoramento de sites chamada HanZhou_ECS2.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos chamar esta operação no OpenAPI Explorer. O OpenAPI Explorer gera dinamicamente o código de exemplo da operação para diferentes SDKs.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	DescribeSiteMonitorList	A operação a ser executada. Defina o valor como DescribeSiteMonitorList.
TaskId	String	Não	a1ecd34a-8157-44d9-b060-14950837****	O ID da tarefa de monitoramento de sites.
TaskType	String	Não	HTTP	Protocolo usado pela tarefa de monitoramento de sites. Valores válidos: HTTP, PING, TCP, UDP, DNS, SMTP, POP3 e FTP.
Keyword	String	Não	site	Palavra-chave para correspondência. Nota É possível pesquisar tarefas por nome ou endereço. A pesquisa aproximada é suportada.
Page	Integer	Não	1	Número da página. Valor padrão: 1.
PageSize	Integer	Não	10	Número de entradas por página. Valor padrão: 10.
TaskState	String	Não	1	Status da tarefa. Valores válidos: 1: Tarefa ativada. 2: Tarefa desativada.

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
RequestId	String	A80DB41C-AF6C-50E1-ADB5-66DCBA3D266B	ID da solicitação.
Success	String	true	Indica se a solicitação foi bem-sucedida. Valores válidos: true false
Code	String	200	Código de status. Nota O código de status 200 indica que a solicitação foi bem-sucedida.
Message	String	successful	Mensagem retornada.
PageNumber	Integer	1	Número da página.
PageSize	Integer	10	Número de entradas por página.
TotalCount	Integer	1	Número total de entradas retornadas.
SiteMonitors	Array of SiteMonitor		Tarefas de monitoramento de sites retornadas.
SiteMonitor
TaskType	String	TCP	Protocolo usado pela tarefa de monitoramento de sites. Valores válidos: HTTP, PING, TCP, UDP, DNS, SMTP, POP3 e FTP.
UpdateTime	String	2022-03-08 17:14:31	Hora da última atualização da tarefa de monitoramento de sites.
Interval	String	1	Intervalo de envio das solicitações de detecção. Unidade: minutos.
TaskState	String	1	Status da tarefa. Valores válidos: 1: Tarefa ativada. 2: Tarefa desativada.
CreateTime	String	2021-11-01 11:05:18	Hora de criação da tarefa de monitoramento de sites.
TaskName	String	New site monitoring task	Nome da tarefa de monitoramento de sites.
Address	String	https://aliyun.com	URL ou endereço IP monitorado pela tarefa de monitoramento de sites.
TaskId	String	f5783760-1b39-4b6b-80e8-453d962a****	ID da tarefa de monitoramento de sites.
OptionsJson	Object		Opções estendidas da tarefa de monitoramento de sites. As opções variam conforme o protocolo especificado. Para obter mais informações, consulte CreateSiteMonitor.
password	String	123****	Senha do protocolo SMTP, POP3 ou FTP.
request_format	String	hex	Formato da solicitação HTTP. Valores válidos: hex: hexadecimal txt: texto
response_content	String	cf0f85	Resposta à solicitação HTTP. Formato hexadecimal: Se o conteúdo da solicitação for uma string de bytes não representável em caracteres imprimíveis, converta-a para caracteres imprimíveis no formato hexadecimal. Nessa conversão, cada byte transforma-se em dois caracteres hexadecimais. Por exemplo, (byte)1 converte-se em `01` e (byte)27 converte-se em `1B`. Caso o conteúdo da solicitação seja um array binário no formato Java, como `{(byte)1, (byte)27}`, converta o array binário para `011b` ou `011B`. Os caracteres hexadecimais não diferenciam maiúsculas de minúsculas nas tarefas de monitoramento de sites. Insira `011B` no conteúdo da solicitação e defina o parâmetro request_format como hex. Formato de texto: Texto comum refere-se a strings compostas por caracteres imprimíveis.
failure_rate	Float	0,5	Taxa de perda de pacotes. Nota Este parâmetro é retornado apenas se o parâmetro TaskType estiver definido como PING.
time_out	Long	3000	Tempo limite. Unidade: milissegundos.
header	String	testKey:testValue	Cabeçalho da solicitação HTTP. Um cabeçalho HTTP é um par chave-valor no qual a chave e o valor são separados por dois pontos (:). O formato é `key1:value1`. Cada cabeçalho HTTP ocupa uma linha.
cookie	String	lang=en	Cookie da solicitação HTTP.
port	Integer	80	Número da porta do protocolo TCP, UDP, SMTP ou POP3.
ping_num	Integer	20	Número de saltos para o protocolo PING.
authentication	Integer	1	Indica se o recurso de autenticação de segurança está ativado. Valores válidos: 0: Recurso ativado. 1: Recurso desativado.
http_method	String	get	Método de solicitação HTTP. Valores válidos: get post head
match_rule	Integer	0	Indica se a regra de alerta está incluída. Valores válidos: 0: Regra de alerta incluída. 1: Regra de alerta não incluída.
dns_match_rule	String	IN_DNS	Relação entre a lista de aliases ou endereços IP esperados e a lista de resultados DNS. Valores válidos: 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.
request_content	String	cf0f85	Conteúdo da solicitação HTTP.
username	String	testUser	Nome de usuário do protocolo FTP, SMTP ou POP3.
response_format	String	hex	Formato da resposta HTTP. Valores válidos: hex: hexadecimal txt: texto
dns_type	String	A	Tipo de registro DNS. Este parâmetro é retornado apenas se o parâmetro TaskType estiver definido como DNS. Valores válidos: A (padrão): registro que especifica um endereço IP relacionado ao nome de host ou nome de domínio especificado. CNAME: registro que mapeia vários nomes de domínio para um único nome de domínio. NS: registro que especifica um servidor DNS usado para analisar nomes de domínio. MX: registro que vincula nomes de domínio ao endereço de um servidor de e-mail. TXT: registro que armazena informações de texto de nomes de host ou nomes de domínio. O texto deve ter de 1 a 512 bytes de comprimento. O registro TXT serve como um registro Sender Policy Framework (SPF) para combater spam. AAAA: registro que mapeia um nome de domínio ao endereço IPv6 relevante.
dns_server	String	192.168.XX.XX	Nome de domínio ou endereço IP do servidor DNS.
enable_operator_dns	Boolean	true	Indica se o servidor DNS da operadora é utilizado. true (padrão): Servidor DNS da operadora utilizado. false: Servidor DNS da operadora não utilizado. Usa-se o servidor DNS padrão ou o servidor DNS especificado.
attempts	Long	3	Número de tentativas após uma falha de DNS.
protocol	String	udp	Tipo de protocolo da detecção DNS. Valores válidos: udp (padrão) tcp tcp-tls
proxy_protocol	Boolean	false	Indica se o protocolo PROXY está ativado. Valores válidos: false (padrão): Protocolo PROXY desativado. true: Protocolo PROXY ativado.
acceptable_response_code	String	400	Código de status aceitável. Nota Recomendamos configurar asserções.
isBase64Encode	String	false	Indica se a senha é decodificada usando o algoritmo Base64. Valores válidos: true: Senha decodificada usando o algoritmo Base64. false (padrão): Senha não decodificada usando o algoritmo Base64.
cert_verify	Boolean	false	Indica se o certificado é verificado. Valores válidos: false (padrão): Certificado não verificado. true: Certificado verificado.
unfollow_redirect	Boolean	false	Indica se os redirecionamentos são seguidos quando o código de status 301 ou 302 é retornado. Valores válidos: true: Redirecionamentos não seguidos. false (padrão): Redirecionamentos seguidos.
diagnosis_mtr	Boolean	false	Indica se o MTR é usado automaticamente para diagnosticar problemas de rede em caso de falha na tarefa. Valores válidos: false (padrão): MTR não usado automaticamente para diagnosticar problemas de rede em caso de falha na tarefa. true: MTR usado automaticamente para diagnosticar problemas de rede em caso de falha na tarefa.
diagnosis_ping	Boolean	false	Indica se solicitações ping são enviadas automaticamente para detectar latência de rede em caso de falha na tarefa de detecção. Valores válidos: false (padrão): Solicitações ping não enviadas automaticamente para detectar latência de rede em caso de falha na tarefa de detecção. true: Solicitações ping enviadas automaticamente para detectar latência de rede em caso de falha na tarefa de detecção.
retry_delay	Integer	1	Número de vezes que uma solicitação de detecção com falha é repetida.
assertions	Array of assertions		Asserções.
assertions
property	String	json path	Caminho de análise da asserção. Se o tipo de asserção for `body_json`, o caminho será `json path`. Se o tipo de asserção for `body_xml`, o caminho será `xml path`.
type	String	response_time	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 HTTP atende às expectativas. header: verifica se os campos no cabeçalho da resposta atendem às expectativas. body_text: verifica se o conteúdo no corpo da resposta atende às expectativas usando correspondência de texto. body_json: verifica se o conteúdo no corpo da resposta atende às expectativas usando análise JSON (JSONPath). body_xml: verifica se o conteúdo no corpo da resposta atende às expectativas usando análise XML (XPath).
operator	String	lessThan	Operador de comparação da asserção. Valores válidos: contains: contém doesNotContain: não contém matches: corresponde a expressões regulares doesNotMatch: não corresponde a expressões regulares is: igual a um valor numérico ou corresponde a um caractere isNot: diferente de lessThan: menor que moreThan: maior que
target	String	1000	Valor numérico ou caractere usado para correspondência.
AgentGroup	String	PC	Tipo de sonda. Valores válidos: PC MOBILE

Exemplos

Solicitações de exemplo

http(s)://[Endpoint]/?Action=DescribeSiteMonitorList
&<Common request parameters>

Respostas de sucesso de exemplo

Formato XML

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

<DescribeSiteMonitorListResponse>
    <TotalCount>1</TotalCount>
    <RequestId>A80DB41C-AF6C-50E1-ADB5-66DCBA3D266B</RequestId>
    <Message>successful</Message>
    <PageSize>10</PageSize>
    <PageNumber>1</PageNumber>
    <Code>200</Code>
    <Success>true</Success>
    <SiteMonitors>
        <SiteMonitor>
            <TaskId>f5783760-1b39-4b6b-80e8-453d962a****</TaskId>
            <Address>https://aliyun.com</Address>
            <EndTime></EndTime>
            <TaskName>test123</TaskName>
            <OptionsJson>
                <response_content></response_content>
                <request_format>hex</request_format>
                <response_format>hex</response_format>
                <request_content>cf0f85</request_content>
                <port>80</port>
            </OptionsJson>
            <TaskType>TCP</TaskType>
            <CreateTime>2021-11-01 11:05:18</CreateTime>
            <UpdateTime>2022-03-08 17:14:31</UpdateTime>
            <TaskState>1</TaskState>
            <Interval>1</Interval>
        </SiteMonitor>
    </SiteMonitors>
</DescribeSiteMonitorListResponse>

Formato JSON

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

{
  "TotalCount" : 1,
  "RequestId" : "A80DB41C-AF6C-50E1-ADB5-66DCBA3D266B",
  "Message" : "successful",
  "PageSize" : 10,
  "PageNumber" : 1,
  "Code" : "200",
  "Success" : true,
  "SiteMonitors" : {
    "SiteMonitor" : [ {
      "TaskId" : "f5783760-1b39-4b6b-80e8-453d962a****",
      "Address" : "https://aliyun.com",
      "EndTime" : "",
      "TaskName" : "test123",
      "OptionsJson" : {
        "response_content" : "",
        "request_format" : "hex",
        "response_format" : "hex",
        "request_content" : "cf0f85",
        "port" : 80
      },
      "TaskType" : "TCP",
      "CreateTime" : "2021-11-01 11:05:18",
      "UpdateTime" : "2022-03-08 17:14:31",
      "TaskState" : 1,
      "Interval" : 1
    } ]
  }
}

Códigos de erro

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