DescribeGtmLogs - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Queries a list of 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:DescribeGtmLogs

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the response.	en
InstanceId	string	No	The ID of the instance.	gtm-cn-xxxxx
Keyword	string	No	The keyword for a fuzzy search. The search uses the %Keyword% pattern and is case-insensitive.	test
PageNumber	integer	No	The number of the page to return. The value starts from 1. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Maximum value: 100. Default value: 20.	20
StartTimestamp	integer	No	The beginning of the time range to query. This value is a UNIX timestamp.	1363453340000
EndTimestamp	integer	No	The end of the time range to query. This value is a UNIX timestamp.	1363453340000

Response elements

Element	Type	Description	Example
	object
PageSize	integer	The number of entries returned per page.	20
RequestId	string	The ID of the request.	50C60A29-2E93-425A-ABA8-068686E28873
PageNumber	integer	The page number of the returned page.	1
TotalPages	integer	The total number of pages returned.	224
Logs	object
Log	array<object>	The list of logs.
	object
OperTimestamp	integer	The time when the operation was performed. This value is a UNIX timestamp.	1516779348000
EntityId	string	The ID of the object on which the operation was performed.	121212
EntityType	string	The type of the object on which the operation was performed.	POOL
OperTime	string	The time when the operation was performed.	2018-01-24T07:35Z
OperIp	string	The IP address from which the operation was initiated.	106.11.34.X
OperAction	string	The action performed.	add
Content	string	The formatted content of the message.	addtest-pool-1
EntityName	string	The name of the object on which the operation was performed.	test-pool-1
Id	integer	The ID of the record.	6726
TotalItems	integer	The total number of entries returned.	224

Examples

Success response

JSON format

{
  "PageSize": 20,
  "RequestId": "50C60A29-2E93-425A-ABA8-068686E28873",
  "PageNumber": 1,
  "TotalPages": 224,
  "Logs": {
    "Log": [
      {
        "OperTimestamp": 1516779348000,
        "EntityId": "121212",
        "EntityType": "POOL",
        "OperTime": "2018-01-24T07:35Z",
        "OperIp": "106.11.34.X",
        "OperAction": "add",
        "Content": "addtest-pool-1",
        "EntityName": "test-pool-1",
        "Id": 6726
      }
    ]
  },
  "TotalItems": 224
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.