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

Consulta a lista de tarefas de monitoramento de disponibilidade.

Descrição da operação

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

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

get

*全部资源

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Id	integer	Não	O ID da tarefa de monitoramento de disponibilidade.	123456
Ids	string	Não	Os IDs de múltiplas tarefas de monitoramento de disponibilidade. Separe vários IDs com vírgulas (,).	123456,345678
TaskName	string	Não	O nome da tarefa de monitoramento de disponibilidade.	ecs_instance
PageNumber	integer	Não	O número da página. Valor mínimo: 1. Valor padrão: 1.	1
PageSize	integer	Não	O número de entradas por página. Valor mínimo: 1. Valor padrão: 10.	10
GroupId	integer	Não	O ID do grupo de aplicativos.	12345

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

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
Code	string	O código de status HTTP. Nota O valor 200 indica sucesso.	200
Message	string	A mensagem de erro.	The specified resource is not found.
RequestId	string	O ID da solicitação.	4A288E86-45C3-4858-9DB0-6D85B10BD92A
Total	integer	O número total de registros.	1
Success	boolean	Indica se a operação foi bem-sucedida. Valores válidos: true: A operação foi bem-sucedida. false: A operação falhou.	true
TaskList	object
NodeTaskConfig	array<object>	A lista de tarefas de monitoramento de disponibilidade.
	array<object>	A lista de tarefas de monitoramento de disponibilidade.
TaskType	string	O tipo de tarefa. Valores válidos: PING TELNET HTTP	HTTP
GroupName	string	O nome do grupo de aplicativos.	Group_ECS
GroupId	integer	O ID do grupo de aplicativos.	12345
TaskName	string	O nome da tarefa de monitoramento de disponibilidade.	ecs_instance
Disabled	boolean	Indica se a tarefa de monitoramento de disponibilidade está desativada. Valores válidos: true: A tarefa de monitoramento de disponibilidade está desativada. false: A tarefa de monitoramento de disponibilidade está ativada.	false
TaskScope	string	O escopo de instâncias monitoradas pela tarefa de monitoramento de disponibilidade. Valores válidos: GROUP: Todas as instâncias ECS no grupo de aplicativos são monitoradas. GROUP_SPEC_INSTANCE: Instâncias ECS especificadas no grupo de aplicativos são monitoradas.	GROUP
Id	integer	O ID da tarefa de monitoramento de disponibilidade.	123456
Instances	object
Instance	array	As instâncias ECS que são monitoradas.
	string	O ID da instância ECS.	i-abcdefgh12****
TaskOption	object	Os parâmetros opcionais da tarefa de monitoramento de disponibilidade.
HttpMethod	string	O método de solicitação HTTP. Valores válidos: GET POST HEAD	GET
Interval	integer	O intervalo no qual as solicitações de detecção são enviadas. Unidade: segundos.	60
HttpURI	string	O URI que você deseja monitorar. Se o parâmetro TaskType estiver definido como HTTP, este parâmetro será obrigatório.	https://www.aliyun.com
TelnetOrPingHost	string	O nome de domínio ou endereço IP que você deseja monitorar.	ssh.aliyun.com
HttpResponseCharset	string	O conjunto de caracteres usado na resposta HTTP.	UTF-8
HttpPostContent	string	O conteúdo da solicitação HTTP POST.	params1=paramsValue1
HttpNegative	boolean	O método para acionar um alerta. O alerta pode ser acionado com base na inclusão ou não da regra de alerta especificada no corpo da resposta. Valores válidos: true: Se o corpo da resposta HTTP incluir a regra de alerta, um alerta será acionado. false: Se a resposta HTTP não incluir a regra de alerta, um alerta será acionado.	true
HttpKeyword	string	A resposta à solicitação HTTP.	OK
AlertConfig	object	As configurações da regra de alerta.
SilenceTime	integer	O período de silenciamento durante o qual novos alertas não são enviados mesmo que as condições de acionamento sejam atendidas. Unidade: segundos. Valor padrão: 86400.	86400
EndTime	integer	O fim do período de tempo durante o qual a regra de alerta está em vigor. Valores válidos: 0 a 23. Por exemplo, se o parâmetro `AlertConfig.StartTime` estiver definido como 0 e o parâmetro `AlertConfig.EndTime` estiver definido como 22, a regra de alerta estará em vigor das 00:00:00 às 22:00:00. Nota As notificações de alerta são enviadas com base no limite especificado somente se a regra de alerta estiver em vigor.	22
StartTime	integer	O início do período de tempo durante o qual a regra de alerta está em vigor. Valores válidos: 0 a 23. Por exemplo, se o parâmetro `AlertConfig.StartTime` estiver definido como 0 e o parâmetro `AlertConfig.EndTime` estiver definido como 22, a regra de alerta estará em vigor das 00:00:00 às 22:00:00. Nota As notificações de alerta são enviadas com base no limite especificado somente se a regra de alerta estiver em vigor.	0
WebHook	string	A URL de callback. O CloudMonitor envia uma notificação de alerta para a URL de callback especificada enviando uma solicitação HTTP POST. Apenas o protocolo HTTP é suportado.	https://www.aliyun.com
NotifyType	integer	Os métodos de notificação de alerta. Valores válidos: 2: As notificações de alerta são enviadas por e-mails e chatbots do DingTalk. 1: As notificações de alerta são enviadas por e-mails e chatbots do DingTalk. 0: As notificações de alerta são enviadas por e-mails e chatbots do DingTalk.	1
EscalationList	object
escalationList	array<object>	As condições de acionamento da regra de alerta.
	object
