Skip to content

Managed Rancher Cluster Resources

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/managed-rancher-cluster-resources/ List Managed Rancher Cluster Resources
GET /api/managed-rancher-cluster-resources/{uuid}/ Retrieve
Other Actions
POST /api/managed-rancher-cluster-resources/{uuid}/add_node/ Add node

Core CRUD

List Managed Rancher Cluster Resources

1
2
3
4
http \
  GET \
  https://api.example.com/api/managed-rancher-cluster-resources/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.managed_rancher_cluster_resources import managed_rancher_cluster_resources_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = managed_rancher_cluster_resources_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: managed_rancher_cluster_resources_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { managedRancherClusterResourcesList } from 'waldur-js-client';

try {
  const response = await managedRancherClusterResourcesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
field array
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
offering string (uri)
offering_name string
offering_uuid string (uuid)
offering_description string
offering_image string (uri)
offering_thumbnail string (uri)
offering_type string
offering_shared boolean Accessible to all customers.
offering_billable boolean Purchase and usage is invoiced.
offering_plugin_options any Public data used by specific plugin, such as storage mode for OpenStack.
provider_name string
provider_uuid string (uuid)
provider_slug string
category_title string
category_uuid string (uuid)
category_icon string (uri)
plan string (uri)
plan_unit any
plan_name string
plan_uuid string (uuid)
plan_description string
attributes object (free-form)
limits object (free-form)
uuid string (uuid)
created string (date-time)
modified string (date-time)
url string (uri)
scope string
description string
state any
resource_uuid string (uuid)
backend_id string
effective_id string
resource_type string
project string (uri)
project_uuid string (uuid)
project_name string
project_description string
project_end_date string (date) The date is inclusive. Once reached, all project resource will be scheduled for termination.
project_end_date_requested_by string (uri)
customer_uuid string (uuid)
customer_name string
offering_slug string
parent_offering_uuid string (uuid)
parent_offering_name string
parent_offering_slug string
parent_uuid string (uuid)
parent_name string
backend_metadata any
is_usage_based boolean
is_limit_based boolean
name string
slug string
current_usages object (free-form)
can_terminate boolean
report array of objects
report.header string
report.body string
end_date string (date) The date is inclusive. Once reached, a resource will be scheduled for termination.
end_date_requested_by string (uri)
username string
limit_usage object (free-form)
downscaled boolean
restrict_member_access boolean
paused boolean
endpoints array of objects
endpoints.uuid string (uuid)
endpoints.name string
endpoints.url string
error_message string
error_traceback string
options any
available_actions array of strings
last_sync string (date-time)
order_in_progress any
creation_order any
service_settings_uuid string (uuid)
project_slug string
customer_slug string
user_requires_reconsent boolean Check if the current user needs to re-consent for this resource's offering.
renewal_date object (free-form)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/managed-rancher-cluster-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.managed_rancher_cluster_resources import managed_rancher_cluster_resources_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = managed_rancher_cluster_resources_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: managed_rancher_cluster_resources_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { managedRancherClusterResourcesRetrieve } from 'waldur-js-client';

try {
  const response = await managedRancherClusterResourcesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type Description
offering string (uri)
offering_name string
offering_uuid string (uuid)
offering_description string
offering_image string (uri)
offering_thumbnail string (uri)
offering_type string
offering_shared boolean Accessible to all customers.
offering_billable boolean Purchase and usage is invoiced.
offering_plugin_options any Public data used by specific plugin, such as storage mode for OpenStack.
provider_name string
provider_uuid string (uuid)
provider_slug string
category_title string
category_uuid string (uuid)
category_icon string (uri)
plan string (uri)
plan_unit any
plan_name string
plan_uuid string (uuid)
plan_description string
attributes object (free-form)
limits object (free-form)
uuid string (uuid)
created string (date-time)
modified string (date-time)
url string (uri)
scope string
description string
state any
resource_uuid string (uuid)
backend_id string
effective_id string
resource_type string
project string (uri)
project_uuid string (uuid)
project_name string
project_description string
project_end_date string (date) The date is inclusive. Once reached, all project resource will be scheduled for termination.
project_end_date_requested_by string (uri)
customer_uuid string (uuid)
customer_name string
offering_slug string
parent_offering_uuid string (uuid)
parent_offering_name string
parent_offering_slug string
parent_uuid string (uuid)
parent_name string
backend_metadata any
is_usage_based boolean
is_limit_based boolean
name string
slug string
current_usages object (free-form)
can_terminate boolean
report array of objects
report.header string
report.body string
end_date string (date) The date is inclusive. Once reached, a resource will be scheduled for termination.
end_date_requested_by string (uri)
username string
limit_usage object (free-form)
downscaled boolean
restrict_member_access boolean
paused boolean
endpoints array of objects
endpoints.uuid string (uuid)
endpoints.name string
endpoints.url string
error_message string
error_traceback string
options any
available_actions array of strings
last_sync string (date-time)
order_in_progress any
creation_order any
service_settings_uuid string (uuid)
project_slug string
customer_slug string
user_requires_reconsent boolean Check if the current user needs to re-consent for this resource's offering.
renewal_date object (free-form)

Other Actions

Add node

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/managed-rancher-cluster-resources/a1b2c3d4-e5f6-7890-abcd-ef1234567890/add_node/ \
  Authorization:"Token YOUR_API_TOKEN" \
  role="agent" \
  subnet="https://api.example.com/api/subnet/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.managed_rancher_create_node_request import ManagedRancherCreateNodeRequest # (1)
from waldur_api_client.api.managed_rancher_cluster_resources import managed_rancher_cluster_resources_add_node # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ManagedRancherCreateNodeRequest(
    role="agent",
    subnet="https://api.example.com/api/subnet/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = managed_rancher_cluster_resources_add_node.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ManagedRancherCreateNodeRequest
  2. API Source: managed_rancher_cluster_resources_add_node
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import { managedRancherClusterResourcesAddNode } from 'waldur-js-client';

try {
  const response = await managedRancherClusterResourcesAddNode({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "role": "agent",
    "subnet": "https://api.example.com/api/subnet/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required
role string ✓
system_volume_size integer
system_volume_type string (uri)
memory integer
cpu integer
subnet string (uri) ✓
flavor string (uri)
data_volumes array of objects
data_volumes.size integer ✓
data_volumes.volume_type string (uri)
data_volumes.filesystem string
data_volumes.mount_point string ✓
ssh_public_key string (uri)
tenant string (uri)

200 -

Field Type Description
uuid string (uuid)
url string (uri)
created string (date-time)
modified string (date-time)
name string
backend_id string
project_uuid string (uuid)
service_settings_name string
service_settings_uuid string (uuid)
resource_type string
state any
cluster string (uri)
cluster_name string
cluster_uuid string (uuid)
instance string
instance_name string
instance_uuid string (uuid)
instance_marketplace_uuid string (uuid)
role string
Enum: agent, server
k8s_version string
docker_version string
cpu_allocated number (double)
cpu_total integer
ram_allocated integer Allocated RAM in Mi.
ram_total integer Total RAM in Mi.
pods_allocated integer
pods_total integer
labels any
annotations any
runtime_state string