Raw Query Sample Report
The Advanced Raw Queries report includes copious data for both queries and responses. This report can provide details for query and response troubleshooting. For more details about reports, review the Report Center User Guide.
Requesting Raw Query Sample Report
Method and URI:
POST https://api.ultradns.com/reports/dns_resolution/sample/raw_queryHTTP/1.1
OR
POST https://api.ultradns.com/reports/dns_resolution/sample/raw_query?offset={offset}&limit={limit}
Parameters: May contain the following:
Raw Query Sample Parameters
Parameter |
Description |
Type |
---|---|---|
offset |
This field is optional. If not specified, initial records will always be returned specified to limit. This parameter allows pagination on the reporting records retrieved. The offset will be the integer value that specifies the position of first result to be retrieved. Specify offset as 0 for first results to be retrieved. |
Integer. Optional. |
limit |
This field is optional. If not specified, the total number of records returned in the response will be equal to the default value 1000. This parameter allows pagination on the reporting records retrieved. The maximum number of results to be retrieved in a single response is 10,000 records. |
Integer. Optional. |
Body: Must contain a Raw Query Sort DTO.
Raw Query Report DTO
Field |
Description |
Type |
---|---|---|
accountName |
The name of the account. |
String. Required. |
zoneName |
The results of the one zone being returned.
|
String. Optional |
packetStartDateTime |
The packetStartDateTime must be supplied in the ISO 8601 UTC format (yyyy-MM-dd’T’HH:mm:ss.SSSZ).
|
Date-Time. Optional |
packetEndDateTime |
The packetEndDateTime must be supplied in the ISO 8601 UTC format (yyyy-MM-dd’T’HH:mm:ss.SSSZ).
|
Date-Time. Optional. |
Responses: If task completes, Status Code 201 is returned with a requestId in the response body.
Errors: An error code is returned under the following conditions:
-
Error Code 401 – “Unauthorized. Token not found, expired or invalid.”
-
Error Code 400 – “packetEndDateTime is before packetStartDateTime.”
-
Error Code 400 – “Date provided is not in a valid format.”
-
Error Code 400 – “Account name not provided.”
-
Error Code 400 – “packetStartDateTime/packetEndDateTime is a future date.”
-
Error Code 400 – “Offset value is a negative value.”
-
Error Code 400 – “packetStartDateTime is older than 90 days.”
JSON Example: Raw Query Sample Request
{
"rawQuerySample":
{
"accountName":"teamrest",
"packetStartDateTime":" 2017-08-09T10:25:00Z",
"packetEndDateTime":" 2017-08-11T10:10:00Z",
"zoneName": "apexcnamedemo1.com."
}
}
Retrieving Raw Query Sample Report
Method and URI:
GET https://ai.ultradns.com/requests/{requestID}
Parameters: Must contain a ReportRequest DTO
Body: None
Response: If task completes, Status Code 200 OK is returned with a Raw Query Sample Report Output DTO in the response body. Each value is comma-separated.
Errors: An error code is returned under the following conditions:
-
Error Code 401 – “Unauthorized. Token not found, expired or invalid.”
-
Error Code 404 – “No report with the given ID was requested before.”
Report Request ID DTO
The requestID is a randomly generated ID of letters and numbers sent to the user after the successful request for a report.
Field |
Description |
Type |
requestID |
The requestID that is provided to the user once a request for a report has been made.
|
String. |
JSON Example: Request ID return
Status 201 Created
{
"requestId": "PQV-d5a4c7ce"
}
Raw Query Sample Report Output DTO
Response Body |
Description |
Type |
---|---|---|
accountName |
The name of the Account being queried. |
String. |
udpTcpIndicator |
Will return either UDP or TCP. |
String. |
tldSldIndicator |
Will return Top Level Domain or Server Level Domain value of either TLD or SLD server. |
String. |
queryResponseIndicator |
The Query response indicator. Will return either Query or Response. |
String. |
responseMicroSet |
Will return either the response in micro seconds or a NULL value if a response is not matched to a query. |
Integer. |
ucapPacketErr |
Packet parsing error in ucap. Will return: |
Integer. |
resolverPort |
The Resolver port. |
Integer. |
resolverIP |
The Resolver IP in binary. |
Integer. IP address. |
truncatedIndicator |
The Truncation indicator: |
Integer. |
recursionDesired |
The Recursion desired indicator. 1=True |
Integer. |
recursionAvailable |
The Recursive available indicator. 1=True |
Integer. |
rcode |
The Response Code: |
Integer. |
qdcount |
The query count. |
Integer. |
packetId |
Packet identifier. This unique identifier is produced in the capture application from a timestamp, node, and sequence number. |
Integer. |
packetDatetime |
Packet date/time. A timestamp when the packet was received by the capture process. |
Date-Time. |
opcode |
The query code: |
Integer. |
dnsMsgLength |
Length of the DNS message. Excludes ether/IP/UDP/TCP headers. |
Integer. |
dnsId |
The DNS Identifier. An ID generated by the client and returned by the resolver. |
Integer. |
clientPort |
The client port. |
Integer. |
clientIp |
Client IP in either binary. |
Integer. IP address |
checkingDisabled |
Checking disabled indicator: |
Integer. |
authenticDataIndicator |
Authentic data indicator: |
Integer. |
authenticAnswerIndicator |
Authoritative answer indicator: |
Integer. |
arcount |
The Additional Record count. |
Integer. |
ancount |
The Answer Record count. |
Integer. |
nscount |
The Authority record count. |
Integer. |
qname |
The query name. |
String. |
qtype |
The Query type. |
Integer. |
zoneName |
The Zone Name being queried. |
String. |
ipVersion |
The IP version being used by the zone. |
Integer. |
JSON Example: Retrieving Raw Query Sample Report
{
"accountName": "teamrest",
"udpTcpIndicator": "UDP",
"tldSldIndicator": "SLD",
"queryResponseIndicator": "Query",
"responseMicroSec": null,
"ucapPacketErr": 0,
"resolverPort": 53,
"resolverIp": "10.31.147.7",
"truncatedIndicator": 0,
"recursionDesired": 1,
"recursionAvailable": 0,
"rcode": 0,
"qdcount": 1,
"packetId": "6267557462119846686",
"packetDateTime": 2016-03-29T19:21:22.769Z,
"opcode": 0,
"dnsMessageLength": 47,
"dnsId": "64586",
"clientPort": 53194,
"clientIp": "10.33.162.158",
"checkingDisabled": 0,
"authenticDataIndicator": 1,
"authenticAnswerIndicator": 0,
"arcount": 1,
"ancount": 0,
"nscount": 0,
"qname": "apexcnamedemo1.com.",
"qtype": "A",
"zoneName": "apexcnamedemo1.com.",
"ipVersion": "4"
}
The Raw Query Sample Report can be returned in the .CSV format. See the Calling the APIssection for further details.
.CSV Example: Raw Query Sample Report
Account Name,UDP / TCP,TLD / SLD,Query / Response,Response Time (in μs),Ucap Packet Error,Resolver Port,Response IP,Truncated Indicator,Recursion Desired,Recursion Available,Response code,Question Record count,Packet Id,Packet Date Time,Opcode,DNS Message Length,DNS Id,Client Port,Client IP,Checking Disabled,Authentic Data Indicator,Authentic Answer Indicator,Additional Record Count,Answer Record Count,Namespace Record Count,QName,QType,Zone Name,IP Version
GTV8,UDP,SLD,Query,,0,53,204.74.108.1,0,1,0,0,1,6524704301611519106,2018-02-20T18:25:02.298Z,0,32,60455,39787,107.21.211.150,0,0,0,0,0,0,gmon-n.invalid.,SOA,gmon-n.invalid.,4
GTV8,UDP,SLD,Response,163,0,53,204.74.108.1,0,1,0,0,1,6524704301611519269,2018-02-20T18:25:02.298Z,0,143,60455,39787,107.21.211.150,0,0,1,0,1,1,gmon-n.invalid.,SOA,gmon-n.invalid.,4
GTV8,UDP,SLD,Query,,0,53,204.74.108.1,0,1,0,0,1,6524704305906574096,2018-02-20T18:25:03.385Z,0,32,37375,46677,107.21.211.150,0,0,0,0,0,0,gmon-n.invalid.,SOA,gmon-n.invalid.,4