All Products
Search

This Product

    Alibaba Cloud DNS:DescribeCloudGtmMonitorTemplate

    Document Center

    Alibaba Cloud DNS:DescribeCloudGtmMonitorTemplate

    Last Updated:Mar 11, 2025

    Queries the configurations of a health check template.

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • For mandatory resource types, indicate with a prefix of * .
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    alidns:DescribeCloudGtmMonitorTemplateget
    *All Resources
    *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    AcceptLanguagestringNo

    The language of the response. Valid values:

    • zh-CN: Chinese
    • en-US (default): English
    		en-US
    TemplateIdstringYes

    The ID of the health check template that you want to query. This ID uniquely identifies the health check template.

    		mtp-89518052425100**80

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    Unique request identification code.

    		6AEC7A64-3CB1-4C49-8B35-0B901F1E26BF
    TemplateIdstring

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

    		mtp-89518052425100**80
    CreateTimestring

    Health check template creation time.

    		2024-03-23T13:09Z
    CreateTimestamplong

    Health check template creation time (timestamp).

    		1527690629357
    UpdateTimestring

    Health check template configuration modification time.

    		2024-03-29T13:20Z
    UpdateTimestamplong

    Health check template configuration modification time (timestamp).

    		1527690629357
    Namestring

    The name of the health check probe template, which is recommended to be distinguishable for configuration personnel to differentiate and remember, ideally indicating the health check protocol.

    		Ping-IPv4
    IpVersionstring

    Detect the type of the node IP address:

    • IPv4: Applicable when the target address type is IPv4;
    • IPv6: Applicable when the target address type is IPv6.
    		IPv4
    Protocolstring

    Protocol types to initiate probes to the target IP address:

    • ping
    • tcp
    • http
    • https
    		ping
    Intervalinteger

    The time interval (in seconds) between each check, with a default interval of 1 minute. The minimum supported health check interval is 15 seconds, available for flagship edition instances.

    		60
    Timeoutinteger

    Probe timeout (in milliseconds), data packets not returned within the timeout period are deemed as health check timeouts:

    • 2000
    • 3000
    • 5000
    • 10000
    		5000
    EvaluationCountinteger

    Retries count. The system will only judge the application service as abnormal after consecutive monitoring failures to prevent inaccurate monitoring results due to momentary network fluctuations or other reasons. Available retry counts are:

    • 1
    • 2
    • 3
    		2
    FailureRateinteger

    Percentage of selected node probe failures (%), that is, the percentage of abnormal detection points among the total detection points. When the failure ratio exceeds the set threshold, the service address is judged as abnormal. The available failure ratio thresholds are:

    • 20
    • 50
    • 80
    • 100
    		50
    ExtendInfostring

    The extended information. The value of this parameter is a JSON string. The required parameters vary based on the health check protocol.

    • HTTP or HTTPS:

      host: the Host field of an HTTP or HTTPS request header during an HTTP or HTTPS health check. The parameter value indicates the HTTP website that you want to visit. By default, the value is the primary domain name. You can change the value based on your business requirements.

      path: the URL for HTTP or HTTPS health checks. Default value: /.

      code: the alert threshold. During an HTTP or HTTPS health check, the system checks whether a web server functions as expected based on the status code that is returned from the web server. If the returned status code is greater than the specified threshold, the corresponding application service address is deemed abnormal. Valid values:

      • 400: indicates an invalid request. If an HTTP or HTTPS request contains invalid request parameters, a web server returns a status code that is greater than 400. You must specify an exact URL for path if you set code to 400.
      • 500: indicates a server error. If some exceptions occur on a web server, the web server returns a status code that is greater than 500. This value is used by default.

      sni: indicates whether Server Name Indication (SNI) is enabled. This parameter is used only when the health check protocol is HTTPS. SNI is an extension to the Transport Layer Security (TLS) protocol, which allows a client to specify the host to be connected when the client sends a TLS handshake request. TLS handshakes occur before any data of HTTP requests is sent. Therefore, SNI enables servers to identify the services that clients are attempting to access before certificates are sent. This allows the servers to present correct certificates to the clients. Valid values:

      • true: SNI is enabled.
      • false: SNI is disabled.

      followRedirect: indicates whether 3XX redirects are followed. Valid values:

      • true: 3XX redirects are followed. You are redirected to the destination address if a 3XX status code such as 301, 302, 303, 307, or 308 is returned.
      • false: 3XX redirects are not followed.

    • ping:

      packetNum: the total number of Internet Control Message Protocol (ICMP) packets that are sent to the address for each ping-based health check. Valid values: 20, 50, and 100.

      packetLossRate: the ICMP packet loss rate for each ping-based health check. The packet loss rate in a health check can be calculated by using the following formula: Packet loss rate in a health check = (Number of lost packets/Total number of sent ICMP packets) × 100%. If the packet loss rate reaches the threshold, an alert is triggered. Valid values: 10, 30, 40, 80, 90, and 100.

    		{\"code\":200,\"path\":\"\\index.htm\",\"host\":\"aliyun.com\"}
    IspCityNodesarray<object>

    Probe node list, detailed information can be obtained by calling ListCloudGtmMonitorNodes.

    IspCityNodeobject

    Probe node

    CountryCodestring

    Country Code

    		629
    CountryNamestring

    Country Name

    		China
    CityCodestring

    City code

    		357
    CityNamestring

    City name

    		Shanghai
    GroupTypestring

    Probe node group types:

    • BGP: BGP nodes
    • OVERSEAS: International nodes
    • ISP: Carrier nodes
    		BGP
    GroupNamestring

    Probe node group type name

    		BGP Nodes
    IspCodestring

    Operator Code

    		465
    IspNamestring

    Operator Name

    		Alibaba
    Remarkstring

    Remarks for the health check template.

    		test

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "6AEC7A64-3CB1-4C49-8B35-0B901F1E26BF",
  "TemplateId": "mtp-89518052425100**80",
  "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": "629",
        "CountryName": "China",
        "CityCode": "357",
        "CityName": "Shanghai",
        "GroupType": "BGP",
        "GroupName": "BGP Nodes",
        "IspCode": "465",
        "IspName": "Alibaba"
      }
    ]
  },
  "Remark": "test"
}

    Error codes

    For a list of error codes, visit the Service error codes.