DescribeCloudGtmMonitorTemplate - - Centre de documentation Alibaba Cloud

Obtient la configuration d'un modèle de vérification de l'état spécifié.

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

alidns:DescribeCloudGtmMonitorTemplate

get

*All Resource

*

Aucune

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
AcceptLanguage	string	Non	La langue de la réponse. Valeurs valides : zh-CN : chinois. en-US (par défaut) : anglais.	zh-CN
TemplateId	string	Oui	L'identifiant unique du modèle de vérification de l'état.	mtp-89518052425100****

Éléments de réponse

Élément	Type	Description	Exemple
	object
RequestId	string	L'identifiant unique de la requête.	6AEC7A64-3CB1-4C49-8B35-0B901F1E26BF
TemplateId	string	L'identifiant unique du modèle de vérification de l'état.	mtp-89518052425100****
CreateTime	string	L'heure à laquelle le modèle de vérification de l'état a été créé.	2024-03-23T13:09Z
CreateTimestamp	integer	L'horodatage UNIX qui indique l'heure à laquelle le modèle de vérification de l'état a été créé.	1527690629357
UpdateTime	string	L'heure de la dernière modification du modèle de vérification de l'état.	2024-03-29T13:20Z
UpdateTimestamp	integer	L'horodatage UNIX qui indique l'heure de la dernière modification du modèle de vérification de l'état.	1527690629357
Name	string	Le nom du modèle de vérification de l'état. Pour identifier facilement le modèle, spécifiez un nom qui indique le protocole de vérification de l'état.	Ping-IPv4
IpVersion	string	Le type d'adresse IP des points de détection : IPv4 : L'adresse cible est une adresse IPv4. IPv6 : L'adresse cible est une adresse IPv6.	IPv4
Protocol	string	Le protocole utilisé pour sonder l'adresse IP cible : ping tcp http https	ping
Interval	integer	L'intervalle entre les vérifications de l'état en secondes. La valeur par défaut est 60. L'intervalle minimum est de 15 secondes. Cette fonctionnalité n'est disponible que pour les instances Ultimate Edition.	60
Timeout	integer	Le délai d'expiration de la vérification de l'état en millisecondes. Si aucun paquet n'est renvoyé dans le délai d'expiration spécifié, la vérification de l'état échoue. Valeurs valides : 2000 3000 5000 10000	5000
EvaluationCount	integer	Le nombre de fois consécutives qu'une vérification de l'état doit échouer avant que le service d'application ne soit déclaré anormal. Cela permet d'éviter les fausses alarmes causées par des problèmes transitoires tels que la gigue du réseau. Valeurs valides :\n\n- 1\n\n- 2\n\n- 3	2
FailureRate	integer	Le pourcentage de points de détection en échec. Si le pourcentage de points de détection en échec dépasse cette valeur, le point de terminaison est déclaré anormal. Valeurs valides : 20 50 80 100	50
ExtendInfo	string	Les informations étendues dans une chaîne JSON. Les paramètres varient en fonction du protocole. Pour HTTP et HTTPS : host : Le champ Host dans l'en-tête de requête HTTP ou HTTPS. Ce champ identifie le site web auquel vous souhaitez accéder. La valeur par défaut est le nom de domaine principal. Si le site web cible a des exigences spécifiques en matière d'hôte, modifiez ce paramètre. path : Le chemin d'URL pour les vérifications d'état HTTP ou HTTPS. La valeur par défaut est /. code : Le système détermine si le serveur web fonctionne comme prévu en fonction du code de retour. Si le code de retour est supérieur au seuil spécifié, le service d'application est considéré comme anormal. 400 : Bad Request. Si une requête HTTP ou HTTPS contient des paramètres incorrects, le serveur web renvoie un code supérieur à 400. Si vous définissez le seuil sur 400, spécifiez le chemin d'URL exact. 500 : Server Error. Si une exception se produit sur le serveur web, celui-ci renvoie un code supérieur à 500. Le seuil par défaut est 500. sni : Indique si l'indication du nom du serveur (SNI) doit être activée. Ce paramètre est utilisé uniquement pour le protocole HTTPS. SNI est une extension de la sécurité de la couche de transport (TLS) qui permet à un client de spécifier le nom d'hôte auquel il souhaite se connecter au début de la négociation TLS. Cela permet au serveur de présenter le certificat correct pour ce nom d'hôte. true : Active SNI. false : Désactive SNI. followRedirect : Indique s'il faut suivre les redirections 3xx. true : Si le code d'état renvoyé par le point de détection est 3xx (301, 302, 303, 307 ou 308), le système suit la redirection. false : Le système ne suit pas la redirection. Pour ping : packetNum : Le nombre de paquets ICMP à envoyer pour chaque vérification d'état ping. Valeurs valides : 20, 50 et 100. packetLossRate : Le seuil du taux de perte de paquets. Pour chaque vérification d'état ping, le système calcule le taux de perte de paquets. Si le taux de perte de paquets atteint le seuil, une alerte est déclenchée. Taux de perte de paquets = (Nombre de paquets perdus / Nombre total de paquets ICMP envoyés) × 100 %. Les valeurs valides pour le taux de perte de paquets sont 10, 30, 40, 80, 90 et 100.	{\"code\":200,\"path\":\"\\index.htm\",\"host\":\"aliyun.com\"}
IspCityNodes	object
IspCityNode	array<object>	La liste des points de détection. Pour plus d'informations, appelez l'opération ListCloudGtmMonitorNodes.
	object	Un point de détection.
CountryCode	string	The country code.	001
CountryName	string	The country name.	中国
CityCode	string	The city code.	503
CityName	string	The city name.	张家口市
GroupType	string	The group type of the detection points: BGP: Border Gateway Protocol (BGP) nodes OVERSEAS: Nodes outside mainland China ISP: Carrier nodes	BGP
GroupName	string	The name of the detection point group.	BGP节点
IspCode	string	The carrier code.	465
IspName	string	The carrier name.	阿里巴巴
Remark	string	Les remarques sur le modèle de vérification de l'état.	test

Exemples

JSON format

{
  "RequestId": "6AEC7A64-3CB1-4C49-8B35-0B901F1E26BF",
  "TemplateId": "mtp-89518052425100****",
  "CreateTime": "2024-03-23T13:09Z",
  "CreateTimestamp": 1527690629357,
  "UpdateTime": "2024-03-29T13:20Z",
  "UpdateTimestamp": 1527690629357,
  "Name": "Ping-IPv4",
  "IpVersion": "IPv4",
  "Protocol": "ping",
  "Interval": 60,
  "Timeout": 5000,
  "EvaluationCount": 2,
  "FailureRate": 50,
  "ExtendInfo": "{\\\"code\\\":200,\\\"path\\\":\\\"\\\\index.htm\\\",\\\"host\\\":\\\"aliyun.com\\\"}",
  "IspCityNodes": {
    "IspCityNode": [
      {
        "CountryCode": "001",
        "CountryName": "中国",
        "CityCode": "503",
        "CityName": "张家口市",
        "GroupType": "BGP",
        "GroupName": "BGP节点",
        "IspCode": "465",
        "IspName": "阿里巴巴"
      }
    ]
  },
  "Remark": "test"
}

Codes d'erreur

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.