DescribeHostAvailabilityList - - Centre de documentation Alibaba Cloud

Cette rubrique présente un exemple d'interrogation de toutes les tâches de surveillance de la disponibilité associées à votre compte Alibaba Cloud. Les exemples de réponse indiquent que le compte possède une tâche de surveillance de la disponibilité nommée ecs_instance.

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d'utiliser OpenAPI Explorer pour appeler cette opération. OpenAPI Explorer génère dynamiquement des exemples de code pour différents SDK.

Paramètres de requête

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	DescribeHostAvailabilityList	Opération à effectuer. Définissez la valeur sur DescribeHostAvailabilityList.
Id	Long	Non	123456	ID de la tâche de surveillance de la disponibilité.
Ids	String	Non	123456,345678	ID des tâches de surveillance de la disponibilité. Séparez les différents ID par des virgules (,).
TaskName	String	Non	ecs_instance	Nom de la tâche de surveillance de la disponibilité.
PageNumber	Integer	Non	1	Numéro de la page à renvoyer. La numérotation commence à 1. Valeur par défaut : 1.
PageSize	Integer	Non	10	Nombre d'entrées à renvoyer par page. Valeur par défaut : 10.
GroupId	Long	Non	12345	ID du groupe d'applications.

Pour plus d'informations sur les paramètres de requête communs, consultez la rubrique Paramètres communs.

Paramètres de réponse

Paramètre	Type	Exemple	Description
RequestId	String	4A288E86-45C3-4858-9DB0-6D85B10BD92A	ID de la requête.
Code	String	200	Code d'état HTTP. Remarque La valeur 200 indique que l'appel a réussi.
Success	Boolean	true	Indique si l'appel a réussi. Valeurs possibles : true : L'appel a réussi. false : L'appel a échoué.
TaskList	Array of NodeTaskConfig		Détails des tâches de surveillance de la disponibilité.
NodeTaskConfig
AlertConfig	Struct		Configuration de la règle d'alerte.
EndTime	Integer	22	Heure de fin de la période d'efficacité de la règle d'alerte. Valeurs possibles : 0 à 23. Par exemple, si le paramètre `AlertConfig.StartTime` est défini sur 0 et le paramètre `AlertConfig.EndTime` sur 22, la règle d'alerte est effective de 00:00:00 à 22:00:00. Remarque Les notifications d'alerte sont envoyées en fonction du seuil spécifié uniquement si la règle d'alerte est active.
EscalationList	Array of escalationList		Conditions de déclenchement de la règle d'alerte.
escalationList
Aggregate	String	Value	Méthode de calcul des valeurs de métrique déclenchant les alertes. Valeurs possibles : Value : valeur du code d'état HTTP Average : temps de réponse HTTP moyen Value : valeur du code d'état Telnet TelnetLatency : temps de réponse Telnet moyen Average : taux de perte de paquets Ping moyen
MetricName	String	HttpStatus	Nom de la métrique. Valeurs possibles : HttpStatus : code d'état HTTP HttpLatency : temps de réponse HTTP TelnetStatus : code d'état Telnet TelnetLatency : temps de réponse Telnet PingLostRate : taux de perte de paquets Ping
Operator	String	=	Opérateur de comparaison utilisé dans la règle d'alerte. Valeurs possibles : `>` `>=` `<` `<=` `=`
Times	String	3	Nombre consécutif de mesures de la valeur de métrique avant le déclenchement d'une alerte.
Value	String	400	Seuil d'alerte.
NotifyType	Integer	1	Méthodes de notification d'alerte. Valeurs possibles : 0 : Les notifications d'alerte sont envoyées par e-mail et via les robots de discussion DingTalk.
SilenceTime	Integer	86400	Période de silence pendant laquelle aucune nouvelle alerte n'est envoyée, même si les conditions de déclenchement sont remplies. Unité : secondes. Valeur par défaut : 86400.
StartTime	Integer	0	Heure de début de la période d'efficacité de la règle d'alerte. Valeurs possibles : 0 à 23. Par exemple, si le paramètre `AlertConfig.StartTime` est défini sur 0 et le paramètre `AlertConfig.EndTime` sur 22, la règle d'alerte est effective de 00:00:00 à 22:00:00. Remarque Les notifications d'alerte sont envoyées en fonction du seuil spécifié uniquement si la règle d'alerte est active.
WebHook	String	https://www.aliyun.com	URL de rappel. CloudMonitor envoie une notification d'alerte à l'URL de rappel spécifiée via une requête HTTP POST. Seul le protocole HTTP est pris en charge.
Disabled	Boolean	false	Indique si la tâche de surveillance de la disponibilité est désactivée. Valeurs possibles : true : La tâche de surveillance de la disponibilité est désactivée. false : La tâche de surveillance de la disponibilité est activée.
GroupId	Long	12345	ID du groupe d'applications.
GroupName	String	Group_ECS	Nom du groupe d'applications.
Id	Long	123456	ID de la tâche de surveillance de la disponibilité.
Instances	List	i-abcdefgh12****	Instances ECS surveillées.
TaskName	String	ecs_instance	Nom de la tâche de surveillance de la disponibilité.
TaskOption	Struct		Paramètres optionnels de la tâche de surveillance de la disponibilité.
HttpKeyword	String	OK	Réponse à la requête HTTP.
HttpMethod	String	GET	Méthode de requête HTTP. Valeurs possibles : GET POST HEAD
HttpNegative	Boolean	true	Méthode de déclenchement de l'alerte. L'alerte peut être déclenchée selon que la règle d'alerte spécifiée est incluse ou non dans le corps de la réponse. Valeurs possibles : true : Si le corps de la réponse HTTP inclut la règle d'alerte, une alerte est déclenchée. false : Si le corps de la réponse HTTP n'inclut pas la règle d'alerte, une alerte est déclenchée.
HttpPostContent	String	params1=paramsValue1	Contenu de la requête HTTP POST.
HttpResponseCharset	String	UTF-8	Jeu de caractères utilisé dans la réponse HTTP.
HttpURI	String	https://www.aliyun.com	URI à surveiller. Ce paramètre est obligatoire si le paramètre TaskType est défini sur HTTP.
Interval	Integer	60	Intervalle d'envoi des requêtes de détection. Unité : secondes.
TelnetOrPingHost	String	ssh.aliyun.com	Nom de domaine ou adresse IP à surveiller.
TaskScope	String	GROUP	Étendue des instances surveillées par la tâche de surveillance de la disponibilité. Valeurs possibles : GROUP : Toutes les instances ECS du groupe d'applications sont surveillées. GROUP_SPEC_INSTANCE : Des instances ECS spécifiques du groupe d'applications sont surveillées.
TaskType	String	HTTP	Type de la tâche de surveillance de la disponibilité. Valeurs possibles : PING TELNET HTTP
Total	Integer	1	Nombre total d'entrées renvoyées.
Message	String	The specified resource is not found.	Message d'erreur.

Exemples

Exemples de requêtes

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

Exemples de réponses réussies

Format 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>

Format 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
}

Codes d'erreur

Code d'état HTTP	Code d'erreur	Message d'erreur	Description
404	ResourceNotFound	The specified resource is not found.	Message d'erreur renvoyé car la ressource spécifiée est introuvable.

Pour obtenir la liste des codes d'erreur, visitez le Centre d'erreurs de l'API.