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

Este tópico apresenta um exemplo de consulta a todas as tarefas de monitoramento de disponibilidade da sua conta Alibaba Cloud. As respostas de amostra indicam que a conta possui uma tarefa de monitoramento de disponibilidade chamada ecs_instance.

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 de solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	DescribeHostAvailabilityList	A operação a ser executada. Defina o valor como DescribeHostAvailabilityList.
Id	Long	Não	123456	O ID da tarefa de monitoramento de disponibilidade.
Ids	String	Não	123456,345678	Os IDs das tarefas de monitoramento de disponibilidade. Separe vários IDs com vírgulas (,).
TaskName	String	Não	ecs_instance	O nome da tarefa de monitoramento de disponibilidade.
PageNumber	Integer	Não	1	O número da página a retornar. A numeração começa em 1. Valor padrão: 1.
PageSize	Integer	Não	10	O número de entradas a retornar por página. Valor padrão: 10.
GroupId	Long	Não	12345	O ID do grupo de aplicativos.

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	4A288E86-45C3-4858-9DB0-6D85B10BD92A	O ID da solicitação.
Code	String	200	O código de status HTTP. Nota O valor 200 indica que a chamada foi bem-sucedida.
Success	Boolean	true	Indica se a chamada foi bem-sucedida. Valores válidos: true: A chamada foi bem-sucedida. false: A chamada falhou.
TaskList	Array of NodeTaskConfig		Os detalhes das tarefas de monitoramento de disponibilidade.
NodeTaskConfig
AlertConfig	Struct		As configurações da regra de alerta.
EndTime	Integer	22	O fim do período de vigência da regra de alerta. Valores válidos: 0 a 23. Por exemplo, se o parâmetro `AlertConfig.StartTime` for definido como 0 e o parâmetro `AlertConfig.EndTime` for definido como 22, a regra de alerta vigorará das 00:00:00 às 22:00:00. Nota As notificações de alerta são enviadas com base no limiar especificado somente quando a regra de alerta estiver ativa.
EscalationList	Array of escalationList		As condições de acionamento da regra de alerta.
escalationList
Aggregate	String	Value	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
MetricName	String	HttpStatus	O nome da métrica. 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
Operator	String	=	O operador de comparação usado na regra de alerta. Valores válidos: `>` `>=` `<` `<=` `=`
Times	String	3	O número consecutivo de medições do valor da métrica antes do acionamento de um alerta.
Value	String	400	O limiar de alerta.
NotifyType	Integer	1	Os métodos de notificação de alerta. Valores válidos: 0: As notificações de alerta são enviadas por e-mail e chatbots do DingTalk.
SilenceTime	Integer	86400	O período de silêncio 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.
StartTime	Integer	0	O início do período de vigência da regra de alerta. Valores válidos: 0 a 23. Por exemplo, se o parâmetro `AlertConfig.StartTime` for definido como 0 e o parâmetro `AlertConfig.EndTime` for definido como 22, a regra de alerta vigorará das 00:00:00 às 22:00:00. Nota As notificações de alerta são enviadas com base no limiar especificado somente quando a regra de alerta estiver ativa.
WebHook	String	https://www.aliyun.com	A URL de callback. O CloudMonitor envia uma notificação de alerta para a URL de callback especificada por meio de uma solicitação HTTP POST. Apenas o protocolo HTTP é suportado.
Disabled	Boolean	false	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.
GroupId	Long	12345	O ID do grupo de aplicativos.
GroupName	String	Group_ECS	O nome do grupo de aplicativos.
Id	Long	123456	O ID da tarefa de monitoramento de disponibilidade.
Instances	List	i-abcdefgh12****	As instâncias ECS monitoradas.
TaskName	String	ecs_instance	O nome da tarefa de monitoramento de disponibilidade.
TaskOption	Struct		Os parâmetros opcionais da tarefa de monitoramento de disponibilidade.
HttpKeyword	String	OK	A resposta à solicitação HTTP.
HttpMethod	String	GET	O método de solicitação HTTP. Valores válidos: GET POST HEAD
HttpNegative	Boolean	true	O método para acionar um alerta. O alerta pode ser acionado com base na presença ou ausência 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.
HttpPostContent	String	params1=paramsValue1	O conteúdo da solicitação HTTP POST.
HttpResponseCharset	String	UTF-8	O conjunto de caracteres usado na resposta HTTP.
HttpURI	String	https://www.aliyun.com	A URI a ser monitorada. Se o parâmetro TaskType estiver definido como HTTP, este parâmetro é obrigatório.
Interval	Integer	60	O intervalo de envio das solicitações de detecção. Unidade: segundos.
TelnetOrPingHost	String	ssh.aliyun.com	O nome de domínio ou endereço IP a ser monitorado.
TaskScope	String	GROUP	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 específicas no grupo de aplicativos são monitoradas.
TaskType	String	HTTP	O tipo da tarefa de monitoramento de disponibilidade. Valores válidos: PING TELNET HTTP
Total	Integer	1	O número total de entradas retornadas.
Message	String	The specified resource is not found.	A mensagem de erro.

