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

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