- URL:
- https://<root>/logs/query
- Methods:
GET- Version Introduced:
- 10.1
Access requirements
Required privileges
The Sever Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.
Note that administrators assigned a custom role must also have the administrative View all content privilege assigned to them to access the API directory as an administrator. Additonally, any custom roles that include a webhook-related privilege must also include the general Publish server-based layers content privilege.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Server Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.
Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generate operation in the Portal Directory API. For security reasons, all POST requests made to the Server Administrator API must include a token in the request body.
Description
The query operation provides a way to aggregate, filter, and page through logs across the entire ArcGIS Server site.
Request parameters
| Parameter | Details |
|---|---|
| The most recent time to query. If the Example |
| The oldest time to include in the result set. You can use this to limit the query to the last few minutes or hours as needed. Example |
| Only records with a log level at or more severe than this level are returned. The default value is Values: |
(Required) | Specifies that the filter Example |
(Required) | Filtering provides flexibility and specificity by combining any of the filter properties, each given as a comma-separated list. Example |
| The maximum number of log records to be returned by this query. The default messages per page is 1000. The limit is 10000 records. Example |
| The response format. The default value is Values: |
Filter properties
| Property | Description |
|---|---|
(Optional) | Specifies the log codes assigned to server logs. To query all codes, set the value to Example |
(Optional) | Specifies the machine process IDs to query. To query logs from all process IDs, set the value to Example |
(Optional) | Specifies an ID assigned to a specific server request. Example |
(Optional) | Specifies the server components delivering the log message. To query logs from all components, set the value to Values: |
(Optional) | Specifies whether to query all, none, or a specific service in your site. To query logs from all services, set the value to Example |
(Optional) | Specifies whether to query all or a specific machine in your server sit. To query logs from all machines, set the value to Example |
Example usage
The following is a sample GET request for the query operation.
https://organization.example.com/<context>/admin/logs/query?startTime=1310165288&endTime=1310125087&level=INFO&filterType=json&filter={"codes": [8271, 9003], "processIds": [4392, 9816], "requestIds": ["a1fc28db-4575-4a09-84df-7b313c239e5b", "22d8113a-e229-4e48-8fe4-008a5037fcba"], "services": ["Pro_mapimage.MapServer"], "machines": ["machine.example.com"]}&pageSize=1000&f=pjsonJSON Response example
{
"hasMore": true,
"startTime": 1310165288,
"endTime": 1310125087,
"logMessages": [
{
"type": "INFO",
"message": "Service has been successfully created in the server context.",
"time": 1311101673947,
"source": "Server",
"machine": "MACHINE.EXAMPLE.COM",
"user": "",
"code": 8271,
"elapsed": "",
"process": "4392",
"thread": "1",
"methodName": "",
"requestID": "a1fc28db-4575-4a09-84df-7b313c239e5b"
},
{
"type": "INFO",
"message": "Unable to process request. Service ByRef2/MapServer not found ",
"time": 1540338505127,
"source": "Rest",
"machine": "MACHINE.EXAMPLE.COM",
"user": "",
"code": 9003,
"elapsed": "",
"process": "9816",
"thread": "1",
"methodName": "",
"requestID": "22d8113a-e229-4e48-8fe4-008a5037fcba"
}
]
}