HypervisorTypesResource


List hypervisor types


Returns all the available hypervisor types.

If a plugin is not returned, the API cannot load it (missing properties) or it's not allowed (restricted by the license)

GET https://example.com/api/config/hypervisortypes

Roles : [ROLE_AUTHENTICATED]

Accept : hypervisortypes

Example

Get a hypervisor type


Returns a hypervisor type identified by the plugin type

GET https://example.com/api/config/hypervisortypes/{hypervisortype}

Roles : [ROLE_AUTHENTICATED]

Accept : hypervisortype

Example

Check credentials by hypervisor type


Validates the given connection info for a provider type. 204 - NO_CONTENT will be returned if the credentials are valid. The following exceptions can be thrown:
  • {@link BadRequestException} with {@link APIError#INVALID_HYPERVISOR_TYPE} if the given {@link PublicCloudCredentialsDto#getProvider()} does not match the provider type path param
  • {@link BadRequestException} with {@link APIError#CREDENTIALS_CHECK_REQUIRED_ACCES_KEY} if the given {@link PublicCloudCredentialsDto#getAccess()} or {@link PublicCloudCredentialsDto#getKey()} are null or empty
  • {@link NotFoundException} with {@link APIError#PLUGIN_NOT_FOUND} if the given provider type does not exist
  • {@link ConflictException} with {@link APIError#CREDENTIALS_CHECK_INVALID} if the given credential is invalid
  • In other cases {@link PreconditionFailedException} with {@link APIError#CREDENTIAL_CAN_NOT_BE_CHECKED}

POST https://example.com/api/config/hypervisortypes/{hypervisortype}/action/checkcredentials

Roles : [ROLE_AUTHENTICATED]

Content-Type : publiccloudcredentials

Example

Check pricing credentials by hypervisor type


Validates the given connection info for a provider type that supports pricing. 204 - NO_CONTENT will be returned if the credentials are valid. The following exceptions can be thrown:
  • {@link BadRequestException} with {@link APIError#INVALID_HYPERVISOR_TYPE} if the given {@link PublicCloudCredentialsDto#getProvider()} does not match the provider type path param
  • {@link BadRequestException} with {@link APIError#CREDENTIALS_CHECK_REQUIRED_ACCES_KEY} if the given {@link PublicCloudCredentialsDto#getAccess()} or {@link PublicCloudCredentialsDto#getKey()} are null or empty
  • {@link NotFoundException} with {@link APIError#PLUGIN_NOT_FOUND} if the given provider type does not exist
  • {@link ConflictException} with {@link APIError#CREDENTIALS_CHECK_INVALID} if the given credential is invalid for pricing purposes
  • In other cases {@link PreconditionFailedException} with {@link APIError#CREDENTIAL_CAN_NOT_BE_CHECKED}

POST https://example.com/api/config/hypervisortypes/{hypervisortype}/action/checkpricingcredentials

Roles : [ROLE_AUTHENTICATED]

Content-Type : pricingcredentials

Example

Get a monitoring level of a hypervisor type


Get a metadata of a specific metric for the given provider type

GET https://example.com/api/config/hypervisortypes/{hypervisortype}/monitoring/levels

Roles : [ROLE_AUTHENTICATED]

Parameter Type Default Value Description
name String If present, filter by a level, identified by the level name

Accept : monitoringlevel

Error Codes

  • GEN-17 - The plugin type was not found
  • GEN-18 - The requested operation is not supported by the hypervisor plugin
  • MONITORING-10 - Unknown monitoring level 'fa957609-b8eb-4c56-bfc7-e636514dcca0' for provider type 'METRICS_TEST_HYPERVISOR_ONE'
  • MONITORING-11 - Unable to check the existence of the monitoring level '' in the provider type 'METRICS_TEST_HYPERVISOR_ONE'

Example

List monitoring levels of a hypervisor type


Returns the monitoring levels supported by a hypervisor type in the platform.

GET https://example.com/api/config/hypervisortypes/{hypervisortype}/monitoring/levels

Roles : [ROLE_AUTHENTICATED]

Accept : monitoringlevels

Error Codes

  • GEN-17 - The plugin type was not found
  • GEN-18 - The requested operation is not supported by the hypervisor plugin

Example