[{"label":"Latest (v1)","version":"latest"}]
vrealize-log-insight-cloud-service

Post Query Request

Description

Creates a log query

Request

Request

URL

URL


post
https://{api_host}/vrlic/api/v1/query
Copy

Header Parameters

Header Parameters

string
query-agent Optional

Request Body

Request Body

LogQueryRequestDto of mimetype application/json Required
{
    "logQuery": "SELECT * FROM logs ORDER BY ingest_timestamp DESC"
}
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[string][]map[string]string
archiveConfigIds Optional

Temporary to support low cost queries till archive configs are added as partitions in lint-control-plane


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)


string
clientOrgId Optional

OrgId for which telemetry data is to be queried


extractedFieldsEvaluation Optional

Default extracted field evaluation


string
callbackUrl Optional

Callback URL called when query is complete


integer as int32
parallelizationFactor Optional

Only used for low cost queries. Strictly for internal use (Will not be exposed to the user) Number of data planes the query should run on


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


integer as int32
rows Optional

Number of rows to be returned


string
callbackPayload Optional

Payload sent to callbackUrl


string
sub Optional

Subject to filter based on specified user


boolean
tenantAgnostic Optional

array of string
tenantLinks Optional

Authorization links associated with this request

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",
	"createdAt": "string",
	"createdBy": "string",
	"currentPageNumber": 0,
	"documentSelfLink": "string",
	"dynamicFields": [
		{
			"constraints": {
				"constraints": [
					{
						"fieldName": "text",
						"operator": "CONTAINS",
						"value": "error"
					}
				],
				"fieldName": "string",
				"operator": "AND",
				"tags": [
					"string"
				],
				"value": "string"
			},
			"contentPackId": "string",
			"createdAt": "string",
			"createdBy": "string",
			"fieldType": "string",
			"fullRegex": "string",
			"id": "string",
			"internalName": "string",
			"lastUpdatedAt": "string",
			"lastUpdatedBy": "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",
	"parallelizationFactor": 0,
	"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"
	},
	"tenantAgnostic": false,
	"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 links


number as double
bytesQueried Optional

Total size of high-cost queries


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


string
createdAt Optional

ISO8601 date string that informs when this query was created


string
createdBy Optional

Email ID of the user who created this query


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)


integer as int64
bytesProcessed Optional

Number of bytes processed after being uncompressed


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


map[string][]map[string]string
archiveConfigIds Optional

Temporary to support low cost queries till archive configs are added as partitions in lint-control-plane


array of string
logQueryResults Optional

Unprocessed query results from the control plane query at the most recent retrieval call


logQueryTelemetry Optional

Log query telemetry data


string
nextPageLink Optional

Link to the next page


integer as int32
parallelizationFactor Optional

Only used for low cost queries. Strictly for internal use (Will not be exposed to the user) Number of data planes the query should run on


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


boolean
tenantAgnostic Optional

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 -X POST -H "query-agent: string" -H "Content-Type: application/json" -d '{"logQuery":"SELECT * FROM logs ORDER BY ingest_timestamp DESC"}' https://{api_host}/vrlic/api/v1/query


[{"label":"Latest (v1)","version":"latest"}]
vrealize-log-insight-cloud-service
Feedback

Was this page helpful?