You can call this operation to query logs of a Global Traffic Manager (GTM) instance.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeGtmLogs |
The operation that you want to perform. Set the value to DescribeGtmLogs. |
EndTimeStamp | Long | No | 1363453340000 |
The end of the time range to query. |
InstanceId | String | No | gtm-cn-xxxxx |
The ID of the GTM instance whose logs you want to query. |
Keyword | String | No | test |
The keyword for searching logs, in case-insensitive "%Keyword%" format. |
Lang | String | No | en |
The language used by the user. |
PageNumber | Integer | No | 1 |
The number of the page to return. Pages start from page 1. Default value: 1. |
PageSize | Integer | No | 20 |
The number of entries to return on per page. Maximum value: 100. Default value: 20. |
StartTimestamp | Long | No | 1363453340000 |
The beginning of the time range to query. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
Logs | Array |
The list of logs returned. |
|
Log |
The details about a log record. |
||
Content | String | addtest-pool-1 |
The formatted message content. |
EntityId | String | 121212 |
The ID of the object that was operated on. |
EntityName | String | test-pool-1 |
The name of the object that was operated on. |
EntityType | String | POOL |
The type of the object that was operated on. |
Id | Long | 6726 |
The ID of the log record. |
OperAction | String | add |
The operation performed. |
OperIp | String | 106.11.34.X |
The IP address subject to the operation. |
OperTime | String | 2018-01-24T07:35Z |
The time when the operation was performed. |
OperTimestamp | Long | 1516779348000 |
A timestamp that indicates the time when the operation was performed. |
PageNumber | Integer | 1 |
The page number of the returned page. |
PageSize | Integer | 20 |
The number of entries returned per page. |
RequestId | String | 50C60A29-2E93-425A-ABA8-068686E28873 |
The ID of the request. |
TotalItems | Integer | 224 |
The total number of entries returned on all pages. |
TotalPages | Integer | 224 |
The total number of pages returned. |
Examples
Sample requests
http(s)://alidns.aliyuncs.com/? Action=DescribeGtmLogs
&<Common request parameters>
Sample success responses
XML
format
<DescribeGtmLogsResponse>
<Logs>
<Content>addtest-pool-1</Content>
<EntityId>121212</EntityId>
<EntityName>test-pool-1</EntityName>
<Id>6726</Id>
<OperAction>add</OperAction>
<OperIp>106.11.34.X</OperIp>
<EntityType>POOL</EntityType>
<OperTime>2018-01-24T07:35Z</OperTime>
<OperTimestamp>1516779348000</OperTimestamp>
</Logs>
<PageNumber>1</PageNumber>
<PageSize>1</PageSize>
<RequestId>50C60A29-2E93-425A-ABA8-068686E28873</RequestId>
<TotalItems>224</TotalItems>
<TotalPages>224</TotalPages>
</DescribeGtmLogsResponse>
JSON
format
{
"PageNumber":1,
"logs": [
{
"OperTimestamp":1516779348000
"OperAction":"add",
"EntityType":"POOL",
"OperIp":"106.11.34.X",
"OperTime":"2018-01-24T07:35Z",
"Id":6726,
"EntityName":"test-pool-1",
"Content":"addtest-pool-1",
"EntityId":"121212"
}
],
"PageSize":1,
"RequestId":"50C60A29-2E93-425A-ABA8-068686E28873",
"TotalItems":224,
"TotalPages":224
}
Error codes
For a list of error codes, visit the API Error Center.