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

*Todos os recursos.

*

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. 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: Bem-sucedido. false: Falha.	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 da 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 está desativada. false: A tarefa está ativada.	false
TaskScope	string	O escopo da tarefa de monitoramento de disponibilidade. Valores válidos: GROUP: Todas as instâncias ECS no grupo de aplicativos atual são usadas como pontos de detecção. GROUP_SPEC_INSTANCE: Instâncias ECS especificadas no grupo de aplicativos atual são usadas como pontos de detecção.	GROUP
Id	integer	O ID da tarefa de monitoramento de disponibilidade.	123456
Instances	object
Instance	array	A lista de instâncias ECS que iniciam a detecção.
	string	A lista de instâncias ECS que iniciam a detecção.	i-abcdefgh12****
TaskOption	object	As opções de parâmetros da tarefa de monitoramento de disponibilidade.
HttpMethod	string	O método HTTP do tipo de detecção. Valores válidos: GET POST HEAD	GET
Interval	integer	A frequência de detecção. Unidade: segundos.	60
HttpURI	string	O URI para detecção HTTP.	https://www.aliyun.com
TelnetOrPingHost	string	O nome de domínio ou endereço a ser detectado.	ssh.aliyun.com
HttpResponseCharset	string	O conjunto de caracteres de resposta para detecção HTTP.	UTF-8
HttpPostContent	string	O conteúdo POST da solicitação de detecção HTTP.	params1=paramsValue1
HttpNegative	boolean	A regra de alerta para correspondência de conteúdo de resposta HTTP. Valores válidos: true: Um alerta é acionado se o conteúdo da resposta HTTP contiver a regra de alerta especificada. false: Um alerta é acionado se o conteúdo da resposta HTTP não contiver a regra de alerta especificada.	true
HttpKeyword	string	A palavra-chave a ser correspondida no conteúdo da resposta de detecção HTTP.	OK
AlertConfig	object	A configuração da regra de alerta.
SilenceTime	integer	O período de silêncio. Unidade: segundos. Valor padrão: 86400.	86400
EndTime	integer	A hora de término do período de vigência do alerta. Valores válidos: 0 a 23. Por exemplo, se AlertConfig.StartTime estiver definido como 0 e AlertConfig.EndTime estiver definido como 22, o período de vigência do alerta será de 00:00:00 a 22:00:00. Nota Se o alerta não estiver dentro do período de vigência, nenhuma notificação de alerta será enviada, mesmo que o limite seja excedido.	22
StartTime	integer	A hora de início do período de vigência do alerta. Valores válidos: 0 a 23. Por exemplo, se AlertConfig.StartTime estiver definido como 0 e AlertConfig.EndTime estiver definido como 22, o período de vigência do alerta será de 00:00:00 a 22:00:00. Nota Se o alerta não estiver dentro do período de vigência, nenhuma notificação de alerta será enviada, mesmo que o limite seja excedido.	0
WebHook	string	A URL de callback quando um alerta é acionado. O CloudMonitor envia informações de alerta para esta URL usando solicitações POST. Apenas o protocolo HTTP é suportado.	https://www.aliyun.com
NotifyType	integer	O método de notificação de alerta. Valores válidos: 2: E-mail + chatbot do DingTalk. 1: E-mail + chatbot do DingTalk. 0: E-mail + chatbot do DingTalk.	1
EscalationList	object
escalationList	array<object>	As condições que acionam o alerta.
	object	As condições que acionam o alerta.
Value	string	O limite do alerta.	400
MetricName	string	A métrica do alerta. Valores válidos: HttpStatus: Código de status HTTP. HttpLatency: Tempo de resposta HTTP. TelnetStatus: Código de status TELNET. TelnetLatency: Tempo de resposta TELNET. PingLostRate: Taxa de perda de pacotes PING.	HttpStatus
Operator	string	O operador de comparação para a regra de alerta. Valores válidos: `>` `>=` `<` `<=` `=`	=
Times	string	O número de períodos consecutivos durante os quais o limite é excedido antes que um alerta seja acionado.	3
Aggregate	string	O método estatístico para o alerta. Os valores válidos variam de acordo com a métrica: 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>	A lista de destinos de alerta.
	object	A lista de destinos de alerta.
Id	string	O ID do destino de alerta.	1
Arn	string	O Alibaba Cloud Resource Name (ARN). Formato: `arn:acs:${Service}:${Region}:${Account}:${ResourceType}/${ResourceId}`. Os campos são descritos da seguinte forma: Service: O código do serviço Alibaba Cloud. 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 do alerta. Valores válidos: INFO: Informação. WARN: Aviso. CRITICAL: Crítico.	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	Descrição
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.	O recurso especificado %s não existe.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.