Updates a health check template based on the specified parameters.
Try it now
Test
RAM authorization
|
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:
|
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:
|
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:
|
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:
|
50 |
| ExtendInfo |
string |
No |
The extended information in a JSON string. The parameters vary based on the health check protocol.
|
{\"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 |
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.