Exemplos

Solicitações de amostra

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

Respostas de sucesso de amostra

Formato XML

<DescribeHostAvailabilityListResponse>
	  <RequestId>4A288E86-45C3-4858-9DB0-6D85B10BD92A</RequestId>
	  <Total>1</Total>
	  <TaskList>
		    <NodeTaskConfig>
			      <GroupName>Group_ECS</GroupName>
			      <TaskOption>
				        <HttpURI>https://aliyun.com</HttpURI>
				        <HttpMethod>GET</HttpMethod>
			      </TaskOption>
			      <AlertConfig>
				        <NotifyType>1</NotifyType>
				        <SilenceTime>86400</SilenceTime>
				        <EndTime>22</EndTime>
				        <StartTime>0</StartTime>
				        <EscalationList>
					          <escalationList>
						            <Operator>=</Operator>
						            <MetricName>HttpStatus</MetricName>
						            <Times>3</Times>
						            <Value>400</Value>
						            <Aggregate>Value</Aggregate>
					          </escalationList>
					          <escalationList>
						            <Operator>=</Operator>
						            <MetricName>HttpLatency</MetricName>
						            <Times>3</Times>
						            <Value>500</Value>
						            <Aggregate>Average</Aggregate>
					          </escalationList>
				        </EscalationList>
			      </AlertConfig>
			      <TaskName>ecs_instance</TaskName>
			      <TaskScope>GROUP</TaskScope>
			      <TaskType>HTTP</TaskType>
			      <Id>123456</Id>
			      <Disabled>false</Disabled>
			      <GroupId>12345</GroupId>
		    </NodeTaskConfig>
	  </TaskList>
	  <Code>200</Code>
	  <Success>true</Success>
</DescribeHostAvailabilityListResponse>

Formato JSON

{
	"RequestId": "4A288E86-45C3-4858-9DB0-6D85B10BD92A",
	"Total": 1,
	"TaskList": {
		"NodeTaskConfig": [
			{
				"GroupName": "Group_ECS",
				"TaskOption": {
					"HttpURI": "https://aliyun.com",
					"HttpMethod": "GET"
				},
				"AlertConfig": {
					"NotifyType": 1,
					"SilenceTime": 86400,
					"EndTime": 22,
					"StartTime": 0,
					"EscalationList": {
						"escalationList": [
							{
								"Operator": "=",
								"MetricName": "HttpStatus",
								"Times": 3,
								"Value": "400",
								"Aggregate": "Value"
							},
							{
								"Operator": "=",
								"MetricName": "HttpLatency",
								"Times": 3,
								"Value": "500",
								"Aggregate": "Average"
							}
						]
					}
				},
				"TaskName": "ecs_instance",
				"TaskScope": "GROUP",
				"TaskType": "HTTP",
				"Id": 123456,
				"Disabled": false,
				"GroupId": 12345
			}
		]
	},
	"Code": 200,
	"Success": true
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
404	ResourceNotFound	The specified resource is not found.	A mensagem de erro retornada porque o recurso especificado não foi encontrado.

Para obter uma lista de códigos de erro, visite o Centro de Erros de API.