Skip to content

Latest commit

 

History

History
188 lines (130 loc) · 5.85 KB

VncUrlApi.md

File metadata and controls

188 lines (130 loc) · 5.85 KB

hyperstack.VncUrlApi

All URIs are relative to https://infrahub-api.nexgencloud.com/v1

Method HTTP request Description
get_vnc_console_link GET /core/virtual-machines/{virtual_machine_id}/console/{job_id} Get VNC Console Link
request_console GET /core/virtual-machines/{id}/request-console Request Instance Console

get_vnc_console_link

VNCURL get_vnc_console_link(virtual_machine_id, job_id)

Get VNC Console Link

Example

  • Api Key Authentication (apiKey):
  • Api Key Authentication (accessToken):
import hyperstack
from hyperstack.models.vncurl import VNCURL
from hyperstack.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://infrahub-api.nexgencloud.com/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = hyperstack.Configuration(
    host = "https://infrahub-api.nexgencloud.com/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apiKey
configuration.api_key['apiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'

# Configure API key authorization: accessToken
configuration.api_key['accessToken'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['accessToken'] = 'Bearer'

# Enter a context with an instance of the API client
with hyperstack.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = hyperstack.VncUrlApi(api_client)
    virtual_machine_id = 56 # int | 
    job_id = 56 # int | 

    try:
        # Get VNC Console Link
        api_response = api_instance.get_vnc_console_link(virtual_machine_id, job_id)
        print("The response of VncUrlApi->get_vnc_console_link:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VncUrlApi->get_vnc_console_link: %s\n" % e)

Parameters

Name Type Description Notes
virtual_machine_id int
job_id int

Return type

VNCURL

Authorization

apiKey, accessToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Get VNC Console Link Success -
400 Bad Request -
401 Unauthorized -
404 Not Found -
500 Internal Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

request_console

RequestConsole request_console(id)

Request Instance Console

Example

  • Api Key Authentication (apiKey):
  • Api Key Authentication (accessToken):
import hyperstack
from hyperstack.models.request_console import RequestConsole
from hyperstack.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://infrahub-api.nexgencloud.com/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = hyperstack.Configuration(
    host = "https://infrahub-api.nexgencloud.com/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: apiKey
configuration.api_key['apiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'

# Configure API key authorization: accessToken
configuration.api_key['accessToken'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['accessToken'] = 'Bearer'

# Enter a context with an instance of the API client
with hyperstack.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = hyperstack.VncUrlApi(api_client)
    id = 56 # int | 

    try:
        # Request Instance Console
        api_response = api_instance.request_console(id)
        print("The response of VncUrlApi->request_console:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VncUrlApi->request_console: %s\n" % e)

Parameters

Name Type Description Notes
id int

Return type

RequestConsole

Authorization

apiKey, accessToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Please wait a few seconds and visit the below link to access your VNC console URL -
400 Bad Request -
401 Unauthorized -
404 Not Found -
500 Internal Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]