Realms
Contents
Realms
Realms represent regions on different cloud providers.
Show Realm
GET /v3/cloud/realms/:id
This action returns information about a realm identified by the given id.
Inputs
None
Returns
| 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 node pool plans of a realm
GET /v3/cloud/realms/:realm_id/node_pool_plans
This action shows the information of all node pool plans of a realm.
Inputs
None
Returns
A node pool plan with the following fields:
| Field | Type | Description |
|---|---|---|
| id | String | Identifier of the node pool plan. |
| name | String | Name of the node pool plan. |
| cpu_types | Array of Strings | Array of types of CPU a node pool with this plan can have. |
| autoscaling_capable | Boolean | Flag indicating whether the node pool with this plan can have autoscaling configured. |
| pods_per_node_presence | Boolean | Flag indicating whether the node pool with this plan will need to configure pods per node. |
| first_node_pool_capable | Boolean | Flag indicating whether the node pool with this plan can be the first in a cluster. |
| cpus | Integer | Number of cpus each node of the node pool with this node pool plan will have. |
| memory | Integer | Memory size each node of the node pool with this node pool plan will have, in Mibibytes (MiB). |
| cloud_provider_id | String | Identifier of the associated cloud provider. |
| realm_id | String | Identifier of the realm of the cloud provider. |
| server_plan_id | String | Identifier of the associated server plan. |
| deprecated | Boolean | Indicates if the node pool plan is deprecated. |
| resource_type | String | An identifier for the type of resource, specifically "node_pool_plan". |