diff --git a/api-ref/source/os-consoles.inc b/api-ref/source/os-consoles.inc index 7169275ce19f..efc320928c59 100644 --- a/api-ref/source/os-consoles.inc +++ b/api-ref/source/os-consoles.inc @@ -1,7 +1,4 @@ .. -*- rst -*- -.. needs:parameter_verification -.. needs:example_verification -.. needs:body_verification =============================================================== Server consoles (servers, os-consoles, os-console-auth-token) @@ -28,10 +25,20 @@ Request - tenant_id: tenant_id - server_id: server_id + Response -------- -**Example List consoles: JSON response** +.. rest_parameters:: parameters.yaml + + - consoles: consoles + - console: console + - console_type: console_type + - id: console_id_in_body + +| + +**Example List Consoles** .. literalinclude:: ../../doc/api_samples/consoles/consoles-list-get-resp.json :language: javascript @@ -56,15 +63,19 @@ Request - tenant_id: tenant_id - server_id: server_id + Response -------- +No body content is returned on a successful POST. + + Show Console Details ==================== .. rest_method:: GET /v2.1/{tenant_id}/servers/{server_id}/consoles/{console_id} -Shows details for a console for a server instance. +Shows console details for a server instance. Normal response codes: 200 @@ -79,14 +90,28 @@ Request - server_id: server_id - console_id: console_id + Response -------- -**Example List consoles: JSON response** +.. rest_parameters:: parameters.yaml + + - console: console + - console_type: console_type + - host: console_host + - id: console_id_in_body + - instance_name: instance_name + - password: console_password + - port: port + +| + +**Example Show Console Details** .. literalinclude:: ../../doc/api_samples/consoles/consoles-get-resp.json :language: javascript + Delete Console ============== @@ -105,19 +130,23 @@ Request - tenant_id: tenant_id - server_id: server_id - - console_id: console_id + - id: console_id Response -------- +No body content is returned on a successful DELETE. + + Show Console Authentication Token ================================= .. rest_method:: GET /v2.1/{tenant_id}/servers/{server_id}/os-console-auth-token -Shows the authentication token for a console for a server instance. +Given the console authentication token for a server instance, +shows the related connection information. -This feature is available for ``rdp-html5`` console type only. +This method is available for ``rdp-html5`` console type only. Normal response codes: 200 @@ -131,10 +160,22 @@ Request - tenant_id: tenant_id - server_id: server_id +| + Response -------- -**Example List consoles: JSON response** +.. rest_parameters:: parameters.yaml + + - console: console + - instance_uuid: instance_id + - host: console_host + - port: port + - internal_access_path: internal_access_path + +| + +**Example Show Console Authentication Token** .. literalinclude:: ../../doc/api_samples/os-console-auth-tokens/get-console-connect-info-get-resp.json :language: javascript diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml index 173e853eeab2..1e35f26d0dc7 100644 --- a/api-ref/source/parameters.yaml +++ b/api-ref/source/parameters.yaml @@ -888,13 +888,49 @@ confirmResize: in: body required: true type: string -console_output: +console: + description: | + The console object. + in: body + required: true + type: object +console_host: + description: | + The name or ID of the host. + in: body + required: false + type: string +console_id_in_body: + description: | + The UUID of the console. in: body required: true type: string +console_output: description: | The console output as a string. Control characters will be escaped to create a valid json string. + in: body + required: true + type: string +console_password: + description: | + The password for the console. + in: body + required: true + type: string +console_type: + description: | + The type of the console. + in: body + required: true + type: string +consoles: + description: | + The list of console objects. + in: body + required: true + type: array cores: description: | The number of allowed instance cores for each tenant. @@ -1613,6 +1649,12 @@ injectNetworkInfo: in: body required: true type: string +instance_name: + description: | + The name of the instance. + in: body + required: true + type: string instances: description: | The number of allowed instances for each tenant. @@ -1650,6 +1692,12 @@ interfaceAttachments: in: body required: true type: array +internal_access_path: + description: | + The id representing the internal access path. + in: body + required: false + type: string ip_address: description: | The IP address.