Get instance summaries for a request ID
get
/serviceapi/apm.dataserver/api/v1/requests/{id}/instances
Retrieve a list of instance summary meta data for instances of a known request ID
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
ID of request (see Get requests or similar). For more information see Object ID Parameters.
Query Parameters
-
aggregationPeriod(optional): integer(int32)
Aggregation period applied to time range between the
since
anduntil
parameters. This parameter's value is in 1-minute units. The default aggregation period is 1 minute.Default Value:-1
-
limit(optional): integer(int32)
Maximum number of elements in the result set, useful for paging [default = all, max = 1000]. For more information see Paging.
-
offset(optional): integer(int32)
Offset into result set at which to start returning data, useful for paging [default = 0].
-
orderBy(optional): string
Comma-separated list of one or more attributes by which the result set is ordered [default = null]. For more information see Sorting. Use
attribute
orattribute:asc
orattribute:desc
. Valid attributes can be found by using Get resource metadata withmetadataType
=OrderBy
andmetadataQuery
resource =/instances
-
q(optional): string
Query clause of one or more predicates to restrict the result set to those objects satisfying the clause [default = null]. For more information see Filtering. Use query like predicates, such as
attribute<=value< code>. Multiple predicates should be parenthesized and joined by
AND
orOR
. Valid attributes can be found by using Get resource metadata withmetadataType
=Filter
andmetadataQuery
resource =/instances
=value<> -
samplePercentage(optional): integer(int32)
Sample percentage of the data retrieved [default = 100%]Default Value:
100
-
since: string
Retrieve results from start of time period, format
yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
(e.g.2015-11-23T22:11:05.000Z
). For more information see Since and Until Time Range. -
until: string
Retrieve results until end of time period, format
yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
Response
Supported Media Types
- application/json
200 Response
Completed successfully, list may be empty. See Status Codes for information about other possible HTTP response status codes.
Root Schema : schema
Type:
Show Source
array
-
Array of:
object InstanceSummary
Instance Summary meta data (InstanceSummary)
Nested Schema : InstanceSummary
Type:
object
Instance Summary meta data (InstanceSummary)
Show Source
-
abridged(optional):
boolean
Default Value:
false
-
appServerTime(optional):
integer(int64)
-
bucketCount(optional):
integer(int64)
-
bucketNumber(optional):
integer(int64)
-
databaseTime(optional):
integer(int64)
-
duration(optional):
integer(int64)
-
durationNumbering(optional):
integer(int64)
-
ecid(optional):
string
-
endFaultDetailsAvailable(optional):
boolean
Default Value:
false
-
endTime(optional):
integer(int64)
-
externalTime(optional):
integer(int64)
-
faultCount(optional):
integer(int64)
-
faultNumbering(optional):
integer(int64)
-
formattedEndTime(optional):
string
-
formattedStartTime(optional):
string
-
globalInstanceId(optional):
string
-
instanceCpu(optional):
number(double)
-
instanceId(optional):
string
-
instanceMemory(optional):
number(double)
-
isEndedInFault(optional):
boolean
Default Value:
false
-
linkCollection(optional):
array linkCollection
See Links to Related Resources for more information
-
linkCount(optional):
integer(int64)
-
queryTimeRange(optional):
object TimeRange
-
sampleReason(optional):
string
-
startTime(optional):
integer(int64)
-
totalSnapshots(optional):
integer(int32)
-
warnings(optional):
array warnings
Informational or Error messages
Nested Schema : linkCollection
Type:
array
See Links to Related Resources for more information
Show Source
-
Array of:
object Link
Information about a Link to a resource
Nested Schema : TimeRange
Type:
Show Source
object
-
sinceTime(optional):
integer(int64)
Results are returned *since* this timestamp
-
timeInMinutes(optional):
integer(int64)
-
untilTime(optional):
integer(int64)
Results are returned *until* this timestamp
Nested Schema : warnings
Type:
array
Informational or Error messages
Show Source
-
Array of:
object ErrorMessage
An error message
Nested Schema : Link
Type:
object
Information about a Link to a resource
Show Source
-
baseUrl(optional):
string
The base URL for the link
-
href:
string
The href portion of the link
-
post(optional):
string
The post data of the link
-
rel:
string
The relationship name of the link
Nested Schema : ErrorMessage
Type:
object
An error message
Show Source
-
detail:
string
A detailed description of the error
-
errorType(optional):
string
Allowed Values:
[ "INFO", "WARNING", "VALIDATION", "ERROR" ]
The error type -
message:
string
The error message