15823: Mention instance_type section.
authorTom Clegg <tom@tomclegg.ca>
Mon, 13 Jan 2020 22:08:16 +0000 (17:08 -0500)
committerTom Clegg <tom@tomclegg.ca>
Mon, 13 Jan 2020 22:08:16 +0000 (17:08 -0500)
Arvados-DCO-1.1-Signed-off-by: Tom Clegg <tom@tomclegg.ca>

doc/api/dispatch.html.textile.liquid

index 1ca1279ee5ae12dce6a8a3c6eb48ba35f6457847..9bbe2ed62eac003ee34002d674f7fa50ca52bb23 100644 (file)
@@ -27,7 +27,9 @@ h3. List containers
 
 Return a list of containers that are either ready to dispatch, or being started/monitored by the dispatcher.
 
-The response provides @uuid@, @priority@, and @state@ fields for each container. Other fields of the container records are not loaded by the dispatcher, and will have empty/zero values here (e.g., @{...,"created_at":"0001-01-01T00:00:00Z","command":[],...}@).
+Each entry in the returned list of @items@ includes:
+* an @instance_type@ entry with the name and attributes of the instance type that will be used to schedule the container (chosen from the @InstanceTypes@ section of your cluster config file); and
+* a @container@ entry with selected attributes of the container itself, including @uuid@, @priority@, @runtime_constraints@, and @state@. Other fields of the container records are not loaded by the dispatcher, and will have empty/zero values here (e.g., @{...,"created_at":"0001-01-01T00:00:00Z","command":[],...}@).
 
 Example response: