api-ref: add version 2.3 parameters to servers

This adds the microversion 2.3 parameters to servers display calls.

Part of bp:api-ref-in-rst

Change-Id: I71d45fbff2bfca553128b375e6494d003dbc3759
This commit is contained in:
Sean Dague 2016-06-03 15:42:23 -04:00
parent f06a12623b
commit 036833d57c
2 changed files with 80 additions and 0 deletions

View File

@ -2777,24 +2777,76 @@ server_groups_quota_optional:
in: body
required: false
type: integer
server_hostname:
in: body
required: true
type: string
description: |
The hostname set on the instance when it is booted.
min_version: 2.3
server_id:
description: |
The UUID of the server.
in: body
required: true
type: string
server_kernel_id:
in: body
required: true
type: string
description: |
The UUID of the kernel image when using an AMI. Will be null if not.
min_version: 2.3
server_launch_index:
in: body
required: true
type: int
description: |
When servers are launched via multiple create, this is the
sequence in which the servers were launched.
min_version: 2.3
server_name:
description: |
The server name.
in: body
required: true
type: string
server_ramdisk_id:
in: body
required: true
type: string
description: |
The UUID of the ramdisk image when using an AMI. Will be null if not.
min_version: 2.3
server_reservation_id:
in: body
required: true
type: string
description: |
The reservation id for the server. This is an id that can
be useful in tracking groups of servers created with multiple
create, that will all have the same reservation_id.
min_version: 2.3
server_root_device_name:
in: body
required: true
type: string
description: |
The root device name for the instance
min_version: 2.3
server_status:
description: |
The server status.
in: body
required: true
type: string
server_user_data:
in: body
required: true
type: string
description: |
The user_data the instance was created with.
min_version: 2.3
server_uuid:
description: |
The UUID of the server instance to which the API dispatches the event. You must

View File

@ -350,6 +350,13 @@ Response
- tenant_id: tenant_id_body
- updated: updated
- user_id: user_id
- OS-EXT-SERV-ATTR:hostname: server_hostname
- OS-EXT-SERV-ATTR:reservation_id: server_reservation_id
- OS-EXT-SERV-ATTR:launch_index: server_launch_index
- OS-EXT-SERV-ATTR:kernel_id: server_kernel_id
- OS-EXT-SERV-ATTR:ramdisk_id: server_ramdisk_id
- OS-EXT-SERV-ATTR:root_device_name: server_root_device_name
- OS-EXT-SERV-ATTR:user_data: server_user_data
**Example Create Server: JSON response**
@ -445,6 +452,13 @@ Response
- tenant_id: tenant_id_body
- updated: updated
- user_id: user_id
- OS-EXT-SERV-ATTR:hostname: server_hostname
- OS-EXT-SERV-ATTR:reservation_id: server_reservation_id
- OS-EXT-SERV-ATTR:launch_index: server_launch_index
- OS-EXT-SERV-ATTR:kernel_id: server_kernel_id
- OS-EXT-SERV-ATTR:ramdisk_id: server_ramdisk_id
- OS-EXT-SERV-ATTR:root_device_name: server_root_device_name
- OS-EXT-SERV-ATTR:user_data: server_user_data
**Example List Servers Detailed: JSON response**
@ -525,6 +539,13 @@ Response
- updated: updated
- user_id: user_id
- fault: fault
- OS-EXT-SERV-ATTR:hostname: server_hostname
- OS-EXT-SERV-ATTR:reservation_id: server_reservation_id
- OS-EXT-SERV-ATTR:launch_index: server_launch_index
- OS-EXT-SERV-ATTR:kernel_id: server_kernel_id
- OS-EXT-SERV-ATTR:ramdisk_id: server_ramdisk_id
- OS-EXT-SERV-ATTR:root_device_name: server_root_device_name
- OS-EXT-SERV-ATTR:user_data: server_user_data
**Example Show Server Details: JSON response**
@ -612,6 +633,13 @@ Response
- tenant_id: tenant_id_body
- updated: updated
- user_id: user_id
- OS-EXT-SERV-ATTR:hostname: server_hostname
- OS-EXT-SERV-ATTR:reservation_id: server_reservation_id
- OS-EXT-SERV-ATTR:launch_index: server_launch_index
- OS-EXT-SERV-ATTR:kernel_id: server_kernel_id
- OS-EXT-SERV-ATTR:ramdisk_id: server_ramdisk_id
- OS-EXT-SERV-ATTR:root_device_name: server_root_device_name
- OS-EXT-SERV-ATTR:user_data: server_user_data
**Example Update server name: JSON response**