[{"label":"Latest (v1)","version":"latest"}]
vmware-aria-operations-for-logs

Get Query Response

Description

Gets a log query by id

Request

Request

URL

URL


get
https://{api_host}/vrlic/api/v1/query/{id}
Copy

Path Parameters

Path Parameters

string
id Required

Query Id


Query Parameters

Query Parameters

string
nextPage Optional

It represents the next page of the query results


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns LogQueryResponse of type */*
{
	"aggregateRecordCount": 0,
	"bytesProcessed": 0,
	"bytesQueried": 0,
	"bytesReturned": 0,
	"bytesScanned": 0,
	"callbackPayload": "string",
	"callbackUrl": "string",
	"clientOrgId": "string",
	"currentPageNumber": 0,
	"documentSelfLink": "string",
	"dynamicFields": [
		{
			"constraints": {
				"constraints": "QueryConstraint Object",
				"fieldName": "string",
				"operator": "AND",
				"tags": [
					"string"
				],
				"value": "string"
			},
			"contentPackId": "string",
			"fieldType": "string",
			"fullRegex": "string",
			"id": "string",
			"internalName": "string",
			"name": "string",
			"orgId": "string",
			"postValue": "string",
			"preValue": "string",
			"sampleMessage": "string",
			"shortName": "string",
			"smartFieldId": "string",
			"value": "string"
		}
	],
	"end": 0,
	"extractedFieldsEvaluation": {
		"contentPackIdsToInclude": [
			"string"
		],
		"includeAllFields": false
	},
	"failureMessage": "string",
	"id": "string",
	"logQuery": "string",
	"logQueryResults": [
		"string"
	],
	"logQueryTelemetry": {
		"aggregateQuery": false,
		"dynamicFieldsQuery": false,
		"errorMessage": "string",
		"indexType": "INDEXED",
		"lintAppEndTime": 0,
		"lintAppStartTime": 0,
		"logQuery": "string",
		"numberOfCoresQueried": 0,
		"numberOfExtractedFieldsEvaluated": 0,
		"orgId": "string",
		"partitionIdsInRequest": [
			"string"
		],
		"queryAgent": "UI_DASHBOARDS",
		"queryConstraintStr": "string",
		"queryEndTime": 0,
		"queryExecutionTime": 0,
		"queryPostProcessingTime": 0,
		"queryRange": 0,
		"queryStartTime": 0,
		"requestId": "string",
		"storageState": "string",
		"subscriptionType": "PRE_TRIAL",
		"taskStage": "CREATED",
		"tenantId": "string",
		"totalSizeQueriedBytes": 0,
		"type": "EVENTS",
		"userName": "string"
	},
	"nextPageLink": "string",
	"partialResults": false,
	"partitionIds": [
		"string"
	],
	"processedResults": [
		{
			"annotations": [
				{
					"description": "string",
					"name": "string",
					"url": "string"
				}
			],
			"data": {
				"key": "string"
			},
			"positions": {
				"key": {
					"length": 0,
					"start": 0
				}
			},
			"supplementalData": {
				"key": "string"
			}
		}
	],
	"queryProgress": {
		"coresClosed": "string",
		"coresRequested": "string",
		"coresResponded": "string",
		"failureMessage": "string",
		"numCoresClosed": 0,
		"numCoresRequested": 0,
		"numCoresResponded": 0,
		"queryElapsedTimeMillis": 0,
		"queryPercentComplete": 0,
		"queryRemainingTimeMillis": 0,
		"queryStartTimeMillis": 0,
		"subQueriesComplete": 0,
		"subQueriesTotal": 0,
		"trackerId": "string"
	},
	"rows": 0,
	"start": 0,
	"sub": "string",
	"taskInfo": {
		"durationMicros": 0,
		"failure": {
			"statusCode": 0
		},
		"isDirect": false,
		"stage": "CREATED"
	},
	"tenantLinks": [
		"string"
	],
	"totalMatchedRecordCount": 0,
	"totalRecordCount": 0,
	"trackerId": "string"
}
integer as int64
end Required

End timestamp (milliseconds) for the query to be run


integer as int64
start Required

Start timestamp (milliseconds) for the query to be run


string
logQuery Required

SQL query to be executed


map
_links Optional

A simple implementation of HAL(Hypertext Application Language) formatted HATEOAS(Hypermedia as the Engine of Application State) links. The principle implies that the API should guide the client through the application by returning relevant information about the next potential steps, along with each response.


integer as int64
bytesReturned Optional

Number of bytes of records of payload data returned by Amazon S3 based on filter conditions


integer as int64
bytesScanned Optional

Number of bytes processed before being uncompressed


string
callbackPayload Optional

Payload sent to callbackUrl


string
callbackUrl Optional

Callback URL called when query is complete


string
clientOrgId Optional

OrgId for which telemetry data is to be queried


integer as int32
currentPageNumber Optional

Page number for current page of results, set when constructing a query during next page handling.


string
documentSelfLink Optional

Relative URI path of the service managing this document. Can be a complete link, or just a request ID.


dynamicFields Optional

Dynamic fields that need to be used in the SQL query (without creating extracted fields)


number as double
bytesQueried Optional

Total size of high-cost queries


extractedFieldsEvaluation Optional

Default extracted field evaluation


string
failureMessage Optional

This message indicates failure if query processing fails


string
id Optional

A unique identifier associated with the log query


integer as int64
bytesProcessed Optional

Number of bytes processed after being uncompressed


array of string
logQueryResults Optional

Unprocessed query results at the most recent retrieval call


logQueryTelemetry Optional

Log query telemetry data


string
nextPageLink Optional

Query responses are returned in several pages and you can fetch one page at a time. This field represents the link to the next page.


boolean
partialResults Optional

Indicates whether or not the results are a complete set. The field is set if the EOF record is returned from the data platform and contains the field is_result_partial


array of string
partitionIds Optional

PartitionIds from where we need the response. This might be removed once we figure out an intelligent way to distinguish the partitions from the query constraints. This is done for testing the partition flow for query


processedResults Optional

Query results after processing


queryProgress Optional

Query progress data


integer as int32
rows Optional

Number of rows to be returned


integer as int64
aggregateRecordCount Optional

For aggregated queries: Total number of records returned in the response,For non-aggregated queries: This field is not set


string
sub Optional

Subject to filter based on specified user


taskInfo Optional

The state used to track the progress of the query task. This value should not be modified


array of string
tenantLinks Optional

Authorization links associated with this request


integer as int64
totalMatchedRecordCount Optional

Total number of records that matched the query. This is not necessarily the number of records returned in the response


integer as int64
totalRecordCount Optional

For non-aggregated queries: Total number of records returned in the response,For aggregated queries: Total number of records before aggregation was applied


string
trackerId Optional

Tracker identifier to track execution

No error details were provided in the OpenAPI specification.

Code Samples

Code Samples

cURL Command

curl https://{api_host}/vrlic/api/v1/query/{id}


[{"label":"Latest (v1)","version":"latest"}]
vmware-aria-operations-for-logs
Feedback

Was this page helpful?