Sign in

v1

latestOpenAPI 3.0.02026-07-2496664456.3 KB
Log

Read log status.

Read the most recent log status. It will also show URLs containing log contents.

get/cm/v1/logs/{log_id}/status

Path parameters

log_idstring required

Log ID to read the status.

Response

Successfully read log status.

status'UNKNOWN_LOG_STATUS' | 'ACCEPTED' | 'READY' | 'FAILED'

Status enumerates the status of log.

  • ACCEPTED: Successfully initiated the log generation request.
  • READY: Successfully generated the log. It's ready to download from the location.
  • FAILED: Failed to generate the log. Reasons of failure can be found at errors.
location_csvstring[]

URL of the log contents in CSV form. Will be expired in an hour.

location_avrostring[]

URL of the log contents in Avro form. Will be expired in an hour.

Example response

{
  "status": "READY",
  "location_csv": "https://{PLATFORM_LOG_STORAGE}/logs/anExistingLogId.csv?token={ONE_TIME_TOKEN}"
}