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

Este tópico apresenta um exemplo de consulta dos detalhes de uma tarefa de monitoramento de site com o ID cc641dff-c19d-45f3-ad0a-818a0c4f****. O resultado indica que o nome da tarefa é test123, o endereço monitorado é https://aliyun.com e a operadora é Alibaba.

Depuração

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

Parâmetros de solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	DescribeSiteMonitorAttribute	Operação a ser executada. Defina o valor como DescribeSiteMonitorAttribute.
TaskId	String	Sim	cc641dff-c19d-45f3-ad0a-818a0c4f****	ID da tarefa de monitoramento de site.
IncludeAlert	Boolean	Não	false	Especifique se as informações das regras de alerta configuradas para a tarefa de monitoramento de site devem ser retornadas. Valores válidos: true: Retorna as informações das regras de alerta configuradas para a tarefa de monitoramento de site. false: Não retorna as informações das regras de alerta configuradas para a tarefa de monitoramento de site. Valor padrão: false.

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	D17DF650-7EBD-54D0-903A-1D4E624D7402	ID da solicitação.
Code	String	200	Código de status HTTP. Nota O código de status 200 indica que a chamada foi bem-sucedida.
Success	Boolean	true	Indica se a chamada foi bem-sucedida. Valores válidos: true: Chamada bem-sucedida. false: Falha na chamada.
SiteMonitors	Struct		Detalhes da tarefa de monitoramento de site.
Address	String	https://aliyun.com	Endereço monitorado pela tarefa de monitoramento de site.
Interval	String	1	Intervalo de execução da tarefa de monitoramento de site. Unidade: minutos. Valores válidos: 1, 5, 15, 30 e 60.
IspCities	Array of IspCity		Informações dos pontos de detecção, incluindo as operadoras responsáveis e as cidades onde estão localizados.
IspCity
City	String	738	ID da cidade.
CityName	String	Beijing	Nome da cidade.
Isp	String	465	ID da operadora.
IspName	String	Alibaba	Nome da operadora.
OptionJson	Struct		Opções estendidas da tarefa de monitoramento de site. Variam conforme o protocolo especificado. Para obter mais informações, consulte CreateSiteMonitor.
attempts	Long	3	Número de novas tentativas após falha de DNS.
authentication	Integer	1	Indica se a autenticação de segurança está ativada. Valores válidos: 0: Autenticação de segurança desativada. 1: Autenticação de segurança ativada.
cookie	String	lang=en	Cookie da solicitação HTTP.
dns_match_rule	String	IN_DNS	Relação entre a lista de aliases ou endereços IP esperados e a lista de resultados de DNS. Valores válidos: IN_DNS: A lista de valores esperados é um subconjunto da lista de resultados de DNS. DNS_IN: A lista de resultados de DNS é um subconjunto da lista de valores esperados. EQUAL: A lista de resultados de DNS é igual à lista de valores esperados. ANY: Há interseção entre a lista de resultados de DNS e a lista de valores esperados.
dns_server	String	192.168.XX.XX	Endereço IP do servidor DNS. Nota Retornado apenas se o parâmetro TaskType estiver definido como DNS.
dns_type	String	A	Tipo de registro DNS. Retornado apenas se o parâmetro TaskType estiver definido como DNS. Valores válidos: A: Nome padrão. Indica um registro que especifica um endereço IP associado ao nome de host ou 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 resolver 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 textuais de nomes de host ou domínios. O texto deve ter de 1 a 512 bytes. Serve como registro Sender Policy Framework (SPF) para combate a spam.
expect_value	String	dns_server	Nome de domínio ou alias a ser resolvido. Nota Retornado apenas se o parâmetro TaskType estiver definido como DNS.
failure_rate	Float	0,4	Taxa de perda de pacotes. Nota Retornado apenas se o parâmetro TaskType estiver definido como PING.
header	String	testKey:testValue	Cabeçalho da solicitação HTTP.
http_method	String	get	Método de solicitação HTTP. Valores válidos: get post head
isBase64Encode	String	true	Indica se o valor do parâmetro `password` está codificado em Base64. true: Valor do parâmetro password codificado em Base64. false: Valor do parâmetro password não codificado em Base64.
match_rule	Integer	1	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.
password	String	123****	Senha do protocolo SMTP, POP3 ou FTP.
ping_num	Integer	29	Heartbeat do protocolo PING.
port	Integer	110	Número da porta do protocolo TCP, UDP, SMTP ou POP3.
protocol	String	TCP	Protocolo usado para enviar a solicitação.
request_content	String	aa=bb	Conteúdo da solicitação HTTP.
request_format	String	txt	Formato da solicitação HTTP. Valores válidos: hex: hexadecimal txt: texto
response_content	String	txt	Resposta à solicitação HTTP.
response_format	String	txt	Formato da resposta. Valores válidos: hex: hexadecimal txt: texto
time_out	Long	3	Tempo limite. Unidade: milissegundos.
username	String	testUser	Nome de usuário do protocolo FTP, SMTP ou POP3.
TaskId	String	cc641dff-c19d-45f3-ad0a-818a0c4f****	ID da tarefa de monitoramento de site.
TaskName	String	test123	Nome da tarefa de monitoramento de site.
TaskState	String	1	Status da tarefa de monitoramento de site. Valores válidos: 1: Tarefa ativada. 2: Tarefa desativada.
TaskType	String	HTTP	Protocolo usado pela tarefa de monitoramento de site. Valores válidos: HTTP, HTTPS, PING, TCP, UDP, DNS, SMTP, POP3 e FTP.
MetricRules	Array of MetricRule		Informações das regras de alerta configuradas para a tarefa de monitoramento de site.
MetricRule
ActionEnable	String	true	Indica se a regra de alerta está ativada. Valores válidos: true: Regra de alerta ativada. false: Regra de alerta desativada.
AlarmActions	String	CloudMonitor	Grupo de contatos de alerta destinatário das notificações.
ComparisonOperator	String	GreaterThanYesterday	Operador de comparação usado na regra de alerta. Valores válidos: `>=` `>` `<=` `<` `=` `!=` GreaterThanYesterday: maior que o valor da métrica no mesmo horário ontem LessThanYesterday: menor que o valor da métrica no mesmo horário ontem GreaterThanLastWeek: maior que o valor da métrica no mesmo horário na semana passada LessThanLastWeek: menor que o valor da métrica no mesmo horário na semana passada GreaterThanLastPeriod: maior que o valor da métrica no último ciclo de monitoramento LessThanLastPeriod: menor que o valor da métrica no último ciclo de monitoramento
Dimensions	String	[{"taskId": "cc641dff-c19d-45f3-ad0a-818a0c4f****" }]	Dimensão da regra de alerta.
EvaluationCount	String	3	Número consecutivo de medições do valor da métrica antes do acionamento do alerta.
Expression	String	$Availability=30	Expressão usada para acionar alertas.
Level	String	2	Gravidade do alerta. Valores válidos: 1: crítico 2: aviso 3: informação
MetricName	String	Availability	Nome da métrica.
Namespace	String	acs_networkmonitor	Namespace do serviço de nuvem.
OkActions	String	[ "CloudMonitor"]	Grupos de contatos de alerta destinatários das notificações.
Period	String	15s	Intervalo de consulta dos dados de monitoramento. Corresponde ao intervalo de relatório dos dados da métrica. Unidade: segundos. Nota Se você especificar um período estatístico para a regra de alerta, os dados brutos serão consultados com base nesse período.
RuleId	String	bf071ae_7b7aec3817b0fdf****	ID da regra de alerta.
RuleName	String	rule1	Nome da regra de alerta.
StateValue	String	OK	Status do alerta. Valores válidos: OK: normal. ALARM: Alerta acionado.
Statistics	String	Availability	Método estatístico da regra de alerta. Valores válidos: Availability: porcentagem de pontos de detecção disponíveis AvailableNumber: número de pontos de detecção disponíveis ErrorCodeMaximum: código de status para um alerta ErrorCodeMinimum: todos os códigos de status para um conjunto de alertas Average: tempo de resposta
Threshold	String	30	Limiar de alerta.
Message	String	successful	Mensagem retornada.

