Client side of the heat engine RPC API.
Bases: object
Client side of the heat engine rpc API.
API version history:
1.0 - Initial version.
1.1 - Add support_status argument to list_resource_types()
1.4 - Add support for service list
1.9 - Add template_type option to generate_template()
1.10 - Add support for software config list
1.11 - Add support for template versions list
1.12 - Add with_detail option for stack resources list
1.13 - Add support for template functions list
1.14 - Add cancel_with_rollback option to stack_cancel_update
1.15 - Add preview_update_stack() call
1.16 - Adds version, type_name to list_resource_types()
1.17 - Add files to validate_template
1.18 - Add show_nested to validate_template
1.19 - Add show_output and list_outputs for returning stack outputs
1.20 - Add resolve_outputs to stack show
1.21 - Add deployment_id to create_software_deployment
1.22 - Add support for stack export
1.23 - Add environment_files to create/update/preview/validate
1.24 - Adds ignorable_errors to validate_template
1.25 - list_stack_resource filter update
1.26 - Add mark_unhealthy
Deletes a given stack but resources would not be deleted.
Parameters: |
|
---|
Validate the credentials in the RPC context.
Verify that the credentials in the RPC context are valid for the current cloud backend.
Parameters: | ctxt – RPC context. |
---|
Returns the number of stacks that match the given filters.
Parameters: |
|
---|---|
Returns: | an integer representing the number of matched stacks |
Creates a new stack using the template provided.
Note that at this stage the template has already been fetched from the heat-api process if using a template-url.
Parameters: |
|
---|
Creates data for CloudWatch and WaitConditions.
This could be used by CloudWatch and WaitConditions and treat HA service events like any other CloudWatch.
Parameters: |
|
---|
Deletes a given stack.
Parameters: |
|
---|
Get detailed resource information about a particular resource.
Parameters: |
|
---|
Get detailed resource information about one or more resources.
Parameters: |
|
---|
Exports the stack data in JSON format.
Parameters: |
|
---|
Return an identifier for the resource.
Parameters: |
|
---|
Generate a template based on the specified type.
Parameters: |
|
---|
Get the template.
Parameters: |
|
---|
Returns the full stack identifier for a single, live stack.
Parameters: |
|
---|
Raises the error unless its local name matches the supplied name.
Parameters: |
|
---|
Lists all events associated with a given stack.
It supports pagination (limit and marker), sorting (sort_keys and sort_dir) and filtering(filters) of the results.
Parameters: |
|
---|
Get a list of valid resource types.
Parameters: |
|
---|
List the resources belonging to a stack.
Parameters: |
|
---|
Returns attributes of all stacks.
It supports pagination (limit and marker), sorting (sort_keys and sort_dir) and filtering (filters) of the results.
Parameters: |
|
---|---|
Returns: | a list of stacks |
Get a list of available functions in a given template.
Parameters: | ctxt – RPC context |
---|
Get a list of available template versions.
Parameters: | ctxt – RPC context. |
---|
Returns the name of the error with any _Remote postfix removed.
Parameters: | error – Remote raised error to derive the name from. |
---|
Simulates a new stack using the provided template.
Note that at this stage the template has already been fetched from the heat-api process if using a template-url.
Parameters: |
|
---|
Returns the resources that would be changed in an update.
Based on the provided template and parameters.
Requires RPC version 1.15 or above.
Parameters: |
|
---|
Mark the resource as unhealthy or healthy.
Parameters: |
|
---|
Get the schema for a resource type.
Parameters: | ctxt – RPC context. |
---|
Generate an alarm on the resource.
Parameters: |
|
---|
Temporarily set the state of a given watch.
Parameters: |
|
---|
Returns detailed information about one or all stacks.
Parameters: |
|
---|
show all :param resolve_outputs: If True, stack outputs will be resolved
Returns the attributes of one watch/alarm.
The show_watch method returns the attributes of one watch or all watches if no watch_name is passed.
Parameters: |
|
---|
Returns the datapoints for a metric.
The show_watch_metric method returns the datapoints associated with a specified metric, or all metrics if no metric_name is passed.
Parameters: |
|
---|
Updates an existing stack based on the provided template and params.
Note that at this stage the template has already been fetched from the heat-api process if using a template-url.
Parameters: |
|
---|
Uses the stack parser to check the validity of a template.
Parameters: |
|
---|
validation