Query API
This page describes the API for querying the data from Apica Ascent Observability stack
Getting data is a two step process
Create a Query Request
POST /v1/query will respond with a QueryId. Use that to access data
Use GET /v1/data/{queryId}/next and GET /v1/data/{queryId}/previous to retrieve data.
Query API Documentation
Version: 1.0
/v1/query
POST
Parameters
body
body
Yes
Responses
Code
Description
Schema
200
A successful response.
/v1/data/{queryId}/next
GET
Parameters
queryId
path
Yes
string
Responses
200
A successful response.
400
Invalid Request.
403
Token Expired.
404
Returned when the resource does not exist.
/v1/data/{queryId}/previous
GET
Parameters
queryId
path
Yes
string
_internal
query
No
boolean (boolean)
Responses
200
A successful response.
400
Invalid Request.
403
Token Expired.
404
Returned when the resource does not exist.
protobufAny
A
Example 2: Pack and unpack a message in Java.
Example 3: Pack and unpack a message in Python.
Example 4: Pack and unpack a message in Go
The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".
JSON
The JSON representation of an Any
value uses the regular representation of the deserialized, embedded message, with an additional field @type
which contains the type URL. Example:
If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field value
which holds the custom JSON in addition to the @type
field. Example (for message [google.protobuf.Duration][]):
queryFilterValues
values
[ string ]
No
queryGetDataResponse
data
No
Status
string
No
remaining
integer
No
queryGetQueryResponse
queryId
string
No
info
No
errors
No
meta
object
No
queryOrderBy
queryOrderBy
string
queryQueryErrors
Key
string
No
message
string
No
queryQueryInfo
Key
string
No
message
string
No
queryQueryProperties
applicationNames
[ string ]
No
filters
object
No
namespace
string
No
pageSize
long
No
startTime
string
No
endTime
string
No
keyWord
string
No
querySysLogMessage
ID
string
No
AppName
string
No
Facility
string
No
FacilityString
string
No
Hostname
string
No
Message
string
No
MsgID
string
No
PartitionID
string
No
Priority
string
No
ProcID
string
No
Sender
string
No
Severity
string
No
SeverityString
string
No
StructuredData
string
No
Tag
string
No
Timestamp
string
No
Namespace
string
No
runtimeError
error
string
No
code
integer
No
message
string
No
Last updated