Exemplos

Solicitações de exemplo

http(s)://[Endpoint]/?Action=DescribeSiteMonitorAttribute
&TaskId=cc641dff-c19d-45f3-ad0a-818a0c4f****
&<Common request parameters>

Respostas de sucesso de exemplo

Formato XML

<DescribeSiteMonitorAttributeResponse>
	  <MetricRules>
		    <MetricRule>
			      <ComparisonOperator>GreaterThanYesterday</ComparisonOperator>
			      <RuleId>bf071ae_7b7aec3817b0fdf****</RuleId>
			      <Period>15s</Period>
			      <EvaluationCount>3</EvaluationCount>
			      <Dimensions>
				        <taskId>cc641dff-c19d-45f3-ad0a-818a0c4f****</taskId>
			      </Dimensions>
			      <Statistics>Availability</Statistics>
			      <Namespace>acs_networkmonitor</Namespace>
			      <AlarmActions>CloudMonitor</AlarmActions>
			      <MetricName>Availability</MetricName>
			      <OkActions>CloudMonitor</OkActions>
			      <Expression>$Availability=30</Expression>
			      <ActionEnable>true</ActionEnable>
			      <StateValue>OK</StateValue>
			      <Level>2</Level>
			      <RuleName>rule1</RuleName>
			      <Threshold>30</Threshold>
		    </MetricRule>
	  </MetricRules>
	  <Message>successful</Message>
	  <RequestId>D17DF650-7EBD-54D0-903A-1D4E624D7402</RequestId>
	  <Code>200</Code>
	  <Success>true</Success>
	  <SiteMonitors>
		    <OptionJson>
			      <time_out>30000</time_out>
			      <http_method>get</http_method>
		    </OptionJson>
		    <TaskId>cc641dff-c19d-45f3-ad0a-818a0c4f****</TaskId>
		    <Address>https://aliyun.com</Address>
		    <TaskName>test123</TaskName>
		    <TaskType>HTTP</TaskType>
		    <IspCities>
			      <IspCity>
				        <IspName>Alibaba</IspName>
				        <Isp>465</Isp>
				        <CityName>Beijing</CityName>
				        <City>738</City>
			      </IspCity>
		    </IspCities>
		    <TaskState>1</TaskState>
		    <Interval>1</Interval>
	  </SiteMonitors>
