1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
|
# variables in header
Content-Type-json:
description: |
The media type descriptor for the request body. Use ``application/json``.
in: header
required: true
type: string
# variables in path
task_id:
description: |
The identifier for the task, a UUID.
in: path
required: true
type: string
# variables in query
limit:
description: |
Requests a page size of items. Returns a number of items up to a limit
value. Use the ``limit`` parameter to make an initial limited request and
use the ID of the last-seen item from the response as the ``marker``
parameter value in a subsequent limited request.
in: query
required: false
type: integer
marker:
description: |
The ID of the last-seen item. Use the ``limit`` parameter to make an
initial limited request and use the ID of the last-seen item from the
response as the ``marker`` parameter value in a subsequent limited request.
in: query
required: false
type: string
sort_dir:
description: |
Sorts the response by a set of one or more sort direction and attribute
(``sort_key``) combinations. A valid value for the sort direction is
``asc`` (ascending) or ``desc`` (descending). If you omit the sort
direction in a set, the default is ``desc``.
in: query
required: false
type: string
sort_key:
description: |
Sorts the response by one of the following attributes: ``created_at``,
``expires_at``, ``status``, ``type``, ``updated_at``. Default is
``created_at``.
in: query
required: false
type: string
status-in-query:
description: |
Filters the response by a task status. A valid value is ``pending``,
``processing``, ``success``, or ``failure``.
in: query
required: false
type: string
type-in-query:
description: |
Filters the response by a task type. A valid value is ``import``.
in: query
required: false
type: string
# variables in body
created_at:
description: |
The date and time when the task was created.
The date and time stamp format is `ISO 8601
<https://en.wikipedia.org/wiki/ISO_8601>`_.
in: body
required: true
type: string
expires_at:
description: |
The date and time when the task is subject to removal. While the *task
object*, that is, the record describing the task is subject to deletion,
the result of the task (for example, an imported image) still exists.
The date and time stamp format is `ISO 8601
<https://en.wikipedia.org/wiki/ISO_8601>`_.
This value is only set when the task reaches status ``success`` or
``failure``. Otherwise its value is ``null``. It may not appear in
the response when its value is ``null``.
in: body
required: true
type: string
first:
description: |
The URI for the first page of response.
in: body
required: true
type: string
id:
description: |
The UUID of the task.
in: body
required: true
type: string
input:
description: |
A JSON object specifying the input parameters to the task. Consult your
cloud provider's documentation for details.
in: body
required: true
type: object
message:
description: |
Human-readable text, possibly an empty string, usually displayed in an
error situation to provide more information about what has occurred.
in: body
required: true
type: string
next:
description: |
The URI for the next page of response. Will not be present on the last
page of the response.
in: body
required: true
type: string
owner:
description: |
An identifier for the owner of the task, usually the tenant ID.
in: body
required: true
type: string
result:
description: |
A JSON object specifying information about the ultimate outcome of the
task. Consult your cloud provider's documentation for details.
in: body
required: true
type: object
schema-task:
description: |
The URI for the schema describing an image task.
in: body
required: true
type: string
schema-tasks:
description: |
The URI for the schema describing an image task list.
in: body
required: true
type: string
self:
description: |
A URI for this task.
in: body
required: true
type: string
status:
description: |
The current status of this task. The value can be ``pending``,
``processing``, ``success`` or ``failure``.
in: body
required: true
type: string
tasks:
description: |
A list of sparse *task* objects. Each object contains the following
fields:
- ``created_at``
- ``id``
- ``owner``
- ``schema``
- ``self``
- ``status``
- ``type``
- ``updated_at``
in: body
required: true
type: array
type:
description: |
The type of task represented by this content.
in: body
required: true
type: string
updated_at:
description: |
The date and time when the task was updated.
The date and time stamp format is `ISO 8601
<https://en.wikipedia.org/wiki/ISO_8601>`_.
If the ``updated_at`` date and time stamp is not set, its value is
``null``.
in: body
required: true
type: string
|
