Cloud Providers
Contents
Cloud Providers
Cloud providers are entities that provide computational cloud resources.
List cloud providers
GET /v3/cloud/cloud_providers
This action lists the cloud providers supported by the platform.
Inputs
None
Returns
An array of cloud providers with the following fields:
| Field | Type | Description |
|---|---|---|
| id | String | Identifier of the cloud provider. |
| name | String | Name of the cloud provider. |
| disambiguation | String | Continuation of the cloud provider name with disambiguation purposes, it is only of use in the context of admin integrations |
| required_credentials | Array of Strings | The list of credentials parameters needed to create a cloud account for this provider. |
| discoverable | Boolean | Flag to indicate whether the cloud provider can discover cloud accounts for this cloud provider. |
| cse_syntax | String | Syntax used to deploy CSE deployments on this cloud provider. |
| standalone_incompatible | Boolean | Flag indicating whether this cloud provider can be standalone (false) or not (true). |
| resource_type | String | An identifier for the type of resource, specifically "cloud_provider". |
List cloud accounts of a cloud provider
GET /v3/cloud/cloud_providers/:id/cloud_accounts
This action lists the cloud accounts offered by the cloud provider identified by the given id.
Inputs
None
Returns
An array of cloud accounts with the following fields:
| Field | Type | Description |
|---|---|---|
| id | String | Identifier of the cloud account. |
| cloud_provider_id | String | Identifier of the cloud provider. |
| name | String | The logical name for the cloud account. |
| state | String | State of the cloud account, to indicate whether this cloud account is importing resources from the cloud. Specifically, one of the following: importing_vpcs, importing_floating_ips, importing_servers, importing_volumes, importing_policies, importing_kubernetes_clusters, importing_key_vaults, idle |
| organizationa_state | String | Organizational state of the cloud account, to indicate whether this cloud account is discovering or configuring (importing) other cloud accounts. Specifically, one of the following: discovering_accounts, configuring_accounts, idle |
| last_discovered_at | Time | Time at which the cloud account was last searched for server candidates for brownfield importing. |
| last_discovery_failed_at | Time | Last time at which the cloud account's discovery of server candidates for brownfield importing failed. |
| resource_type | String | An identifier for the type of resource, specifically "cloud_account". |
| supports_importing | Boolean | Flag to indicate whether this cloud account supports importing servers. |
| supports_importing_vpcs | Boolean | Flag to indicate whether this cloud account supports importing VPCs. |
| supports_importing_floating_ips | Boolean | Flag to indicate whether this cloud account supports importing floating IPs. |
| supports_importing_volumes | Boolean | Flag to indicate whether this cloud account supports importing volumes. |
| supports_importing_policies | Boolean | Flag to indicate whether this cloud account supports importing policy definitions and assignments. |
| supports_importing_kubernetes_clusters | Boolean | Flag to indicate whether this cloud account supports importing Kubernetes clusters and node pools. |
| supports_importing_key_vaults | Boolean | Flag to indicate whether this cloud account supports importing key vaults and secrets. |
| supports_discovering_cloud_accounts | Boolean | Flag to indicate whether this cloud account supports discovering other cloud accounts. |
| supports_importing_cloud_accounts | Boolean | Flag to indicate whether this cloud account supports importing other cloud accounts. |
List server plans of a cloud provider
GET /v3/cloud/cloud_providers/:cloud_provider_id/server_plans
This action lists the server plans offered by the cloud provider identified by the given id.
Inputs
| Field | Type | Description | Required |
|---|---|---|---|
| realm_id | String | Identifier of the realm. | No. |
| realm_provider_name | String | Name of the realm. | No. |
| cpus | Intenger | The amount of CPUs the server plans must have, in virtual CPUs (vCPUs). | No. |
| memory | Intenger | The amount of memory the server plans must have, in Megabytes (MB). | No. |
| storage | Integer | The amount of storage capacity the server plans must have, in Gigabytes (GB). | No. |
| architecture | String | The architecture the server plans must have. | No. |
| flavour_provider_name | String | Name of the flavour the server plans must have. | No. |
Returns
An array of server plans with the following fields:
| Field | Type | Description |
|---|---|---|
| id | String | Identifier of the server plan. |
| name | String | Name of the server plan. |
| memory | String | Amount of memory the server plan has, in MB. |
| cpus | String | Number of CPUs the server plan has. |
| storage | String | Storage capacity the server plan has, in GB. |
| cloud_provider_id | String | Identifier of the cloud provider. |
| location_id | String | Identifier of the location of the server plan. |
| realm_id | String | Identifier of the realm of the server plan. |
| realm_provider_name | String | Name of the realm of the server plan. |
| flavour_provider_name | String | Name of the flavour of the server plan. |
| resource_type | String | An identifier for the type of resource, specifically "server_plan". |
List realms of a cloud provider
GET /v3/cloud/cloud_providers/:cloud_provider_id/realms
This action lists the realms offered by the cloud provider identified by the given id.
Inputs
None
Returns
An array of realms with the following fields:
| Field | Type | Description |
|---|---|---|
| id | String | Identifier of the realm. |
| name | String | Logical name of the realm. |
| deprecated | Boolean | Indicates whether this realm is deprecated in the system, so a server or server array uses it but no new servers or server arrays can be deployed in this realm. |
| provider_name | String | Identifier of the realm in the cloud provider. |
| cloud_provider_id | String | Identifier of the cloud provider where this realm belongs. |
| location_id | String | Identifier of the location where this realm is. |
List storage plans of a cloud provider
GET /v3/cloud/cloud_providers/:cloud_provider_id/storage_plans
This action lists the storage plans offered by the cloud provider identified by the given id.
Inputs
None
Returns
An array of storage plans with the following fields:
| Field | Type | Description |
|---|---|---|
| id | String | Identifier of the storage plan. |
| name | String | Name of the storage plan. |
| min_size | Integer | Indicates the minimum size a volume with this storage plan can have |
| max_size | Integer | Indicates the maximum size a volume with this storage plan can have |
| realm_id | String | Indicates the Id of the realm of the cloud provider. |
| cloud_provider_id | String | Identifier of the associated cloud provider. |
| location_id | String | Location of the storage plan. |
| realm_provider_name | String | Name of the realm of the cloud provider. |
| flavour_provider_name | String | Name of the flavour on the cloud provider. |
| deprecated | Boolean | Indicates if the storage plan is deprecated. |
| resource_type | String | An identifier for the type of resource, specifically "storage_plan". |
List load balancer plans of a cloud provider
GET /v3/cloud/cloud_providers/:cloud_provider_id/load_balancer_plans
This action lists the load balancer plans offered by the cloud provider identified by the given id.
Inputs
None
Returns
An array of load balancer plans with the following fields:
| Field | Type | Description |
|---|---|---|
| id | String | Identifier of the storage plan. |
| name | String | Name of the storage plan. |
| protocol | String | The protocol of the load balancer plan. |
| rule_fields | String | State of the load balancer. |
| health_check_protocols | Array of Strings | List of protocols available in the load balancer plan. |
| health_check_interval_valid_values | Hash | An object defining a set of valid values for the health check interval. It has a key to define whether is a range of values or a list of values. |
| health_check_timeout_valid_values | Hash | An object defining a set of valid values for the health check timeout. It has a key to define whether is a range of values or a list of values. |
| health_check_threshold_count_valid_values | Hash | An object defining a set of valid values for the health check threshold count. It has a key to define whether is a range of values or a list of values. |
| realm_id | String | Indicates the Id of the realm of the cloud provider. |
| cloud_provider_id | String | Identifier of the associated cloud provider. |
| realm_provider_name | String | Name of the realm of the cloud provider. |
| flavour_provider_name | String | Name of the flavour on the cloud provider. |
| deprecated | Boolean | Indicates if the load balancer plan is deprecated. |
| resource_type | String | An identifier for the type of resource, specifically "load_balancer_plan". |
List cluster plans of a cloud provider
GET /v3/cloud/cloud_providers/:cloud_provider_id/cluster_plans
This action shows the information of all cluster plans of a cloud provider.
Inputs
| Field | Type | Description | Required |
|---|---|---|---|
| realm_id | String | Identifier of the realm. | No. |
Returns
A cluster plan with the following fields:
| Field | Type | Description |
|---|---|---|
| id | String | Identifier of the cluster plan. |
| name | String | Name of the cluster plan. |
| available_versions | String | Kubernetes versions that are available for this cluster plan. |
| max_pods_per_node | Integer | Maximum number of pods that a node can have. |
| max_nodes_per_node_pool | Integer | Maximum number of nodes that a node pool can have. |
| cloud_provider_id | String | Identifier of the associated cloud provider. |
| flavour_provider_name | String | Name of the flavour. |
| realm_provider_name | String | Name of the realm of the cloud provider. |
| realm_id | String | Identifier of the realm of the cloud provider. |
| deprecated | Boolean | Indicates if the cluster plan is deprecated. |
| resource_type | String | An identifier for the type of resource, specifically "cluster_plan". |
List key vault plans of a cloud provider
GET /v3/cloud/cloud_providers/:cloud_provider_id/key_vault_plans
This action shows the information of all key vault plans of a cloud provider.
Inputs
| Field | Type | Description | Required |
|---|---|---|---|
| realm_id | String | Identifier of the realm. | No. |
Returns
A key vault plan with the following fields:
| Field | Type | Description |
|---|---|---|
| id | String | Identifier of the key vault plan. |
| name | String | Name of the key vault plan. |
| support_secrets | Boolean | Flag indicating whether this key vault plan supports secrets. |
| realm_id | String | Identifier of the realm of the cloud provider. |
| cloud_provider_id | String | Identifier of the cloud provider. |
| realm_provider_name | String | Name of the realm of the cloud provider. |
| deprecated | Boolean | Indicates if the key vault plan is deprecated. |
| resource_type | String | An identifier for the type of resource, specifically "key_vault_plan". |