</DescribeSiteMonitorAttributeResponse>

Formato JSON

{
    "MetricRules": {
        "MetricRule": [
            {
                "ComparisonOperator": "GreaterThanYesterday",
                "RuleId": "bf071ae_7b7aec3817b0fdf****",
                "Period": "15s",
                "EvaluationCount": 3,
                "Dimensions": [
                    {
                        "taskId": "cc641dff-c19d-45f3-ad0a-818a0c4f****"
                    }
                ],
                "Statistics": "Availability",
                "Namespace": "acs_networkmonitor",
                "AlarmActions": [
                    "CloudMonitor"
                ],
                "MetricName": "Availability",
                "OkActions": [
                    "CloudMonitor"
                ],
                "Expression": "$Availability=30",
                "ActionEnable": true,
                "StateValue": "OK",
                "Level": 2,
                "RuleName": "rule1",
                "Threshold": "30"
            }
        ]
    },
    "Message": "successful",
    "RequestId": "D17DF650-7EBD-54D0-903A-1D4E624D7402",
    "Code": "200",
    "Success": true,
    "SiteMonitors": {
        "OptionJson": {
            "time_out": 30000,
            "http_method": "get"
        },
        "TaskId": "cc641dff-c19d-45f3-ad0a-818a0c4f****",
        "Address": "https://aliyun.com",
        "TaskName": "test123",
        "TaskType": "HTTP",
        "IspCities": {
            "IspCity": [
                {
                    "IspName": "Alibaba",
                    "Isp": "465",
                    "CityName": "Beijing",
                    "City": "738"
                }
            ]
        },
        "TaskState": 1,
        "Interval": 1
    }
}

Códigos de erro

Para obter uma lista de códigos de erro, visite o API Error Center.