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"
235 "/{vimid}/{tenantid}/servers/{serverid}/action": {
240 "summary": "operate a server",
241 "description": "operate a server",
242 "operationId": "operate_vim_server",
253 "description": "vim instance id",
260 "description": "tenant UUID",
267 "description": "vim server id",
274 "description": "operate vim server request param",
277 "$ref": "#/definitions/OperateVimServer"
283 "description": "successful operation"
286 "description": "the vim id, tenant UUID or server id is wrong"
289 "description": "the vim server is not accessable"
306 "description": "server name"
310 "description": "Parameters to start a server",
314 "description": "boot type: 1: boot from volume, 2: boot from image"
318 "description": "volume UUID to boot server"
322 "description": "image UUID to boot server"
328 "description": "flavor uuid to start server"
332 "description": "list of injected files",
334 "$ref": "#/definitions/VimServerContextInfo"
339 "description": "list of volumes attached to a server",
341 "$ref": "#/definitions/VimServerVolumeInfo"
346 "description": "list of volumes attached to a server",
348 "$ref": "#/definitions/VimServerNicInfo"
351 "availabilityZone": {
353 "description": "The availability zone from which to launch the server."
357 "description": "list of key-value pairs for metadata to start a server",
359 "$ref": "#/definitions/VimServerKeyValuePair"
364 "description": "user data to start a aserver"
368 "description": "list of security groups for a server",
371 "description": "name of security group"
376 "description": "server group"
380 "VimServerKeyValuePair": {
385 "description": "key name"
389 "description": "value "
393 "VimServerContextInfo": {
398 "description": "Injected file name"
402 "description": "Injected file content "
406 "VimServerVolumeInfo": {
411 "description": "volume UUID"
415 "VimServerNicInfo": {
420 "description": "virtual port UUID to boot a server"
440 "description": "tenant UUID"
444 "description": "server list information",
446 "$ref": "#/definitions/VimServerInfo"
461 "description": "server name"
465 "description": "server UUID"
469 "description": "server status,0:INACTIVE,1:ACTIVE,2:ERROR"
473 "description": "Parameters to start a server",
477 "description": "boot type: 1: boot from volume, 2: boot from image"
481 "description": "volume UUID to boot server"
485 "description": "image UUID to boot server"
491 "description": "flavor uuid to start server"
495 "description": "list of volumes attached to a server",
497 "$ref": "#/definitions/VimServerVolumeInfo"
502 "description": "list of volumes attached to a server",
504 "$ref": "#/definitions/VimServerNicInfo"
507 "availabilityZone": {
509 "description": "available zone for a server"
513 "description": "list of key-value pairs for metadata to start a server",
515 "$ref": "#/definitions/VimServerKeyValuePair"
520 "description": "list of security groups for a server",
523 "description": "name of security group"
528 "description": "server group"
538 "description": "tenant UUID"
542 "description": "0: Already exist 1: Newly created"
546 "OperateVimServer": {
551 "description": "the action to start a stopped server"
555 "description": "the action to stop a running server"
559 "description": "The action to reboot a server",
563 "description": "the type of the reboot action: the valid values are HARD and SOFT"