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".

Back to top

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.
subscription_id String Identifier of the subscription.
name String The logical name for the cloud account.
remote_id String Identifier of the cloud account on Connect / APS / CBC Hub.
destroyable Boolean Flag to indicate whether the cloud account can be destroyed or not.
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 policies.
supports_importing_kubernetes_clusters Boolean Flag to indicate whether this cloud account supports importing kubernetes clusters.

Back to top

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

None

Returns

An array of server plans with the following fields:

Field Type Description
id String Identifier of the floating IP.
name String Name of the floating IP.
address String IP address of the public IP.
state String State of the floating IP.
cloud_account_id String Identifier of the cloud account of the floating IP.
realm_id String Identifier of the realm in which the floating IP is.
attached_server_id String Identifier of the server which the floating IP is attached. Nil If floating IP is not attached.
resource_type String An identifier for the type of resource, specifically "floating_ip".
label_ids Array of Strings List of ids corresponding to the labels the VPC has assigned.
brownfield Boolean Flag indicating if the floating IP is brownfield (imported).

Back to top

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.

Back to top

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".

Back to top

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".

Back to top

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".

Back to top