All Products
Search
Document Center

Alibaba Cloud DNS:SetGtmMonitorStatus

Last Updated:Mar 15, 2024

You can call this operation to enable health check for an address pool of a Global Traffic Manager (GTM) instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:SetGtmMonitorStatusWRITE
  • gtmInstance
    acs:alidns::{#accountId}:gtminstance/{#instanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
LangstringNo

The language used by the user.

en
MonitorConfigIdstringYes

The health check ID.

abc1234
StatusstringYes

Specifies whether health check is enabled for the address pool. Valid values:

  • OPEN: Enabled
  • CLOSE: Disabled
OPEN

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.