senlin_dashboard.api.rest package

Submodules

senlin_dashboard.api.rest.senlin module

API for the senlin service.

class senlin_dashboard.api.rest.senlin.Cluster(**kwargs)

Bases: View

API for Senlin cluster.

delete(request, cluster_id)

Delete a specific cluster

DELETE http://localhost/api/senlin/clusters/cc758c90-3d98-4ea1-af44-aab405c9c915 # noqa

get(request, cluster_id)

Get a single cluster’s details with the cluster id.

The following get parameters may be passed in the GET

Parameters:

cluster_id – the id of the cluster

The result is a cluster object.

put(request, cluster_id)

Update a Cluster.

Returns the Cluster object on success.

url_regex = 'senlin/clusters/(?P<cluster_id>[^/]+)/$'

class senlin_dashboard.api.rest.senlin.ClusterActions(**kwargs)

Bases: View

API for Senlin cluster.

get(request, cluster_id, action)

put(request, cluster_id, action)

url_regex = 'senlin/clusters/(?P<cluster_id>[^/]+)/(?P<action>[^/]+)$'

class senlin_dashboard.api.rest.senlin.Clusters(**kwargs)

Bases: View

API for Senlin cluster.

get(request)

Get a list of clusters.

post(request)

Create a new Cluster.

Returns the new Cluster object on success.

url_regex = 'senlin/clusters/$'

class senlin_dashboard.api.rest.senlin.Events(**kwargs)

Bases: View

API for Senlin events.

get(request, obj_id)

Get a list of events.

url_regex = 'senlin/events/(?P<obj_id>[^/]+)/$'

class senlin_dashboard.api.rest.senlin.Node(**kwargs)

Bases: View

API for Senlin node.

delete(request, node_id)

Delete a specific node

DELETE http://localhost/api/senlin/nodes/cc758c90-3d98-4ea1-af44-aab405c9c915 # noqa

get(request, node_id)

Get a single node’s details with the receiver id.

The following get parameters may be passed in the GET

Parameters:

node_id – the id of the node

The result is a node object.

put(request, node_id)

Update a Node.

Returns the Node object on success.

url_regex = 'senlin/nodes/(?P<node_id>[^/]+)/$'

class senlin_dashboard.api.rest.senlin.Nodes(**kwargs)

Bases: View

API for Senlin node.

get(request)

Get a list of nodes.

post(request)

Create a new Node.

Returns the new Node object on success.

url_regex = 'senlin/nodes/$'

class senlin_dashboard.api.rest.senlin.Policies(**kwargs)

Bases: View

API for Senlin policies.

get(request)

Get a list of policies.

post(request)

Create a new Policy.

Returns the new Policy object on success.

url_regex = 'senlin/policies/$'

class senlin_dashboard.api.rest.senlin.Policy(**kwargs)

Bases: View

API for Senlin policy.

delete(request, policy_id)

Delete a specific policy

DELETE http://localhost/api/senlin/policies/cc758c90-3d98-4ea1-af44-aab405c9c915 # noqa

get(request, policy_id)

Get a single policy’s details with the policy id.

The following get parameters may be passed in the GET

Parameters:

policy_id – the id of the policy

The result is a policy object.

put(request, policy_id)

Update a Policy.

Returns the Policy object on success.

url_regex = 'senlin/policies/(?P<policy_id>[^/]+)/$'

class senlin_dashboard.api.rest.senlin.Profile(**kwargs)

Bases: View

API for Senlin profile.

delete(request, profile_id)

Delete a specific profile

DELETE http://localhost/api/senlin/profiles/cc758c90-3d98-4ea1-af44-aab405c9c915 # noqa

get(request, profile_id)

Get a single profile’s details with the profile id.

The following get parameters may be passed in the GET

Parameters:

profile_id – the id of the profile

The result is a profile object.

put(request, profile_id)

Update a Profile.

Returns the Profile object on success.

url_regex = 'senlin/profiles/(?P<profile_id>[^/]+)/$'

class senlin_dashboard.api.rest.senlin.Profiles(**kwargs)

Bases: View

API for Senlin profile.

get(request)

Get a list of profiles.

post(request)

Create a new Profile.

Returns the new Profile object on success.

url_regex = 'senlin/profiles/$'

class senlin_dashboard.api.rest.senlin.Receiver(**kwargs)

Bases: View

API for Senlin receiver.

delete(request, receiver_id)

Delete a specific receiver

DELETE http://localhost/api/senlin/receivers/cc758c90-3d98-4ea1-af44-aab405c9c915 # noqa

get(request, receiver_id)

Get a single receiver’s details with the receiver id.

The following get parameters may be passed in the GET

Parameters:

receiver_id – the id of the receiver

The result is a receiver object.

put(request, receiver_id)

Update a Profile.

Returns the Profile object on success.

url_regex = 'senlin/receivers/(?P<receiver_id>[^/]+)/$'

class senlin_dashboard.api.rest.senlin.Receivers(**kwargs)

Bases: View

API for Senlin receiver.

get(request)

Get a list of receivers.

post(request)

Create a new Receiver.

Returns the new Receiver object on success.

url_regex = 'senlin/receivers/$'

Module contents

This package holds the REST API that supports the Senlin dashboard Javascript code.