5 "title": "MultiVIM Service rest API"
7 "basePath": "/api/multicloud/v0/",
10 "name": "MultiVIM services"
14 "/{vimid}/{tenantid}/servers": {
19 "summary": "create a server",
20 "description": "create a server",
21 "operationId": "create_vim_server",
32 "description": "vim instance id",
39 "description": "tenant UUID",
46 "description": "create vim server request param",
49 "$ref": "#/definitions/CreateVimServer"
55 "description": "successful operation",
57 "$ref": "#/definitions/VimServerInfo"
61 "description": "the vim id or tenant UUID is wrong"
64 "description": "the vim server is not accessable"
72 "summary": "query vim servers list",
73 "description": "query vim servers list",
74 "operationId": "query_vim_servers",
85 "description": "vim instance id",
92 "description": "tenant UUID",
99 "description": "server name to filter list",
106 "description": "Requests a page size of items",
113 "description": "image ID of the last-seen item",
120 "description": "successful operation",
122 "$ref": "#/definitions/VimServersInfo"
126 "description": "the vim id or tenant UUID is wrong"
129 "description": "the vim server is not accessable"
134 "/{vimid}/{tenantid}/servers/{serverid}": {
139 "summary": "delete specific vim server",
140 "description": "delete specific vim server",
141 "operationId": "delete_vim_server",
152 "description": "vim instance id",
159 "description": "tenant UUID",
166 "description": "vim server id",
173 "description": "successful operation"
176 "description": "the vim id or tenant UUID is wrong"
179 "description": "the vim server is not accessable"
187 "summary": "query specific vim server",
188 "description": "query specific vim server",
189 "operationId": "query_vim_server",
200 "description": "vim instance id",
207 "description": "tenant UUID",
214 "description": "vim server id",
221 "description": "successful operation",
223 "$ref": "#/definitions/VimServerInfo"
227 "description": "the vim id or tenant UUID is wrong"
230 "description": "the vim server is not accessable"
247 "description": "server name"
251 "description": "Parameters to start a server",
255 "description": "boot type: 1: boot from volume, 2: boot from image"
259 "description": "volume UUID to boot server"
263 "description": "image UUID to boot server"
269 "description": "flavor uuid to start server"
273 "description": "list of injected files",
275 "$ref": "#/definitions/VimServerContextInfo"
280 "description": "list of volumes attached to a server",
282 "$ref": "#/definitions/VimServerVolumeInfo"
287 "description": "list of volumes attached to a server",
289 "$ref": "#/definitions/VimServerNicInfo"
292 "availabilityZone": {
294 "description": "The availability zone from which to launch the server."
298 "description": "list of key-value pairs for metadata to start a server",
300 "$ref": "#/definitions/VimServerKeyValuePair"
305 "description": "user data to start a aserver"
309 "description": "list of security groups for a server",
312 "description": "name of security group"
317 "description": "server group"
321 "VimServerKeyValuePair": {
326 "description": "key name"
330 "description": "value "
334 "VimServerContextInfo": {
339 "description": "Injected file name"
343 "description": "Injected file content "
347 "VimServerVolumeInfo": {
352 "description": "volume UUID"
356 "VimServerNicInfo": {
361 "description": "virtual port UUID to boot a server"
381 "description": "tenant UUID"
385 "description": "server list information",
387 "$ref": "#/definitions/VimServerInfo"
402 "description": "server name"
406 "description": "server UUID"
410 "description": "server status,0:INACTIVE,1:ACTIVE,2:ERROR"
414 "description": "Parameters to start a server",
418 "description": "boot type: 1: boot from volume, 2: boot from image"
422 "description": "volume UUID to boot server"
426 "description": "image UUID to boot server"
432 "description": "flavor uuid to start server"
436 "description": "list of volumes attached to a server",
438 "$ref": "#/definitions/VimServerVolumeInfo"
443 "description": "list of volumes attached to a server",
445 "$ref": "#/definitions/VimServerNicInfo"
448 "availabilityZone": {
450 "description": "available zone for a server"
454 "description": "list of key-value pairs for metadata to start a server",
456 "$ref": "#/definitions/VimServerKeyValuePair"
461 "description": "list of security groups for a server",
464 "description": "name of security group"
469 "description": "server group"
479 "description": "tenant UUID"
483 "description": "0: Already exist 1: Newly created"