Value	string	O limite de alerta.	400
MetricName	string	O nome da métrica. Valores válidos: HttpStatus HttpLatency TelnetStatus TelnetLatency PingLostRate	HttpStatus
Operator	string	O operador de comparação usado na regra de alerta. Valores válidos: `>` `>=` `<` `<=` `=`	=
Times	string	O número consecutivo de vezes que o valor da métrica é medido antes que um alerta seja acionado.	3
Aggregate	string	O método usado para calcular os valores de métrica que acionam alertas. Valores válidos: Value: o valor do código de status HTTP Average: o tempo médio de resposta HTTP Value: o valor do código de status Telnet TelnetLatency: o tempo médio de resposta Telnet Average: a taxa média de perda de pacotes Ping	Value
TargetList	object
Target	array<object>	Os recursos monitorados.
	object
Id	string	O ID do recurso que aciona o alerta.	1
Arn	string	O Alibaba Cloud Resource Name (ARN) da função. Formato: `arn:acs:${Service}:${Region}:${Account}:${ResourceType}/${ResourceId}`. Campos: Service: o código do serviço Region: o ID da região Account: o ID da conta Alibaba Cloud ResourceType: o tipo de recurso ResourceId: o ID do recurso.	acs:mns:cn-hangzhou:17754132319*****:/queues/test/messages
Level	string	O nível de alerta. Valores válidos: INFO WARN CRITICAL	INFO
JsonParams	string	Os parâmetros formatados em JSON do callback de alerta.	{"key1":"value1"}

Exemplos

Resposta de sucesso

JSON formato

{
  "Code": "200",
  "Message": "The specified resource is not found.",
  "RequestId": "4A288E86-45C3-4858-9DB0-6D85B10BD92A",
  "Total": 1,
  "Success": true,
  "TaskList": {
    "NodeTaskConfig": [
      {
        "TaskType": "HTTP",
        "GroupName": "Group_ECS",
        "GroupId": 12345,
        "TaskName": "ecs_instance",
        "Disabled": false,
        "TaskScope": "GROUP",
        "Id": 123456,
        "Instances": {
          "Instance": [
            "i-abcdefgh12****"
          ]
        },
        "TaskOption": {
          "HttpMethod": "GET",
          "Interval": 60,
          "HttpURI": "https://www.aliyun.com",
          "TelnetOrPingHost": "ssh.aliyun.com",
          "HttpResponseCharset": "UTF-8",
          "HttpPostContent": "params1=paramsValue1",
          "HttpNegative": true,
          "HttpKeyword": "OK"
        },
        "AlertConfig": {
          "SilenceTime": 86400,
          "EndTime": 22,
          "StartTime": 0,
          "WebHook": "https://www.aliyun.com",
          "NotifyType": 1,
          "EscalationList": {
            "escalationList": [
              {
                "Value": "400",
                "MetricName": "HttpStatus",
                "Operator": "=",
                "Times": "3",
                "Aggregate": "Value"
              }
            ]
          },
          "TargetList": {
            "Target": [
              {
                "Id": "1",
                "Arn": "acs:mns:cn-hangzhou:17754132319*****:/queues/test/messages",
                "Level": "INFO",
                "JsonParams": "{\"key1\":\"value1\"}"
              }
            ]
          }
        }
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro
400	ParameterInvalid	Illegal parameters.
500	InternalError	The request processing has failed due to some unknown error.
403	AccessForbidden	User not authorized to operate on the specified resource.
404	ResourceNotFound	The specified resource is not found.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.