summaryrefslogtreecommitdiff
path: root/api-ref
diff options
context:
space:
mode:
authorzhu.boxiang <zhu.boxiang@99cloud.net>2019-07-08 11:24:49 +0800
committerzhu.boxiang <zhu.boxiang@99cloud.net>2019-07-09 22:55:16 +0800
commit564290ab145d2710d3e82b5c4871e647e4d516c4 (patch)
treef1d06fcb54a9b1058f4cb0bcbc5710ab089db1ed /api-ref
parent6298f960686382f01ca58ca67afaaec29de135cf (diff)
downloadnova-564290ab145d2710d3e82b5c4871e647e4d516c4.tar.gz
Add host and hypervisor_hostname flag to create server
Add a new microversion that adds two new params to create server named 'host' and 'hypervisor_hostname'. Part of Blueprint: add-host-and-hypervisor-hostname-flag-to-create-server Change-Id: I3afea20edaf738da253ede44b4a07414ededafd6
Diffstat (limited to 'api-ref')
-rw-r--r--api-ref/source/parameters.yaml20
-rw-r--r--api-ref/source/servers.inc7
2 files changed, 27 insertions, 0 deletions
diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml
index c1eebf5e79..fee623514a 100644
--- a/api-ref/source/parameters.yaml
+++ b/api-ref/source/parameters.yaml
@@ -5955,6 +5955,16 @@ server_groups_quota_optional:
in: body
required: false
type: integer
+# This is the host in a POST (create instance) request body.
+server_host_create:
+ description: |
+ The name of the compute service host on which the server is to be created.
+ The API will return 400 if no compute services are found with the given
+ host name. By default, it can be specified by administrators only.
+ in: body
+ required: false
+ type: string
+ min_version: 2.74
server_hostname:
in: body
required: false
@@ -5963,6 +5973,16 @@ server_hostname:
The hostname set on the instance when it is booted.
By default, it appears in the response for administrative users only.
min_version: 2.3
+# This is the hypervisor_hostname in a POST (create instance) request body.
+server_hypervisor_hostname_create:
+ description: |
+ The hostname of the hypervisor on which the server is to be created.
+ The API will return 400 if no hypervisors are found with the given
+ hostname. By default, it can be specified by administrators only.
+ in: body
+ required: false
+ type: string
+ min_version: 2.74
server_id:
description: |
The UUID of the server.
diff --git a/api-ref/source/servers.inc b/api-ref/source/servers.inc
index 976f353adf..39edb835aa 100644
--- a/api-ref/source/servers.inc
+++ b/api-ref/source/servers.inc
@@ -397,6 +397,8 @@ Request
- description: server_description
- tags: server_tags_create
- trusted_image_certificates: server_trusted_image_certificates_create_req
+ - host: server_host_create
+ - hypervisor_hostname: server_hypervisor_hostname_create
- os:scheduler_hints: os:scheduler_hints
- os:scheduler_hints.build_near_host_ip: os:scheduler_hints_build_near_host_ip
- os:scheduler_hints.cidr: os:scheduler_hints_cidr
@@ -427,6 +429,11 @@ Request
.. literalinclude:: ../../doc/api_samples/servers/v2.63/server-create-req.json
:language: javascript
+**Example Create Server With Host and Hypervisor Hostname (v2.74)**
+
+.. literalinclude:: ../../doc/api_samples/servers/v2.74/server-create-req-with-host-and-node.json
+ :language: javascript
+
Response
--------