doc/api/methods/logs.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: api
   4 navmenu: API Methods
   5 title: "logs"
   6
   7 ...
   8
   9 API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/logs@
  10
  11 Object type: @57u5n@
  12
  13 Example UUID: @zzzzz-57u5n-0123456789abcde@
  14
  15 h2. Resource
  16
  17 Each Log has, in addition to the "Common resource fields":{{site.baseurl}}/api/resources.html:
  18
  19 table(table table-bordered table-condensed).
  20 |_. Attribute|_. Type|_. Description|_. Example|
  21 |object_uuid|string|The arvados object that is the subject of the log.||
  22 |event_at|datetime|||
  23 |event_type|string|A user-defined category or type for this event.|@LOGIN@|
  24 |summary|text|||
  25 |properties|hash|||
  26
  27 h3. Creation
  28
  29 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.
  30
  31 h3. System Logs
  32
  33 Arvados uses Logs to record creation, deletion, and updates of other Arvados resources.
  34
  35 h2. Methods
  36
  37 See "Common resource methods":{{site.baseurl}}/api/methods.html for more information about @create@, @delete@, @get@, @list@, and @update@.
  38
  39 Required arguments are displayed in %{background:#ccffcc}green%.
  40
  41 h3. create
  42
  43 Create a new log entry.
  44
  45 Arguments:
  46
  47 table(table table-bordered table-condensed).
  48 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  49 |log|object||query||
  50
  51 h3. delete
  52
  53 Delete an existing log entry. This method can only be used by privileged (system administrator) users.
  54
  55 Arguments:
  56
  57 table(table table-bordered table-condensed).
  58 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  59 {background:#ccffcc}.|uuid|string|The UUID of the log entry in question.|path||
  60
  61 h3. get
  62
  63 Retrieve a log entry.
  64
  65 Arguments:
  66
  67 table(table table-bordered table-condensed).
  68 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  69 {background:#ccffcc}.|uuid|string|The UUID of the log entry in question.|path||
  70
  71 h3. list
  72
  73 List log entries.
  74
  75 See "common resource list method.":{{site.baseurl}}/api/methods.html#index
  76
  77 h3. update
  78
  79 Update attributes of an existing log entry. This method can only be used by privileged (system administrator) users.
  80
  81 Arguments:
  82
  83 table(table table-bordered table-condensed).
  84 |_. Argument |_. Type |_. Description |_. Location |_. Example |
  85 {background:#ccffcc}.|uuid|string|The UUID of the log entry in question.|path||
  86 |log|object||query||