Связаться с экспертомПопробовать бесплатно
Статья создана
Открыть в Markdown

🚧 [Experimental] Get data transfer logs

Returns replication or operation logs for a transfer, with filtering and pagination.

Request

POST

https://api.datalens.tech/rpc/getDataTransferLogs

Headers

Name

Description

x-dl-api-version

Type: string

API version header.

Const: 3

Example: 3

Body

application/json
{
  "logEntity": {
    "transferId": "example",
    "title": "example",
    "replicationLog": {},
    "operationLog": {
      "operationId": "example"
    },
    "fromTime": {
      "seconds": "example",
      "nanos": 0.5
    },
    "toTime": {
      "seconds": "example",
      "nanos": 0.5
    },
    "logsOrder": "LOGS_ORDER_UNSPECIFIED"
  },
  "pageSize": "example",
  "pageToken": "example",
  "criteria": {
    "since": {
      "seconds": "example",
      "nanos": 0.5
    },
    "until": {
      "seconds": "example",
      "nanos": 0.5
    },
    "levels": [
      "LEVEL_UNSPECIFIED"
    ],
    "logsOrder": "LOGS_ORDER_UNSPECIFIED"
  }
}

Name

Description

logEntity
Type: object

title

Type: string

Title of the log entity.

Min length: 1

Example: example

transferId

Type: string

ID of the transfer whose logs to read.

Min length: 1

Example: example

fromTime

Type: object | null

Start of the time range covered by the log entity.

Example
{
  "seconds": "example",
  "nanos": 0.5
}

logsOrder

Type: string

Order in which log events are returned.

Enum: LOGS_ORDER_UNSPECIFIED, FROM_PAST_TO_FUTURE, FROM_FUTURE_TO_PAST

operationLog
Type: object

operationId

Type: string

ID of the transfer operation.

Example: example

Selects logs of the specified operation.

Example
{
  "operationId": "example"
}

replicationLog
Type: object

Selects replication logs.

Example
{}

toTime

Type: object | null

End of the time range covered by the log entity.

Example
{
  "seconds": "example",
  "nanos": 0.5
}

Transfer log entity to read.

Example
{
  "transferId": "example",
  "title": "example",
  "replicationLog": {},
  "operationLog": {
    "operationId": "example"
  },
  "fromTime": {
    "seconds": "example",
    "nanos": 0.5
  },
  "toTime": {
    "seconds": "example",
    "nanos": 0.5
  },
  "logsOrder": "LOGS_ORDER_UNSPECIFIED"
}

criteria
Type: object

levels

Type: DataTransferLogLevel[]

Log severity levels to include.

Example
[
  "LEVEL_UNSPECIFIED"
]

logsOrder

Type: string

Order in which log events are returned.

Enum: LOGS_ORDER_UNSPECIFIED, FROM_PAST_TO_FUTURE, FROM_FUTURE_TO_PAST

since

Type: object | null

Start of the time range to retrieve log events for.

Example
{
  "seconds": "example",
  "nanos": 0.5
}

until

Type: object | null

End of the time range to retrieve log events for.

Example
{
  "seconds": "example",
  "nanos": 0.5
}

Log event filters. Cannot be combined with pageToken.

Example
{
  "since": {
    "seconds": "example",
    "nanos": 0.5
  },
  "until": {
    "seconds": "example",
    "nanos": 0.5
  },
  "levels": [
    "LEVEL_UNSPECIFIED"
  ],
  "logsOrder": "LOGS_ORDER_UNSPECIFIED"
}

pageSize

Type: string

Maximum number of log events, encoded as a string.

Pattern: ^\d+$

Example: example

pageToken

Type: string

Page token from a preceding response. Cannot be combined with criteria.

Example: example

DataTransferLogLevel

Severity level of the log event.

Type: string

Enum: LEVEL_UNSPECIFIED, TRACE, DEBUG, INFO, WARN, ERROR, FATAL

Responses

200 OK

Response

Body

application/json
{
  "logEvents": [
    {
      "logGroupId": "example",
      "streamName": "example",
      "createdAt": {
        "seconds": "example",
        "nanos": 0.5
      },
      "message": "example",
      "level": "LEVEL_UNSPECIFIED",
      "payload": "example"
    }
  ],
  "nextPageToken": "example",
  "previousPageToken": "example"
}

Name

Description

logEvents

Type: DataTransferLogEvent[]

Log events matching the request.

Example
[
  {
    "logGroupId": "example",
    "streamName": "example",
    "createdAt": {
      "seconds": "example",
      "nanos": 0.5
    },
    "message": "example",
    "level": "LEVEL_UNSPECIFIED",
    "payload": "example"
  }
]

nextPageToken

Type: string

Token for the next page of log events.

Example: example

previousPageToken

Type: string

Token for the previous page of log events.

Example: example

DataTransferLogEvent

Name

Description

createdAt
Type: object

seconds

Type: string

Number of seconds since the Unix epoch.

Example: example

nanos

Type: number

Fractional seconds in nanoseconds.

Time when the log event was created.

Example
{
  "seconds": "example",
  "nanos": 0.5
}

level

Type: DataTransferLogLevel

Severity level of the log event.

Enum: LEVEL_UNSPECIFIED, TRACE, DEBUG, INFO, WARN, ERROR, FATAL

logGroupId

Type: string

ID of the log group.

Example: example

message

Type: string

Log event message.

Example: example

payload

Type: string

Additional log event data encoded as a string.

Example: example

streamName

Type: string

Name of the log stream.

Example: example
Example
{
  "logGroupId": "example",
  "streamName": "example",
  "createdAt": {
    "seconds": "example",
    "nanos": 0.5
  },
  "message": "example",
  "level": "LEVEL_UNSPECIFIED",
  "payload": "example"
}
Предыдущая
🚧 [Experimental] Deactivate data transfer
Следующая
Overview