X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/dc491966feeeeb4a136b1e4cfee64eab5ffe5f14..47e929743cefd13760b9c84e1c148115aa3fc96c:/doc/api/methods/containers.html.textile.liquid diff --git a/doc/api/methods/containers.html.textile.liquid b/doc/api/methods/containers.html.textile.liquid index 5ec95cee62..43163c5550 100644 --- a/doc/api/methods/containers.html.textile.liquid +++ b/doc/api/methods/containers.html.textile.liquid @@ -52,11 +52,15 @@ Generally this will contain additional keys that are not present in any correspo |output|string|Portable data hash of the output collection.|Null if the container is not yet finished.| |container_image|string|Portable data hash of a collection containing the docker image used to run the container.|| |progress|number|A number between 0.0 and 1.0 describing the fraction of work done.|| -|priority|integer|Range 0-1000. Indicate scheduling order preference.|Currently assigned by the system as the max() of the priorities of all associated ContainerRequests. See "container request priority":container_requests.html#priority .| -|exit_code|integer|Process exit code.|Null if state!="Complete"| +|priority|integer|Range 0-1000. Indicate scheduling order preference.|Currently assigned by the system as the max() of the priorities of all associated ContainerRequests. See "container request priority":container_requests.html#priority.| +|exit_code|integer|Process exit code.|Null if container process has not exited yet.| |auth_uuid|string|UUID of a token to be passed into the container itself, used to access Keep-backed mounts, etc. Automatically assigned.|Null if state∉{"Locked","Running"} or if @runtime_token@ was provided.| |locked_by_uuid|string|UUID of a token, indicating which dispatch process changed state to Locked. If null, any token can be used to lock. If not null, only the indicated token can modify this container.|Null if state∉{"Locked","Running"}| |runtime_token|string|A v2 token to be passed into the container itself, used to access Keep-backed mounts, etc.|Not returned in API responses. Reset to null when state is "Complete" or "Cancelled".| +|gateway_address|string|Address (host:port) of gateway server.|Internal use only.| +|interactive_session_started|boolean|Indicates whether @arvados-client shell@ has been used to run commands in the container, which may have altered the container's behavior and output.|| +|output_storage_classes|array of strings|The storage classes that will be used for the log and output collections of this container|| +|output_properties|hash|User metadata properties to set on the output collection.| h2(#container_states). Container states @@ -85,8 +89,8 @@ table(table table-bordered table-condensed). |error|string|The existance of this key indicates the container will definitely fail, or has already failed.|Optional.| |warning|string|Indicates something unusual happened or is currently happening, but isn't considered fatal.|Optional.| |activity|string|A message for the end user about what state the container is currently in.|Optional.| -|errorDetails|string|Additional structured error details.|Optional.| -|warningDetails|string|Additional structured warning details.|Optional.| +|errorDetail|string|Additional structured error details.|Optional.| +|warningDetail|string|Additional structured warning details.|Optional.| h2(#scheduling_parameters). {% include 'container_scheduling_parameters' %} @@ -136,8 +140,6 @@ List containers. See "common resource list method.":{{site.baseurl}}/api/methods.html#index -See the create method documentation for more information about Container-specific filters. - h3. update Update attributes of an existing Container.