All Products
Search
Document Center

Alibaba Cloud DNS:UpdateCloudGtmMonitorTemplate

Last Updated:Dec 03, 2025

Updates a health check template based on the specified parameters.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

alidns:UpdateCloudGtmMonitorTemplate

update

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

AcceptLanguage

string

No

The language of the response. Valid values:

  • zh-CN: Chinese

  • en-US (default): English

en-US

ClientToken

string

No

A client-generated token that is used to ensure the idempotence of the request. Make sure that the token is unique for each request. The token can be up to 64 ASCII characters in length.

1ae05db4-10e7-11ef-b126-00163e24****

TemplateId

string

Yes

The unique ID of the health check template that you want to modify.

mtp-89518052425100****

Name

string

No

The name of the health check template. For easy identification, name the template based on its health check protocol.

Ping-IPv4

Interval

integer

No

The interval between health checks in seconds. The default value is 60. The minimum interval is 15 seconds. This feature is available only for Ultimate Edition instances.

60

Timeout

integer

No

The timeout period for a health check in milliseconds. If a packet is not returned within the specified timeout period, the health check fails. Valid values:

  • 2000

  • 3000

  • 5000

  • 10000

5000

EvaluationCount

integer

No

The number of consecutive health check failures that must occur before an application service is considered abnormal. This helps prevent false alarms caused by transient issues such as network jitter. Valid values:

  • 1

  • 2

  • 3

2

FailureRate

integer

No

The percentage of failed detection points. An endpoint is considered abnormal if the percentage of detection points that fail the health check exceeds this threshold. Valid values:

  • 20

  • 50

  • 80

  • 100

50

ExtendInfo

string

No

The extended information in a JSON string. The parameters vary based on the health check protocol.

  • HTTP and HTTPS:

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

    path: The path for the HTTP or HTTPS health check. The default value is /.

    code: When you perform an HTTP or HTTPS health check, the system uses the return code from the web server to determine its status. If the return code exceeds the specified threshold, the application service is considered abnormal.

    • 400: Bad Request. If an HTTP or HTTPS request contains invalid parameters, the web server returns a code greater than 400. If you set the threshold to 400, make sure that you specify the exact URL path.

    • 500: Server Error. If the web server encounters an error, it returns a code greater than 500. The default threshold is 500.

    sni: Specifies whether to enable Server Name Indication (SNI). This parameter is used only for HTTPS health checks. SNI is an extension to the Transport Layer Security (TLS) protocol. It allows a client to specify the hostname it is trying to connect to at the start of the TLS handshake. Because the TLS handshake occurs before any HTTP data is sent, SNI allows the server to know which service the client is trying to access before sending the certificate. This enables the server to present the correct certificate to the client.

    • true: Enable SNI.

    • false: Disable SNI.

    followRedirect: Specifies whether to follow 3xx redirections.

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

    • false: Do 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 triggers an alarm. For each ping health check, the system calculates the packet loss rate. Packet loss rate = (Number of lost packets / Total number of sent ICMP packets) × 100%. An alarm is triggered if the packet loss rate reaches this threshold. Valid values: 10, 30, 40, 80, 90, and 100.

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

IspCityNodes

array<object>

No

The list of detection points. Call ListCloudGtmMonitorNodes to obtain the information.

object

No

A detection point.

CityCode

string

No

The city code of the detection point.

503

IspCode

string

No

The carrier code of the detection point.

465

Response elements

Element

Type

Description

Example

object

RequestId

string

The unique request ID.

6856BCF6-11D6-4D7E-AC53-FD579933522B

Success

boolean

Indicates whether the operation was successful.

  • true: The operation was successful.

  • false: The operation failed.

true

Examples

Success response

JSON format

{
  "RequestId": "6856BCF6-11D6-4D7E-AC53-FD579933522B",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.