Rancher Services
Operations Summary
Core CRUD
List Rancher Services
Retrieve
Create
Synchronize resource state
Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.
Unlink resource
Delete resource from the database without scheduling operations on backend
and without checking current state of the resource. It is intended to be used
for removing resource stuck in transitioning state.
Update
HTTPie Python TypeScript Path Parameters Request Body (required) Responses
http \
PUT \
https://api.example.com/api/rancher-services/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
Authorization:"Token YOUR_API_TOKEN" \
name = "my-awesome-rancher-service" \
service_settings = "https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
project = "https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
target_workloads:= '[]'
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21 from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.rancher_service_request import RancherServiceRequest # (1)
from waldur_api_client.api.rancher_services import rancher_services_update # (2)
client = AuthenticatedClient (
base_url = "https://api.example.com" , token = "YOUR_API_TOKEN"
)
body_data = RancherServiceRequest (
name = "my-awesome-rancher-service" ,
service_settings = "https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" ,
project = "https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" ,
target_workloads = []
)
response = rancher_services_update . sync (
uuid = "a1b2c3d4-e5f6-7890-abcd-ef1234567890" ,
client = client ,
body = body_data
)
print ( response )
Model Source: RancherServiceRequest
API Source: rancher_services_update
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19 import { rancherServicesUpdate } from 'waldur-js-client' ;
try {
const response = await rancherServicesUpdate ({
auth : "Token YOUR_API_TOKEN" ,
path : {
"uuid" : "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
},
body : {
"name" : "my-awesome-rancher-service" ,
"service_settings" : "https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" ,
"project" : "https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" ,
"target_workloads" : []
}
});
console . log ( 'Success:' , response );
} catch ( error ) {
console . error ( 'Error:' , error );
}
Name
Type
Required
uuid
string (uuid)
✓
Field
Type
Required
Description
name
string
✓
description
string
service_settings
string (uri)
✓
project
string (uri)
✓
error_message
string
error_traceback
string
backend_id
string
runtime_state
string
namespace
string (uri)
cluster_ip
any
An IPv4 or IPv6 address.
selector
any
target_workloads
array of objects
✓
target_workloads.name
string
✓
200 -
Field
Type
Description
url
string (uri)
uuid
string (uuid)
name
string
description
string
service_name
string
service_settings
string (uri)
service_settings_uuid
string (uuid)
service_settings_state
string
service_settings_error_message
string
project
string (uri)
project_name
string
project_uuid
string (uuid)
customer
string (uri)
customer_uuid
string (uuid)
customer_name
string
customer_native_name
string
customer_abbreviation
string
error_message
string
error_traceback
string
resource_type
string
state
any
created
string (date-time)
modified
string (date-time)
backend_id
string
access_url
string
runtime_state
string
namespace
string (uri)
namespace_name
string
cluster_ip
any
An IPv4 or IPv6 address.
selector
any
target_workloads
array of objects
target_workloads.uuid
string (uuid)
target_workloads.url
string (uri)
target_workloads.name
string
marketplace_offering_uuid
string
marketplace_offering_name
string
marketplace_offering_plugin_options
object (free-form)
marketplace_category_uuid
string
marketplace_category_name
string
marketplace_resource_uuid
string
marketplace_plan_uuid
string
marketplace_resource_state
string
is_usage_based
boolean
is_limit_based
boolean
Partial Update
Delete
Other Actions
Yaml
Yaml
HTTPie Python TypeScript Path Parameters Request Body (required) Responses
http \
PUT \
https://api.example.com/api/rancher-services/a1b2c3d4-e5f6-7890-abcd-ef1234567890/yaml/ \
Authorization:"Token YOUR_API_TOKEN" \
name = "my-awesome-rancher-service" \
service_settings = "https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
project = "https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" \
target_workloads:= '[]'
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21 from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.rancher_service_request import RancherServiceRequest # (1)
from waldur_api_client.api.rancher_services import rancher_services_yaml_update # (2)
client = AuthenticatedClient (
base_url = "https://api.example.com" , token = "YOUR_API_TOKEN"
)
body_data = RancherServiceRequest (
name = "my-awesome-rancher-service" ,
service_settings = "https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" ,
project = "https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" ,
target_workloads = []
)
response = rancher_services_yaml_update . sync (
uuid = "a1b2c3d4-e5f6-7890-abcd-ef1234567890" ,
client = client ,
body = body_data
)
print ( response )
Model Source: RancherServiceRequest
API Source: rancher_services_yaml_update
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19 import { rancherServicesYamlUpdate } from 'waldur-js-client' ;
try {
const response = await rancherServicesYamlUpdate ({
auth : "Token YOUR_API_TOKEN" ,
path : {
"uuid" : "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
},
body : {
"name" : "my-awesome-rancher-service" ,
"service_settings" : "https://api.example.com/api/service-settings/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" ,
"project" : "https://api.example.com/api/project/a1b2c3d4-e5f6-7890-abcd-ef1234567890/" ,
"target_workloads" : []
}
});
console . log ( 'Success:' , response );
} catch ( error ) {
console . error ( 'Error:' , error );
}
Name
Type
Required
uuid
string (uuid)
✓
Field
Type
Required
Description
name
string
✓
description
string
service_settings
string (uri)
✓
project
string (uri)
✓
error_message
string
error_traceback
string
backend_id
string
runtime_state
string
namespace
string (uri)
cluster_ip
any
An IPv4 or IPv6 address.
selector
any
target_workloads
array of objects
✓
target_workloads.name
string
✓
200 -
Field
Type
Description
url
string (uri)
uuid
string (uuid)
name
string
description
string
service_name
string
service_settings
string (uri)
service_settings_uuid
string (uuid)
service_settings_state
string
service_settings_error_message
string
project
string (uri)
project_name
string
project_uuid
string (uuid)
customer
string (uri)
customer_uuid
string (uuid)
customer_name
string
customer_native_name
string
customer_abbreviation
string
error_message
string
error_traceback
string
resource_type
string
state
any
created
string (date-time)
modified
string (date-time)
backend_id
string
access_url
string
runtime_state
string
namespace
string (uri)
namespace_name
string
cluster_ip
any
An IPv4 or IPv6 address.
selector
any
target_workloads
array of objects
target_workloads.uuid
string (uuid)
target_workloads.url
string (uri)
target_workloads.name
string
marketplace_offering_uuid
string
marketplace_offering_name
string
marketplace_offering_plugin_options
object (free-form)
marketplace_category_uuid
string
marketplace_category_name
string
marketplace_resource_uuid
string
marketplace_plan_uuid
string
marketplace_resource_state
string
is_usage_based
boolean
is_limit_based
boolean