ListCloudGtmAlertLogs - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Queries a list of alert logs.

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:ListCloudGtmAlertLogs

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the response. zh-CN: Chinese en-US: English	zh-CN
ActionType	string	No	The alert type. ALERT: An alert is triggered. RESUME: The service has recovered.	ALERT
EntityType	string	No	The alert object. GTM_ADDRESS: Address GTM_ADDRESS_POOL: Address pool GTM_INSTANCE: Instance GTM_MONITOR_TEMPLATE: Health check template	GTM_ADDRESS
Keyword	string	No	The keyword for the search. This is usually an address ID, address pool ID, or domain name.	pool-895280232254422016
StartTimestamp	integer	Yes	The start of the time range to query. This is a UNIX timestamp.	1611328826977
EndTimestamp	integer	Yes	The end of the time range to query. This is a UNIX timestamp.	1711328826977
PageNumber	integer	Yes	The current page number. The value starts from 1. The default value is 1.	1
PageSize	integer	Yes	The number of entries to return on each page for a paged query. The maximum value is 100. The default value is 20.	20

Response elements

Element	Type	Description	Example
	object
RequestId	string	The unique request ID.	536E9CAD-DB30-4647-AC87-AA5CC38C5382
PageNumber	integer	The current page number. The value starts from 1. The default value is 1.	1
PageSize	integer	The number of entries returned on each page. The maximum value is 100. The default value is 20.	20
TotalPages	integer	The total number of pages.	1
TotalItems	integer	The total number of alert logs.	15
Logs	object
Log	array<object>	The list of alert logs.
	object	The alert log information.
ActionType	string	The alert type. ALERT: An alert is triggered. RESUME: The service has recovered.	ALERT
EntityType	string	The alert object. GTM_ADDRESS: Address GTM_ADDRESS_POOL: Address pool GTM_INSTANCE: Instance GTM_MONITOR_TEMPLATE: Health check template	GTM_ADDRESS
Content	string	The alert content.	"Pool name：华东\nType：IPv4\nReason: Normal health determination\nNumber of addresses in the pool : 2\nAbnormal address: --\nDetermination conditions : Any address in the addresspool is available address\nAffected domain names: www.cloud-example.com"
Timestamp	integer	The time when the alert log was generated. This is a UNIX timestamp.	1711328826977

Examples

Success response

JSON format

{
  "RequestId": "536E9CAD-DB30-4647-AC87-AA5CC38C5382",
  "PageNumber": 1,
  "PageSize": 20,
  "TotalPages": 1,
  "TotalItems": 15,
  "Logs": {
    "Log": [
      {
        "ActionType": "ALERT",
        "EntityType": "GTM_ADDRESS",
        "Content": "\"Pool name：华东\\nType：IPv4\\nReason: Normal health determination\\nNumber of addresses in the pool : 2\\nAbnormal address: --\\nDetermination conditions : Any address in the addresspool is available address\\nAffected domain names: www.cloud-example.com\"",
        "Timestamp": 1711328826977
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.