logs

API endpoint base: https://qr1hi.arvadosapi.com/arvados/v1/logs

Object type: 57u5n

Example UUID: zzzzz-57u5n-0123456789abcde

Resource

Each Log has, in addition to the Common resource fields:

Attribute Type Description Example
object_uuid string The arvados object that is the subject of the log.
event_at datetime
event_type string A user-defined category or type for this event. LOGIN
summary text
properties hash

Creation

Any user may create Log entries for any event they find useful. User-generated Logs have no intrinsic meaning to other users or to the Arvados system itself; it is up to each user to choose appropriate log event types and summaries for their project.

System Logs

Arvados uses Logs to record creation, deletion, and updates of other Arvados resources.

Methods

See Common resource methods for more information about create, delete, get, list, and update.

Required arguments are displayed in green.

create

Create a new log entry.

Arguments:

Argument Type Description Location Example
log object query

delete

Delete an existing log entry. This method can only be used by privileged (system administrator) users.

Arguments:

Argument Type Description Location Example
uuid string The UUID of the log entry in question. path

get

Retrieve a log entry.

Arguments:

Argument Type Description Location Example
uuid string The UUID of the log entry in question. path

list

List log entries.

See common resource list method.

update

Update attributes of an existing log entry. This method can only be used by privileged (system administrator) users.

Arguments:

Argument Type Description Location Example
uuid string The UUID of the log entry in question. path
log object query

Previous: links Next: nodes

The content of this documentation is licensed under the Creative Commons Attribution-Share Alike 3.0 United States licence.
Code samples in this documentation are licensed under the Apache License, Version 2.0.