Tous les produits
Search
Centre de documentation

:SearchCloudGtmMonitorTemplates

Dernière mise à jour :Aug 06, 2026

Recherche des modèles de vérification de l'état.

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

list

*All Resource

*

Aucune 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

PageNumber

integer

Oui

Le numéro de la page actuelle. La valeur commence à 1. La valeur par défaut est 1.

1

PageSize

integer

Oui

Le nombre d'entrées à renvoyer sur chaque page pour une requête paginée. La valeur maximale est 100. La valeur par défaut est 20.

20

Name

string

Non

Le nom du modèle de vérification de l'état. Une recherche approximative est effectuée en fonction du mot-clé que vous saisissez.

IPv4-Ping

IpVersion

string

Non

La version IP des points de détection. Une recherche exacte est effectuée. Valeurs valides :

  • IPv4 : cette version s'applique lorsque l'adresse cible est une adresse IPv4.

  • IPv6 : cette version s'applique lorsque l'adresse cible est une adresse IPv6.

IPv4

Protocol

string

Non

Le protocole utilisé pour la détection. Une recherche exacte est effectuée. Valeurs valides :

  • ping

  • tcp

  • http

  • https

ping

Éléments de réponse

Élément

Type

Description

Exemple

object

RequestId

string

L'identifiant unique de la requête.

536E9CAD-DB30-4647-AC87-AA5CC38C5382

TotalPages

integer

Le nombre total de pages.

1

TotalItems

integer

Le nombre total de modèles de vérification de l'état trouvés.

1

PageSize

integer

Le nombre d'entrées renvoyées sur chaque page. La valeur maximale est 100. La valeur par défaut est 20.

20

PageNumber

integer

Le numéro de la page actuelle. La valeur commence à 1. La valeur par défaut est 1.

1

Templates

object

Template

array<object>

Une liste de modèles de vérification de l'état.

array<object>

Les informations sur le modèle de vérification de l'état.

TemplateId

string

The ID of the health check template. The ID uniquely identifies a health check template.

mtp-89518052425100**80

CreateTime

string

The time when the health check template was created.

2024-03-23T13:09Z

CreateTimestamp

integer

The UNIX timestamp that indicates when the health check template was created.

1527690629357

UpdateTime

string

The time when the health check template was last modified.

2024-03-29T13:20Z

UpdateTimestamp

integer

The UNIX timestamp that indicates when the health check template was last modified.

1527690629357

Name

string

The name of the health check template. For easy identification, specify a name that indicates the health check protocol.

IPv4-Ping

IpVersion

string

The IP version of the detection points. Valid values:

  • IPv4: This version is applicable when the target address is an IPv4 address.

  • IPv6: This version is applicable when the target address is an IPv6 address.

IPv4

Protocol

string

The protocol used to probe the target IP address. Valid values:

  • ping

  • tcp

  • http

  • https

ping

Interval

integer

The interval between two consecutive health checks. Unit: seconds. The default interval is 1 minute. The minimum interval is 15 seconds. This feature is available only for Ultimate Edition instances.

60

Timeout

integer

The timeout period for a health check. Unit: milliseconds. If a packet is not returned within the timeout period, the health check is considered to have timed out. Valid values:

  • 2000

  • 3000

  • 5000

  • 10000

5000

EvaluationCount

integer

The number of retries. The system considers the application service abnormal only after the number of consecutive abnormal health checks reaches the specified value. This prevents monitoring accuracy from being affected by factors such as transient network jitter. Valid values:

  • 1

  • 2

  • 3

2

FailureRate

integer

The failure rate of the selected detection points. This is the percentage of abnormal detection points in all detection points. If the failure rate exceeds the specified threshold, the endpoint is considered abnormal. Valid thresholds for the failure rate are:

  • 20

  • 50

  • 80

  • 100

50

ExtendInfo

string

The extended information in a JSON string. The following parameters are required for different protocols:

  • http(s):

    host: When you perform an HTTP or HTTPS health check, this parameter specifies the Host field in the HTTP or HTTPS request header. This identifies the target HTTP website. The default value is the primary domain name. If the host of the target website has special requirements, modify this parameter as needed.

    path: The path for the HTTP or HTTPS health check. The system fills in "/" by default.

    code: When you perform an HTTP or HTTPS health check, the system determines whether the web server is working as expected based on the return code from the web server. If the return code is greater than the alert threshold, the system considers the application service abnormal.

    • 400: Bad Request. If an HTTP or HTTPS request contains invalid parameters, the web server returns a return code greater than 400. If you set the check content to "Abnormal code greater than 400", specify the exact URL path in the URL path parameter.

    • 500: Server Error. If an exception occurs on the web server, the server returns a return code greater than 500. The system uses a return code greater than 500 as the alert threshold by default.

    sni: Specifies whether to enable Server Name Indication (SNI). This parameter is used only for the HTTPS protocol. SNI is an extension to the TLS protocol. It allows a client to specify the hostname that it wants to connect to when initiating a TLS handshake. Because the TLS handshake occurs before any data of an HTTP request is sent, SNI allows the server to know the service that the client is trying to access before the server sends a certificate. This allows the server to select the correct certificate to present to the client.

    • true: Enable SNI.

    • false: Disable SNI.

    followRedirect: Specifies whether to follow 3xx redirections.

    • true: Follows the redirection if the detection point receives a 3xx status code (301, 302, 303, 307, or 308).

    • false: Does not follow the redirection.

  • ping:

    packetNum: The number of ICMP packets to send for each ping health check. Valid values: 20, 50, and 100.

    packetLossRate: The packet loss rate that indicates an abnormal status. For each ping health check, the system calculates the packet loss rate based on the sent ICMP packets. Packet loss rate = (Number of lost packets / Total number of sent ICMP packets) × 100%. An alert is triggered if the packet loss rate reaches the specified threshold. Valid values for the packet loss rate: 10, 30, 40, 80, 90, and 100.

{\"code\":200,\"path\":\"\\index.htm\",\"host\":\"aliyun.com\"}

IspCityNodes

object

IspCityNode

array<object>

A list of detection points.

object

The information about the detection point.

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 type of the detection point group. Valid values:

  • BGP: BGP nodes.

  • OVERSEAS: International nodes.

  • 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

The remarks on the health check template.

test

CloudGtmMonitorTemplateId

string

mtp-xxxx

Exemples

JSON format

{
  "RequestId": "536E9CAD-DB30-4647-AC87-AA5CC38C5382",
  "TotalPages": 1,
  "TotalItems": 1,
  "PageSize": 20,
  "PageNumber": 1,
  "Templates": {
    "Template": [
      {
        "TemplateId": "mtp-89518052425100**80",
        "CreateTime": "2024-03-23T13:09Z",
        "CreateTimestamp": 1527690629357,
        "UpdateTime": "2024-03-29T13:20Z",
        "UpdateTimestamp": 1527690629357,
        "Name": "IPv4-Ping",
        "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",
        "CloudGtmMonitorTemplateId": "mtp-xxxx"
      }
    ]
  }
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.