All Products
Search
Document Center

Alibaba Cloud DNS:UpdateDnsGtmMonitor

Last Updated:Oct 24, 2024

Modifies a health check task.

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:
    • The required resource types are displayed in bold characters.
    • 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:UpdateDnsGtmMonitorupdate
  • MonitorConfig
    acs:alidns:*:{#accountId}:gtminstance/{#InstanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
LangstringNo

The language of the values of specific response parameters. Default value: en. Valid values: en, zh, and ja.

en
MonitorConfigIdstringYes

The ID of the health check configuration.

MonitorConfigId1
ProtocolTypestringYes

The protocol used for the health check. Valid values:

  • HTTP
  • HTTPS
  • PING
  • TCP
http
IntervalintegerNo

The health check interval. Unit: seconds.

60
EvaluationCountintegerNo

The maximum number of consecutive exceptions detected. If the number of consecutive exceptions detected reaches the maximum number, the application service is deemed abnormal.

2
TimeoutintegerNo

The timeout period. Unit: milliseconds.

3000
MonitorExtendInfostringYes

The extended information. The required parameters vary based on the health check protocol.

  • HTTP or HTTPS

    • port: the port that you want to check

    • host: the host settings

    • path: the URL path

    • code: the return code. If the return value of code is greater than the specified value, the health check result is deemed abnormal. For example, if code is set to 400 and the code 404 is returned, the health check result is deemed abnormal.

    • failureRate: the failure rate

    • sni: specifies whether to enable server name indication (SNI). This parameter is available only when ProtocolType is set to HTTPS. Valid values:

      • true: enables SNI.
      • false: disables SNI.
    • nodeType: the type of the monitoring node when the address pool type is domain name. Valid values:

      • IPV4
      • IPV6
  • PING

    • failureRate: the failure rate

    • packetNum: the number of ping packets

    • packetLossRate: the loss rate of ping packets

    • nodeType: the type of the monitoring node when the address pool type is domain name. Valid values:

      • IPV4
      • IPV6
  • TCP

    • port: the port that you want to check

    • failureRate: the failure rate

    • nodeType: the type of the monitoring node when the address pool type is domain name. Valid values:

      • IPV4
      • IPV6
{\"code\":200,\"path\":\"\\index.htm\",\"host\":\"aliyun.com\"}
IspCityNodearray<object>Yes

The monitored nodes.

objectYes
CityCodestringNo

The code of the city where the monitored node is deployed.

123
IspCodestringNo

The code of the Internet service provider (ISP) to which the monitored node belongs.

123

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

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

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change timeSummary of changesOperation
No change history