Skip to content
API Enriched

External connector log query.

POST
/api/data/namespaces/{namespace}/site/{site}/external_connector/{external_connector}/logs
curl --request POST \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/data/namespaces/example/site/example/external_connector/example/logs \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "end_time": "example", "external_connector": "example", "label_filter": [ { "label": "LABEL_NONE", "op": "EQ", "value": "example" } ], "limit": 1, "namespace": "example", "site": "example", "start_time": "example" }'

Request to GET external connector logs that matches the criteria in request for a given namespace. The logs are per site per external connector is specified as match condition in the request to GET the logs for a external connector.

Examples of this operation.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
namespace
required
string

Namespace GET aggregation data for a given namespace.

site
required
string

Site Site where the K8s Cluster is running.

external_connector
required
string

External connector External connector for which logs has to be fetched.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
External Connector Request

Request to GET logs for a external connector.

object
end_time
end time

Fetch external connector logs whose timestamp <= end_time format: unix_timestamp|RFC 3339

Optional: If not specified, then the end_time will be evaluated to start_time+10m If start_time is not specified, then the end_time will be evaluated to

string
<= 1024 characters
external_connector
external connector

External connector for which logs has to be fetched.

string
<= 1024 characters
label_filter
Label Filter

List of label filter expressions of the form “label key” QueryOp “value”. Response will only contain data that matches all the conditions specified in the label_filter. For external connector logs, user can specify LABEL_EXTERNAL_CONNECTOR_IP & LABEL_EXTERNAL_CONNECTOR_NODE in the label_filter

Required: YES.

Array<object>
<= 5 items
Label Filter

Label Filter is used to filter th that match the logs specified label key/value and the operator.

object
label
string
default: LABEL_NONE
Allowed values: LABEL_NONE LABEL_EXTERNAL_CONNECTOR_IP LABEL_EXTERNAL_CONNECTOR_NODE
op
string
default: EQ
Allowed values: EQ NEQ
value
Value

Value of the label Required: YES.

string
>= 3 characters <= 256 characters
limit
Limit

Limits the number of results.

integer format: int64
namespace
namespace

GET aggregation data for a given namespace.

string
>= 6 characters <= 1024 characters
site
site

Site where the K8s Cluster is running.

string
<= 1024 characters
start_time
start time

Fetch external connector logs whose timestamp >= start_time format: unix_timestamp|RFC 3339

Optional: If not specified, then the start_time will be evaluated to end_time-10m If end_time is not specified, then the start_time will be evaluated to -10m.

string
<= 1024 characters

Responses

Section titled “Responses”

200

Section titled “200”

A successful response.

Media typeapplication/json
LogResponse

Response message for AuditLogRequest/AccessLogRequest/LogScrollRequest.

object
aggs
aggregations

Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query is large and cannot be returned in a single response message, user can GET helpful insights/summary using aggregations. The aggregation data is key’ed with the aggregation name specified in the request.

object
logs
logs

List of log messages that matched the query. Not all log messages that matched the query are returned in the response.

Array<string>
scroll_id
scroll id

Long Base-64 encoded string which can be used to retrieve next batch of log messages using the scroll request. Empty scroll_id indicates no more messages to scroll (EOF). Note: scroll_id is valid only for 2 minutes. I.e., If one intend to retrieve next batch of the result, then the scroll request should be sent within 2 minutes upon receiving the LogResponse.

string
<= 1024 characters
total_hits
total hits

Total number of log messages that matched the query.

string format: uint64
<= 1024 characters
last_sort_values
object
last_doc_id
last_doc_id

This is a unique UUID generated by elastic search.

string
<= 1024 characters
last_timestamp
last timestamp

Configuration parameter for last timestamp

number format: double
Examplegenerated
{
  "aggs": {},
  "logs": [
    "example"
  ],
  "scroll_id": "example",
  "total_hits": "example",
  "last_sort_values": {
    "last_doc_id": "example",
    "last_timestamp": 1
  }
}

401

Section titled “401”

Returned when operation is not authorized.

Media typeapplication/json
string format: string
Examplegenerated
example

403

Section titled “403”

Returned when there is no permission to access resource.

Media typeapplication/json
string format: string
Examplegenerated
example

404

Section titled “404”

Returned when resource is not found.

Media typeapplication/json
string format: string
Examplegenerated
example

409

Section titled “409”

Returned when operation on resource is conflicting with current value.

Media typeapplication/json
string format: string
Examplegenerated
example

429

Section titled “429”

Returned when operation has been rejected as it is happening too frequently.

Media typeapplication/json
string format: string
Examplegenerated
example

500

Section titled “500”

Returned when server encountered an error in processing API.

Media typeapplication/json
string format: string
Examplegenerated
example

503

Section titled “503”

Returned when service is unavailable temporarily.

Media typeapplication/json
string format: string
Examplegenerated
example

504

Section titled “504”

Returned when server timed out processing request.

Media typeapplication/json
string format: string
Examplegenerated
example