The Senlin API supports a ”major versions” expressed in request URLs and
”microversions” which can be sent in HTTP header OpenStack-API-Version.
When the specified OpenStack-API-Version is not supported by the API
service, a 406 (NotAcceptable) exception will be raised. Note that this applies
to all API requests documented in this guide.
GET
/
List Major Versions
Lists information for all Clustering API major versions.
A unique ID for tracking service request. The request ID associated
with the request by default appears in the service logs.
versions
body
array
A list of supported major API versions.
id
body
string
The string representation of an API version number, e.g. 1.0.
links
body
array
A list of relative URLs to different version objects.
max_version
body
string
The string representation of the maximum microversion supported.
media-types
body
array
A list of content-type based media type request supported.
min_version
body
string
The string representation of the minimum microversion supported.
status
body
string
A string indicating the supporting status of the version.
updated
body
string
The date and time when the version was last updated. The date and time
stamp format is ISO8601: CCYY-MM-DDThh:mm:ssZ. For example:
2016-01-18T00:00:00Z
A unique ID for tracking service request. The request ID associated
with the request by default appears in the service logs.
version
body
object
The details about a major API version.
id
body
string
The string representation of an API version number, e.g. 1.0.
links
body
array
A list of relative URLs to different version objects.
max_version
body
string
The string representation of the maximum microversion supported.
media-types
body
array
A list of content-type based media type request supported.
min_version
body
string
The string representation of the minimum microversion supported.
status
body
string
A string indicating the supporting status of the version.
updated
body
string
The date and time when the version was last updated. The date and time
stamp format is ISO8601: CCYY-MM-DDThh:mm:ssZ. For example:
2016-01-18T00:00:00Z
A unique ID for tracking service request. The request ID associated
with the request by default appears in the service logs.
profile_types
body
array
A list of profile_type objects. Since API micro-version 1.5, each record
in the list will have a “support_status” property which contains a list
of support status changes.
A unique ID for tracking service request. The request ID associated
with the request by default appears in the service logs.
profile_type
body
object
A structured description of a profile type. Since API micro-version 1.5,
a “support_status” property is returned which contains a list
of support status changes.
name
body
string
The name of the profile type.
schema
body
object
The schema of a profile type. The schema of a profile type varies
a lot based on the specific type implementation. All profile types
share the context property which is a dictionary for customizing
the request context to authenticate with a backend service. A common
usage of this property is to set the region_name in the dictionary
so that a node can be created in the specified region. All other
properties are defined by a particular profile type implementation.
For API microversion lower than 1.5, the response only contains the name and
schema of the specified profile type:
{"profile_type":{"name":"os.heat.stack-1.0","schema":{"context":{"default":{},"description":"A dictionary for specifying the customized context for stack operations","readonly":false,"required":false,"type":"Map","updatable":false},"disable_rollback":{"default":true,"description":"A boolean specifying whether a stack operation can be rolled back.","readonly":false,"required":false,"type":"Boolean","updatable":true},"environment":{"default":{},"description":"A map that specifies the environment used for stack operations.","readonly":false,"required":false,"type":"Map","updatable":true},"files":{"default":{},"description":"Contents of files referenced by the template, if any.","readonly":false,"required":false,"type":"Map","updatable":true},"parameters":{"default":{},"description":"Parameters to be passed to Heat for stack operations.","readonly":false,"required":false,"type":"Map","updatable":true},"template":{"description":"Heat stack template.","readonly":false,"required":true,"type":"Map","updatable":true},"timeout":{"description":"A integer that specifies the number of minutes that a stack operation times out.","readonly":false,"required":false,"type":"Integer","updatable":true}}}}
Since API microversion 1.5, the response contains the support status of the
specified profile type:
{"profile_type":{"name":"os.heat.stack-1.0","schema":{"context":{"default":{},"description":"A dictionary for specifying the customized context for stack operations","readonly":false,"required":false,"type":"Map","updatable":false},"disable_rollback":{"default":true,"description":"A boolean specifying whether a stack operation can be rolled back.","readonly":false,"required":false,"type":"Boolean","updatable":true},"environment":{"default":{},"description":"A map that specifies the environment used for stack operations.","readonly":false,"required":false,"type":"Map","updatable":true},"files":{"default":{},"description":"Contents of files referenced by the template, if any.","readonly":false,"required":false,"type":"Map","updatable":true},"parameters":{"default":{},"description":"Parameters to be passed to Heat for stack operations.","readonly":false,"required":false,"type":"Map","updatable":true},"template":{"description":"Heat stack template.","readonly":false,"required":true,"type":"Map","updatable":true},"timeout":{"description":"A integer that specifies the number of minutes that a stack operation times out.","readonly":false,"required":false,"type":"Integer","updatable":true}}"support_status":{"1.0":[{"status":"SUPPORTED","since":"2016.04"}]}}}
GET
/v1/profile-types/{profile_type}/ops
List profile type operations
List operations and parameters supported by a profile type.
This API is only available since API microversion 1.4.
{"operations":{"reboot":{"description":"reboot the specified VM instance","parameters":{"type":{"default":"SOFT","description":"Type of reboot requested","required":false,"type":"String"}}}}}
API microversion request. It takes the form of
OpenStack-API-Version:clustering1.0, where 1.0 is the requested
API version.
limit (Optional)
query
integer
Requests a page size of resources. Returns a number of resources up to the
limit value. Use the limit parameter to make an initial limited request
and use the ID of the last-seen resource from the response as the marker
parameter value in a subsequent limited request.
marker (Optional)
query
UUID
The ID of the last-seen resource. Use the limit parameter to make an
initial limited request and use the ID of the last-seen resource from the
response as the marker parameter value in a subsequent limited request.
sort (Optional)
query
string
Sorts the response by one or more attribute and optional sort direction
combinations. A valid direction is asc (ascending) or desc
(descending). Default direction is asc (ascending).
Specify the list as <key>[:<direction>].
For example, the following query parameters in the URI sort the resources
in the response by name in ascending order and then by status in
descending order:
GET /v1/clusters?sort=name:asc,status:desc
global_project (Optional)
query
boolean
Indicates whether to include resources for all projects or resources for
the current project in the response.
If you are an administrative user and you set this value to true, the
call returns all resources from all projects. Default is false, which
returns only resources in the current project.
name (Optional)
query
string
Filters the response by the name property of the object.
type (Optional)
query
string
Filters the response by the type property of the object.
API microversion request. It takes the form of
OpenStack-API-Version:clustering1.0, where 1.0 is the requested
API version.
profile
body
object
A structured description of a profile object.
name
body
string
The name of a profile object. The name must start with an ASCII letter
and can contain ASCII letters, digits, underscores, periods, and hyphens
and its length must be less than 255.
metadata (Optional)
body
object
A collection of key-value pairs associated with an object.
A unique ID for tracking service request. The request ID associated
with the request by default appears in the service logs.
policy_types
body
array
A list of policy_type objects. Since API micro-version 1.5, each record
in the list will have a “support_status” property which contains a list
of support status changes.
A unique ID for tracking service request. The request ID associated
with the request by default appears in the service logs.
policy_type
body
object
A structured description of a policy type. Since API micro-version 1.5,
a “support_status” property is returned which contains a list
of support status changes.
name
body
string
The name of the policy type.
schema
body
object
The schema of a policy type. The schema of a policy type varies a lot
based on the specific type implementation.
For API microversion lower than 1.5, the response only contains the name and
schema of the specified policy type:
{"policy_type":{"name":"senlin.policy.affinity-1.0","schema":{"availability_zone":{"description":"Name of the availability zone to place the nodes.","readonly":false,"required":false,"type":"String","updatable":false},"enable_drs_extension":{"default":false,"description":"Enable vSphere DRS extension.","readonly":false,"required":false,"type":"Boolean","updatable":false},"servergroup":{"description":"Properties of the VM server group","readonly":false,"required":false,"schema":{"name":{"description":"The name of the server group","readonly":false,"required":false,"type":"String","updatable":false},"policies":{"constraints":[{"constraint":["affinity","anti-affinity"],"type":"AllowedValues"}],"default":"anti-affinity","description":"The server group policies.","readonly":false,"required":false,"type":"String","updatable":false}},"type":"Map","updatable":false}}}}
Since API microversion 1.5, the response contains the support status of the
specified policy type:
{"policy_type":{"name":"senlin.policy.affinity-1.0","schema":{"availability_zone":{"description":"Name of the availability zone to place the nodes.","readonly":false,"required":false,"type":"String","updatable":false},"enable_drs_extension":{"default":false,"description":"Enable vSphere DRS extension.","readonly":false,"required":false,"type":"Boolean","updatable":false},"servergroup":{"description":"Properties of the VM server group","readonly":false,"required":false,"schema":{"name":{"description":"The name of the server group","readonly":false,"required":false,"type":"String","updatable":false},"policies":{"constraints":[{"constraint":["affinity","anti-affinity"],"type":"AllowedValues"}],"default":"anti-affinity","description":"The server group policies.","readonly":false,"required":false,"type":"String","updatable":false}},"type":"Map","updatable":false}}"support_status":{"1.0":[{"status":"SUPPORTED","since":"2016.10"}]}}}
API microversion request. It takes the form of
OpenStack-API-Version:clustering1.0, where 1.0 is the requested
API version.
limit (Optional)
query
integer
Requests a page size of resources. Returns a number of resources up to the
limit value. Use the limit parameter to make an initial limited request
and use the ID of the last-seen resource from the response as the marker
parameter value in a subsequent limited request.
marker (Optional)
query
UUID
The ID of the last-seen resource. Use the limit parameter to make an
initial limited request and use the ID of the last-seen resource from the
response as the marker parameter value in a subsequent limited request.
sort (Optional)
query
string
Sorts the response by one or more attribute and optional sort direction
combinations. A valid direction is asc (ascending) or desc
(descending). Default direction is asc (ascending).
Specify the list as <key>[:<direction>].
For example, the following query parameters in the URI sort the resources
in the response by name in ascending order and then by status in
descending order:
GET /v1/clusters?sort=name:asc,status:desc
global_project (Optional)
query
boolean
Indicates whether to include resources for all projects or resources for
the current project in the response.
If you are an administrative user and you set this value to true, the
call returns all resources from all projects. Default is false, which
returns only resources in the current project.
name (Optional)
query
string
Filters the response by the name property of the object.
type (Optional)
query
string
Filters the response by the type property of the object.
{"policies":[{"created_at":"2015-02-15T08:33:13.000000","data":{},"domain":null,"id":"7192d8df-73be-4e98-ab99-1cf6d5066729","name":"test_policy_1","project":"42d9e9663331431f97b75e25136307ff","spec":{"description":"A test policy","properties":{"criteria":"OLDEST_FIRST","destroy_after_deletion":true,"grace_period":60,"reduce_desired_capacity":false},"type":"senlin.policy.deletion","version":"1.0"},"type":"senlin.policy.deletion-1.0","updated_at":null,"user":"5e5bf8027826429c96af157f68dc9072"}]}
API microversion request. It takes the form of
OpenStack-API-Version:clustering1.0, where 1.0 is the requested
API version.
policy
body
object
A structured description of a policy object.
name
body
string
The name of a policy object. The name must start with an ASCII letter
and can contain ASCII letters, digits, underscores, periods, and hyphens
and its length must be less than 255.
{"policy":{"created_at":"2015-10-14T09:14:53","data":{},"domain":null,"id":"ac5415bd-f522-4160-8be0-f8853e4bc332","name":"dp01","project":"42d9e9663331431f97b75e25136307ff","spec":{"description":"A policy for node deletion.","properties":{"criteria":"OLDEST_FIRST","destroy_after_deletion":true,"grace_period":60,"reduce_desired_capacity":false},"type":"senlin.policy.deletion","version":"1.0"},"type":"senlin.policy.deletion-1.0","updated_at":null,"user":"5e5bf8027826429c96af157f68dc9072"}}
API microversion request. It takes the form of
OpenStack-API-Version:clustering1.0, where 1.0 is the requested
API version.
limit (Optional)
query
integer
Requests a page size of resources. Returns a number of resources up to the
limit value. Use the limit parameter to make an initial limited request
and use the ID of the last-seen resource from the response as the marker
parameter value in a subsequent limited request.
marker (Optional)
query
UUID
The ID of the last-seen resource. Use the limit parameter to make an
initial limited request and use the ID of the last-seen resource from the
response as the marker parameter value in a subsequent limited request.
sort (Optional)
query
string
Sorts the response by one or more attribute and optional sort direction
combinations. A valid direction is asc (ascending) or desc
(descending). Default direction is asc (ascending).
Specify the list as <key>[:<direction>].
For example, the following query parameters in the URI sort the resources
in the response by name in ascending order and then by status in
descending order:
GET /v1/clusters?sort=name:asc,status:desc
global_project (Optional)
query
boolean
Indicates whether to include resources for all projects or resources for
the current project in the response.
If you are an administrative user and you set this value to true, the
call returns all resources from all projects. Default is false, which
returns only resources in the current project.
name (Optional)
query
string
Filters the response by the name property of the object.
status (Optional)
query
string
Filters the resource collection by the status property.
A unique ID for tracking service request. The request ID associated
with the request by default appears in the service logs.
clusters
body
array
A list of cluster objects.
created_at
body
string
The date and time when the object was created. The date and time stamp
format is ISO8601: CCYY-MM-DDThh:mm:ssZ. For example:
2016-01-18T00:00:00Z
data
body
object
The structured data associated with the cluster.
desired_capacity
body
integer
The desired capacity of a cluster. When creating a cluster, this value is
set to 0 by default.
domain
body
UUID
The ID of the domain a resource is created in.
id
body
UUID
The UUID of the cluster object.
init_at
body
string
The date and time when the object was initialized. The date and
time stamp format is ISO8601: CCYY-MM-DDThh:mm:ssZ. For example:
2016-01-18T00:00:00Z
max_size
body
integer
The maximum size of a cluster, i.e. the maximum number of nodes that can
be members of the cluster. A value of -1 means that the cluster doesn’t
have an upper bound regarding the number of member nodes.
metadata
body
object
A collection of key-value pairs associated with an object.
min_size
body
integer
The minimum size of a cluster, i.e. the minimum number of nodes that can
be members of the cluster.
name
body
string
The name of the object in question.
nodes
body
array
A list of the UUIDs of node objects which are members of the current
cluster.
policies
body
array
A list of UUIDs of the policies attached to current cluster.
profile_id
body
UUID
The UUID of the profile.
profile_name
body
string
The name of a profile object. The name must start with an ASCII letter
and can contain ASCII letters, digits, underscores, periods, and hyphens
and its length must be less than 255.
project
body
UUID
The ID of the project a resource is created in.
status
body
string
The string representation of the current status of the cluster.
status_reason
body
string
The string representation of the reason why the object has transited to
its current status.
timeout
body
integer
The default timeout value (in seconds) of cluster operations.
updated_at
body
string
The date and time when the object was last updated. The date and time
stamp format is ISO8601: CCYY-MM-DDThh:mm:ssZ. For example:
2016-01-18T00:00:00Z
API microversion request. It takes the form of
OpenStack-API-Version:clustering1.0, where 1.0 is the requested
API version.
cluster
body
object
The structured definition of a cluster object.
name
body
string
The name of a cluster object. The name must start with an ASCII letter
and can contain ASCII letters, digits, underscores, periods, and hyphens
and its length must be less than 255.
desired_capacity
body
integer
The desired capacity of a cluster. When creating a cluster, this value is
set to 0 by default.
profile_id
body
string
The name, short-ID, or UUID of a profile.
min_size (Optional)
body
integer
The minimum size of a cluster, i.e. the minimum number of nodes that can
be members of the cluster.
timeout (Optional)
body
integer
The new timeout value (in seconds) of cluster operations.
max_size (Optional)
body
integer
The maximum size of a cluster, i.e. the maximum number of nodes that can
be members of the cluster. A value of -1 means that the cluster doesn’t
have an upper bound regarding the number of member nodes.
metadata (Optional)
body
object
A collection of key-value pairs associated with an object.
A unique ID for tracking service request. The request ID associated
with the request by default appears in the service logs.
Location
header
string
For asynchronous object operations, the location header contains a
string that can be interpreted as a relative URI from where users can
track the progress of the action triggered.
cluster
body
object
The structured definition of a cluster object.
created_at
body
string
The date and time when the object was created. The date and time stamp
format is ISO8601: CCYY-MM-DDThh:mm:ssZ. For example:
2016-01-18T00:00:00Z
data
body
object
The structured data associated with the cluster.
desired_capacity
body
integer
The desired capacity of a cluster. When creating a cluster, this value is
set to 0 by default.
domain
body
UUID
The ID of the domain a resource is created in.
id
body
UUID
The UUID of the cluster object.
init_at
body
string
The date and time when the object was initialized. The date and
time stamp format is ISO8601: CCYY-MM-DDThh:mm:ssZ. For example:
2016-01-18T00:00:00Z
max_size
body
integer
The maximum size of a cluster, i.e. the maximum number of nodes that can
be members of the cluster. A value of -1 means that the cluster doesn’t
have an upper bound regarding the number of member nodes.
metadata
body
object
A collection of key-value pairs associated with an object.
min_size
body
integer
The minimum size of a cluster, i.e. the minimum number of nodes that can
be members of the cluster.
name
body
string
The name of the object in question.
nodes
body
array
A list of the UUIDs of node objects which are members of the current
cluster.
policies
body
array
A list of UUIDs of the policies attached to current cluster.
profile_id
body
UUID
The UUID of the profile.
profile_name
body
string
The name of a profile object. The name must start with an ASCII letter
and can contain ASCII letters, digits, underscores, periods, and hyphens
and its length must be less than 255.
project
body
UUID
The ID of the project a resource is created in.
status
body
string
The string representation of the current status of the cluster.
status_reason
body
string
The string representation of the reason why the object has transited to
its current status.
timeout
body
integer
The default timeout value (in seconds) of cluster operations.
updated_at
body
string
The date and time when the object was last updated. The date and time
stamp format is ISO8601: CCYY-MM-DDThh:mm:ssZ. For example:
2016-01-18T00:00:00Z
A unique ID for tracking service request. The request ID associated
with the request by default appears in the service logs.
cluster
body
object
The structured definition of a cluster object.
created_at
body
string
The date and time when the object was created. The date and time stamp
format is ISO8601: CCYY-MM-DDThh:mm:ssZ. For example:
2016-01-18T00:00:00Z
data
body
object
The structured data associated with the cluster.
desired_capacity
body
integer
The desired capacity of a cluster. When creating a cluster, this value is
set to 0 by default.
domain
body
UUID
The ID of the domain a resource is created in.
id
body
UUID
The UUID of the cluster object.
init_at
body
string
The date and time when the object was initialized. The date and
time stamp format is ISO8601: CCYY-MM-DDThh:mm:ssZ. For example:
2016-01-18T00:00:00Z
max_size
body
integer
The maximum size of a cluster, i.e. the maximum number of nodes that can
be members of the cluster. A value of -1 means that the cluster doesn’t
have an upper bound regarding the number of member nodes.
metadata
body
object
A collection of key-value pairs associated with an object.
min_size
body
integer
The minimum size of a cluster, i.e. the minimum number of nodes that can
be members of the cluster.
name
body
string
The name of the object in question.
nodes
body
array
A list of the UUIDs of node objects which are members of the current
cluster.
policies
body
array
A list of UUIDs of the policies attached to current cluster.
profile_id
body
UUID
The UUID of the profile.
profile_name
body
string
The name of a profile object. The name must start with an ASCII letter
and can contain ASCII letters, digits, underscores, periods, and hyphens
and its length must be less than 255.
project
body
UUID
The ID of the project a resource is created in.
status
body
string
The string representation of the current status of the cluster.
status_reason
body
string
The string representation of the reason why the object has transited to
its current status.
timeout
body
integer
The default timeout value (in seconds) of cluster operations.
updated_at
body
string
The date and time when the object was last updated. The date and time
stamp format is ISO8601: CCYY-MM-DDThh:mm:ssZ. For example:
2016-01-18T00:00:00Z
Request was accepted for processing, but the processing has not been
completed. A ‘location’ header is included in the response which contains
a link to check the progress of the request.
API microversion request. It takes the form of
OpenStack-API-Version:clustering1.0, where 1.0 is the requested
API version.
cluster_id
path
string
The name, UUID or short-UUID of a cluster object.
cluster
body
object
The structured definition of a cluster object.
name (Optional)
body
string
The new name of the object in question.
profile_id (Optional)
body
string
The name, short-ID, or UUID of a profile.
timeout (Optional)
body
integer
The new timeout value (in seconds) of cluster operations.
metadata (Optional)
body
object
A collection of key-value pairs associated with an object.
profile_only (Optional)
body
boolean
Whether the update of profile is limited to the target cluster. All nodes
in the cluster will be updated with the specified new profile if this
parameter is set to False. The default value is False.
A unique ID for tracking service request. The request ID associated
with the request by default appears in the service logs.
Location
header
string
For asynchronous object operations, the location header contains a
string that can be interpreted as a relative URI from where users can
track the progress of the action triggered.
cluster
body
object
The structured definition of a cluster object.
created_at
body
string
The date and time when the object was created. The date and time stamp
format is ISO8601: CCYY-MM-DDThh:mm:ssZ. For example:
2016-01-18T00:00:00Z
data
body
object
The structured data associated with the cluster.
desired_capacity
body
integer
The desired capacity of a cluster. When creating a cluster, this value is
set to 0 by default.
domain
body
UUID
The ID of the domain a resource is created in.
id
body
UUID
The UUID of the cluster object.
init_at
body
string
The date and time when the object was initialized. The date and
time stamp format is ISO8601: CCYY-MM-DDThh:mm:ssZ. For example:
2016-01-18T00:00:00Z
max_size
body
integer
The maximum size of a cluster, i.e. the maximum number of nodes that can
be members of the cluster. A value of -1 means that the cluster doesn’t
have an upper bound regarding the number of member nodes.
metadata
body
object
A collection of key-value pairs associated with an object.
min_size
body
integer
The minimum size of a cluster, i.e. the minimum number of nodes that can
be members of the cluster.
name
body
string
The name of the object in question.
nodes
body
array
A list of the UUIDs of node objects which are members of the current
cluster.
policies
body
array
A list of UUIDs of the policies attached to current cluster.
profile_id
body
UUID
The UUID of the profile.
profile_name
body
string
The name of a profile object. The name must start with an ASCII letter
and can contain ASCII letters, digits, underscores, periods, and hyphens
and its length must be less than 255.
project
body
UUID
The ID of the project a resource is created in.
status
body
string
The string representation of the current status of the cluster.
status_reason
body
string
The string representation of the reason why the object has transited to
its current status.
timeout
body
integer
The default timeout value (in seconds) of cluster operations.
updated_at
body
string
The date and time when the object was last updated. The date and time
stamp format is ISO8601: CCYY-MM-DDThh:mm:ssZ. For example:
2016-01-18T00:00:00Z
A cluster cannot be deleted if there are still policies attached to it.
It cannot be deleted if there are still receivers associated with it. In both
cases, a 409 error will be returned.
Request was accepted for processing, but the processing has not been
completed. A ‘location’ header is included in the response which contains
a link to check the progress of the request.
A unique ID for tracking service request. The request ID associated
with the request by default appears in the service logs.
Location
header
string
For asynchronous object operations, the location header contains a
string that can be interpreted as a relative URI from where users can
track the progress of the action triggered.
Request was accepted for processing, but the processing has not been
completed. A ‘location’ header is included in the response which contains
a link to check the progress of the request.
The <action_name> indicates the requested action while the <param>
keys provide the associated parameters to the action. Each individual
action has its own set of parameters.
adjustment_type (Optional)
body
string
The type of size adjustment. The valid values are:
EXACT_CAPACITY: The adjustment number specified is to be interpreted
as the targeted desired_capacity. This value has to be a non-negative
integer.
CHANGE_IN_CAPACITY: The adjustment number specified is to be treated
as the number of nodes to add or remove. The value has to be a non-zero
integer. A positive number can be used to specify the number of nodes to
add while a negative number can be specified to indicate the number of
nodes to remove.
CHANGE_IN_PERCENTAGE: The adjustment number will be interpreted as
a percentile relative to a cluster’s current desired_capacity. The
adjustment number can be a positive or negative float value.
This parameter is optional when a resize request is only about changing the
min_size and/or max_size of the cluster. Otherwise, it is required.
When this parameter is specified, the number parameter has to be
provided as well.
number (Optional)
body
number
The number of adjustment. The interpretation of the value depends on the
value of the adjustment_type parameter. This parameter is mandatory
when adjustment_type is specified. Otherwise, it is optional.
When adjustment_type is specified as CHANGE_IN_PERCENTAGE, the
value of this parameter can be a float number, otherwise it has to be an
integer.
min_size (Optional)
body
integer
The value to be set as the new min_size of the cluster.
max_size (Optional)
body
integer
The value to be set as the new max_size of the cluster.
min_step (Optional)
body
integer
When adjustment_type is set to CHANGE_IN_PERCENTAGE, often times
the computed value is a float which could be less than 1.0. The
min_step can be used to specify that at least this number of nodes will
be added or removed.
strict (Optional)
body
boolean
There are cases where the computed number of nodes to adjust will break
the size constraints of a cluster, i.e. its min_size or max_size
property. If this is the case, the strict parameter can further
instructs the senlin engine whether the resize should be done on a best
effort basis. If the value is set to True, senlin engine will perform the
resize operation while respecting the cluster’s size constraints.
Otherwise, if the computed adjustment will break the size constraints, the
resize request will be directly rejected.
The action_name in the request body has to be resize.
A unique ID for tracking service request. The request ID associated
with the request by default appears in the service logs.
Location
header
string
For asynchronous object operations, the location header contains a
string that can be interpreted as a relative URI from where users can
track the progress of the action triggered.
Request was accepted for processing, but the processing has not been
completed. A ‘location’ header is included in the response which contains
a link to check the progress of the request.
The <action_name> indicates the requested action while the <param>
keys provide the associated parameters to the action. Each individual
action has its own set of parameters.
count (Optional)
body
integer
The number of new nodes to add to or remove from the specified cluster.
The interpretation is depending on the action requested. Default value is
1.
The action_name in the request body has to be scale_in.
A unique ID for tracking service request. The request ID associated
with the request by default appears in the service logs.
Location
header
string
For asynchronous object operations, the location header contains a
string that can be interpreted as a relative URI from where users can
track the progress of the action triggered.
Request was accepted for processing, but the processing has not been
completed. A ‘location’ header is included in the response which contains
a link to check the progress of the request.
The <action_name> indicates the requested action while the <param>
keys provide the associated parameters to the action. Each individual
action has its own set of parameters.
count (Optional)
body
integer
The number of new nodes to add to or remove from the specified cluster.
The interpretation is depending on the action requested. Default value is
1.
The action_name in the request body has to be scale_out.
A unique ID for tracking service request. The request ID associated
with the request by default appears in the service logs.
Location
header
string
For asynchronous object operations, the location header contains a
string that can be interpreted as a relative URI from where users can
track the progress of the action triggered.
Request was accepted for processing, but the processing has not been
completed. A ‘location’ header is included in the response which contains
a link to check the progress of the request.
The <action_name> indicates the requested action while the <param>
keys provide the associated parameters to the action. Each individual
action has its own set of parameters.
nodes
body
array
The candidate nodes to be added to or removed from a cluster. The meaning
of the parameter is depended on the action requested.
Each item in the list can be the name, the short-ID or the UUID of a node.
The action_name in the request body has to be add_nodes.
A unique ID for tracking service request. The request ID associated
with the request by default appears in the service logs.
Location
header
string
For asynchronous object operations, the location header contains a
string that can be interpreted as a relative URI from where users can
track the progress of the action triggered.
POST
/v1/clusters/{cluster_id}/actions
Remove nodes from a Cluster
Remove the specified list of nodes from the cluster.
Request was accepted for processing, but the processing has not been
completed. A ‘location’ header is included in the response which contains
a link to check the progress of the request.
The <action_name> indicates the requested action while the <param>
keys provide the associated parameters to the action. Each individual
action has its own set of parameters.
nodes
body
array
The candidate nodes to be added to or removed from a cluster. The meaning
of the parameter is depended on the action requested.
Each item in the list can be the name, the short-ID or the UUID of a node.
destroy_after_deletion (Optional)
body
boolean
Whether deleted nodes to be destroyed right away.
New in version 1.4
The action_name in the request body has to be del_nodes.
A unique ID for tracking service request. The request ID associated
with the request by default appears in the service logs.
Location
header
string
For asynchronous object operations, the location header contains a
string that can be interpreted as a relative URI from where users can
track the progress of the action triggered.
POST
/v1/clusters/{cluster_id}/actions
Replace nodes in a Cluster
Replace the specified nodes in a cluster.
This API is only available since API microversion 1.3.
Request was accepted for processing, but the processing has not been
completed. A ‘location’ header is included in the response which contains
a link to check the progress of the request.
The <action_name> indicates the requested action while the <param>
keys provide the associated parameters to the action. Each individual
action has its own set of parameters.
nodes
body
object
A collection of key-value pairs. Each key is the node to be replaced of a
cluster, each value is the node used to replace the original one.
Each item in of the key-value pairs can be the name, the short-ID or the
UUID of a node.
The action_name in the request body has to be replace_nodes.
A unique ID for tracking service request. The request ID associated
with the request by default appears in the service logs.
Location
header
string
For asynchronous object operations, the location header contains a
string that can be interpreted as a relative URI from where users can
track the progress of the action triggered.
Request was accepted for processing, but the processing has not been
completed. A ‘location’ header is included in the response which contains
a link to check the progress of the request.
The <action_name> indicates the requested action while the <param>
keys provide the associated parameters to the action. Each individual
action has its own set of parameters.
policy_id
body
string
The name, UUID or short-UUID of a policy object.
enabled
body
boolean
Whether the policy is enabled on the attached cluster.
The action_name in the request body has to be attach_policy.
A unique ID for tracking service request. The request ID associated
with the request by default appears in the service logs.
Location
header
string
For asynchronous object operations, the location header contains a
string that can be interpreted as a relative URI from where users can
track the progress of the action triggered.
Request was accepted for processing, but the processing has not been
completed. A ‘location’ header is included in the response which contains
a link to check the progress of the request.
The <action_name> indicates the requested action while the <param>
keys provide the associated parameters to the action. Each individual
action has its own set of parameters.
policy_id
body
string
The name, UUID or short-UUID of a policy object.
The action_name in the request body has to be detach_policy.
A unique ID for tracking service request. The request ID associated
with the request by default appears in the service logs.
Location
header
string
For asynchronous object operations, the location header contains a
string that can be interpreted as a relative URI from where users can
track the progress of the action triggered.
Request was accepted for processing, but the processing has not been
completed. A ‘location’ header is included in the response which contains
a link to check the progress of the request.
The <action_name> indicates the requested action while the <param>
keys provide the associated parameters to the action. Each individual
action has its own set of parameters.
policy_id
body
string
The name, UUID or short-UUID of a policy object.
enabled
body
boolean
Whether the policy is enabled on the attached cluster.
The action_name in the request body has to be update_policy.
A unique ID for tracking service request. The request ID associated
with the request by default appears in the service logs.
Location
header
string
For asynchronous object operations, the location header contains a
string that can be interpreted as a relative URI from where users can
track the progress of the action triggered.
GET
/v1/clusters/{cluster_id}/attrs/{path}
Collect Attributes Across a Cluster
Aggregate an attribute value across all nodes in a cluster.
This API is only available since API microversion 1.2.
Request was accepted for processing, but the processing has not been
completed. A ‘location’ header is included in the response which contains
a link to check the progress of the request.
Request was accepted for processing, but the processing has not been
completed. A ‘location’ header is included in the response which contains
a link to check the progress of the request.
The <action_name> indicates the requested action while the <param>
keys provide the associated parameters to the action. Each individual
action has its own set of parameters.
params (Optional)
body
object
The optional parameters provided to a cluster check operation. The detailed
keys and values are not checked at the moment.
The action_name in the request body has to be check.
A unique ID for tracking service request. The request ID associated
with the request by default appears in the service logs.
Location
header
string
For asynchronous object operations, the location header contains a
string that can be interpreted as a relative URI from where users can
track the progress of the action triggered.
POST
/v1/clusters/{cluster_id}/actions
Recover a Cluster to a Healthy Status
Recover the health status for all nodes in a cluster.
Request was accepted for processing, but the processing has not been
completed. A ‘location’ header is included in the response which contains
a link to check the progress of the request.
The <action_name> indicates the requested action while the <param>
keys provide the associated parameters to the action. Each individual
action has its own set of parameters.
params (Optional)
body
object
The optional parameters provided to a cluster recover operation. The
detailed keys and values are not checked at the moment.
The action_name in the body must be recover. The valid parameters
include:
operation: A string specifying the action to be performed for node
recovery.
check: A boolean specifying whether the engine should check the actual
statuses of cluster nodes before performing the recovery action. This
parameter is added since microversion 1.6 and it defaults to False.
check_capacity: A boolean specifying whether check the current number of
nodes and the desired_capacity field. Will delete nodes if the number of
nodes is larger than desired_capacity, otherwise, create nodes. This
parameter is added since microversion 1.7 and it defaults to False.
A unique ID for tracking service request. The request ID associated
with the request by default appears in the service logs.
Location
header
string
For asynchronous object operations, the location header contains a
string that can be interpreted as a relative URI from where users can
track the progress of the action triggered.
POST
/v1/clusters/{cluster_id}/ops
Perform an Operation on a Cluster
Perform an operation on the specified cluster. The specified operation and its
associated parameters must validate against the profile type of the cluster.
This API is only available since API microversion 1.4.
Request was accepted for processing, but the processing has not been
completed. A ‘location’ header is included in the response which contains
a link to check the progress of the request.
The <operation_name> specifies the operation to be performed, in which
the filters object contains a collection of filtering rules, and the
params object provide the parameters (if any) to the operation.
Each individual operation has its own set of parameters, as supported by
the profile type of the target cluster.
A unique ID for tracking service request. The request ID associated
with the request by default appears in the service logs.
Location
header
string
For asynchronous object operations, the location header contains a
string that can be interpreted as a relative URI from where users can
track the progress of the action triggered.
API microversion request. It takes the form of
OpenStack-API-Version:clustering1.0, where 1.0 is the requested
API version.
cluster_id
path
string
The name, UUID or short-UUID of a cluster object.
enabled (Optional)
query
string
Filters the response by a policy enabled status on the cluster.
sort (Optional)
query
string
Sorts the response by one or more attribute and optional sort direction
combinations. A valid direction is asc (ascending) or desc
(descending). Default direction is asc (ascending).
Specify the list as <key>[:<direction>].
For example, the following query parameters in the URI sort the resources
in the response by name in ascending order and then by status in
descending order:
A unique ID for tracking service request. The request ID associated
with the request by default appears in the service logs.
cluster_policies
body
array
A list of cluster_policy objects.
cluster_id
body
UUID
The UUID of the cluster object.
cluster_name
body
string
The name of a cluster object. The name must start with an ASCII letter
and can contain ASCII letters, digits, underscores, periods, and hyphens
and its length must be less than 255.
enabled
body
boolean
Whether the policy is enabled on the attached cluster.
id
body
UUID
The UUID of a cluster_policy object.
policy_id
body
UUID
The UUID of a policy object.
policy_name
body
string
The name of a policy object. The name must start with an ASCII letter
and can contain ASCII letters, digits, underscores, periods, and hyphens
and its length must be less than 255.
A unique ID for tracking service request. The request ID associated
with the request by default appears in the service logs.
cluster_policy
body
object
The structured description of a cluster_policy object.
cluster_id
body
UUID
The UUID of the cluster object.
cluster_name
body
string
The name of a cluster object. The name must start with an ASCII letter
and can contain ASCII letters, digits, underscores, periods, and hyphens
and its length must be less than 255.
enabled
body
boolean
Whether the policy is enabled on the attached cluster.
id
body
UUID
The UUID of a cluster_policy object.
policy_id
body
UUID
The UUID of a policy object.
policy_name
body
string
The name of a policy object. The name must start with an ASCII letter
and can contain ASCII letters, digits, underscores, periods, and hyphens
and its length must be less than 255.
API microversion request. It takes the form of
OpenStack-API-Version:clustering1.0, where 1.0 is the requested
API version.
limit (Optional)
query
integer
Requests a page size of resources. Returns a number of resources up to the
limit value. Use the limit parameter to make an initial limited request
and use the ID of the last-seen resource from the response as the marker
parameter value in a subsequent limited request.
marker (Optional)
query
UUID
The ID of the last-seen resource. Use the limit parameter to make an
initial limited request and use the ID of the last-seen resource from the
response as the marker parameter value in a subsequent limited request.
sort (Optional)
query
string
Sorts the response by one or more attribute and optional sort direction
combinations. A valid direction is asc (ascending) or desc
(descending). Default direction is asc (ascending).
Specify the list as <key>[:<direction>].
For example, the following query parameters in the URI sort the resources
in the response by name in ascending order and then by status in
descending order:
GET /v1/clusters?sort=name:asc,status:desc
global_project (Optional)
query
boolean
Indicates whether to include resources for all projects or resources for
the current project in the response.
If you are an administrative user and you set this value to true, the
call returns all resources from all projects. Default is false, which
returns only resources in the current project.
cluster_id (Optional)
query
string
The name, short-ID or UUID of the cluster object.
name (Optional)
query
string
Filters the response by the name property of the object.
status (Optional)
query
string
Filters the resource collection by the status property.
A unique ID for tracking service request. The request ID associated
with the request by default appears in the service logs.
nodes
body
array
A list of node objects.
cluster_id
body
UUID
The UUID of the cluster object.
created_at
body
string
The date and time when the object was created. The date and time stamp
format is ISO8601: CCYY-MM-DDThh:mm:ssZ. For example:
2016-01-18T00:00:00Z
data
body
object
A map containing key-value pairs associated with a node object.
domain
body
UUID
The ID of the domain a resource is created in.
id
body
UUID
A UUID string that uniquely identifies a node object.
index
body
integer
An integer that uniquely identifies a node within its owning cluster.
init_at
body
string
The date and time when the object was initialized. The date and
time stamp format is ISO8601: CCYY-MM-DDThh:mm:ssZ. For example:
2016-01-18T00:00:00Z
metadata
body
object
A collection of key-value pairs associated with an object.
name
body
string
The name of the object in question.
physical_id
body
UUID
The UUID of the physical resource represented by the node object.
profile_id
body
UUID
The UUID of the profile.
profile_name
body
string
The name of a profile object. The name must start with an ASCII letter
and can contain ASCII letters, digits, underscores, periods, and hyphens
and its length must be less than 255.
project
body
UUID
The ID of the project a resource is created in.
role
body
string
A string describing the role played by a node inside a cluster.
status
body
string
The string representation of the current status of the node object.
status_reason
body
string
The string representation of the reason why the object has transited to
its current status.
updated_at
body
string
The date and time when the object was last updated. The date and time
stamp format is ISO8601: CCYY-MM-DDThh:mm:ssZ. For example:
2016-01-18T00:00:00Z
Request was accepted for processing, but the processing has not been
completed. A ‘location’ header is included in the response which contains
a link to check the progress of the request.
API microversion request. It takes the form of
OpenStack-API-Version:clustering1.0, where 1.0 is the requested
API version.
node
body
object
A structured description of a node object.
role (Optional)
body
string
A string describing the new role played by a node inside a cluster.
profile_id
body
string
The name, short-ID, or UUID of a profile.
cluster_id (Optional)
body
string
The name, short-ID or UUID of the cluster object a node belongs to.
name
body
string
The name of a node object. The name must start with an ASCII letter
and can contain ASCII letters, digits, underscores, periods, and hyphens
and its length must be less than 255.
metadata (Optional)
body
object
A collection of key-value pairs associated with an object.
A unique ID for tracking service request. The request ID associated
with the request by default appears in the service logs.
Location
header
string
For asynchronous object operations, the location header contains a
string that can be interpreted as a relative URI from where users can
track the progress of the action triggered.
node
body
object
A structured description of a node object.
cluster_id
body
UUID
The UUID of the cluster object.
created_at
body
string
The date and time when the object was created. The date and time stamp
format is ISO8601: CCYY-MM-DDThh:mm:ssZ. For example:
2016-01-18T00:00:00Z
data
body
object
A map containing key-value pairs associated with a node object.
domain
body
UUID
The ID of the domain a resource is created in.
id
body
UUID
A UUID string that uniquely identifies a node object.
index
body
integer
An integer that uniquely identifies a node within its owning cluster.
init_at
body
string
The date and time when the object was initialized. The date and
time stamp format is ISO8601: CCYY-MM-DDThh:mm:ssZ. For example:
2016-01-18T00:00:00Z
metadata
body
object
A collection of key-value pairs associated with an object.
name
body
string
The name of the object in question.
physical_id
body
UUID
The UUID of the physical resource represented by the node object.
profile_id
body
UUID
The UUID of the profile.
profile_name
body
string
The name of a profile object. The name must start with an ASCII letter
and can contain ASCII letters, digits, underscores, periods, and hyphens
and its length must be less than 255.
project
body
UUID
The ID of the project a resource is created in.
role
body
string
A string describing the role played by a node inside a cluster.
status
body
string
The string representation of the current status of the node object.
status_reason
body
string
The string representation of the reason why the object has transited to
its current status.
updated_at
body
string
The date and time when the object was last updated. The date and time
stamp format is ISO8601: CCYY-MM-DDThh:mm:ssZ. For example:
2016-01-18T00:00:00Z
API microversion request. It takes the form of
OpenStack-API-Version:clustering1.0, where 1.0 is the requested
API version.
cluster (Optional)
body
UUID
The ID, short ID or name of a cluster which the adopted node is supposed
to join.
identity
body
string
The ID or name of the physical resource to be adopted.
metadata (Optional)
body
object
A collection of key-value pairs associated with an object.
name (Optional)
body
string
The name of a node object. If specified, the name must start with an ASCII
letter and can contain ASCII letters, digits, underscores, periods, and
hyphens and its length must be less than 255.
overrides (Optional)
body
object
If specified, provides a collection of key-value pairs that will override
the property name and values extracted from the spec extracted from the
existing physical node.
role (Optional)
body
string
A string describing the new role played by a node inside a cluster.
snapshot (Optional)
body
bool
A flat indicating whether a shapshot of the existing physical object should
be created before the object is adopted as a node.
A unique ID for tracking service request. The request ID associated
with the request by default appears in the service logs.
node
body
object
A structured description of a node object.
cluster_id
body
UUID
The UUID of the cluster object.
created_at
body
string
The date and time when the object was created. The date and time stamp
format is ISO8601: CCYY-MM-DDThh:mm:ssZ. For example:
2016-01-18T00:00:00Z
data
body
object
A map containing key-value pairs associated with a node object.
domain
body
UUID
The ID of the domain a resource is created in.
id
body
UUID
A UUID string that uniquely identifies a node object.
index
body
integer
An integer that uniquely identifies a node within its owning cluster.
init_at
body
string
The date and time when the object was initialized. The date and
time stamp format is ISO8601: CCYY-MM-DDThh:mm:ssZ. For example:
2016-01-18T00:00:00Z
metadata
body
object
A collection of key-value pairs associated with an object.
name
body
string
The name of the object in question.
physical_id
body
UUID
The UUID of the physical resource represented by the node object.
profile_id
body
UUID
The UUID of the profile.
profile_name
body
string
The name of a profile object. The name must start with an ASCII letter
and can contain ASCII letters, digits, underscores, periods, and hyphens
and its length must be less than 255.
project
body
UUID
The ID of the project a resource is created in.
role
body
string
A string describing the role played by a node inside a cluster.
status
body
string
The string representation of the current status of the node object.
status_reason
body
string
The string representation of the reason why the object has transited to
its current status.
updated_at
body
string
The date and time when the object was last updated. The date and time
stamp format is ISO8601: CCYY-MM-DDThh:mm:ssZ. For example:
2016-01-18T00:00:00Z
API microversion request. It takes the form of
OpenStack-API-Version:clustering1.0, where 1.0 is the requested
API version.
identity
body
string
The ID or name of the physical resource to be adopted.
overrides (Optional)
body
object
If specified, provides a collection of key-value pairs that will override
the property name and values extracted from the spec extracted from the
existing physical node.
snapshot (Optional)
body
bool
A flat indicating whether a shapshot of the existing physical object should
be created before the object is adopted as a node.
A unique ID for tracking service request. The request ID associated
with the request by default appears in the service logs.
node
body
object
A structured description of a node object.
cluster_id
body
UUID
The UUID of the cluster object.
created_at
body
string
The date and time when the object was created. The date and time stamp
format is ISO8601: CCYY-MM-DDThh:mm:ssZ. For example:
2016-01-18T00:00:00Z
data
body
object
A map containing key-value pairs associated with a node object.
domain
body
UUID
The ID of the domain a resource is created in.
id
body
UUID
A UUID string that uniquely identifies a node object.
index
body
integer
An integer that uniquely identifies a node within its owning cluster.
init_at
body
string
The date and time when the object was initialized. The date and
time stamp format is ISO8601: CCYY-MM-DDThh:mm:ssZ. For example:
2016-01-18T00:00:00Z
metadata
body
object
A collection of key-value pairs associated with an object.
name
body
string
The name of the object in question.
physical_id
body
UUID
The UUID of the physical resource represented by the node object.
profile_id
body
UUID
The UUID of the profile.
profile_name
body
string
The name of a profile object. The name must start with an ASCII letter
and can contain ASCII letters, digits, underscores, periods, and hyphens
and its length must be less than 255.
project
body
UUID
The ID of the project a resource is created in.
role
body
string
A string describing the role played by a node inside a cluster.
status
body
string
The string representation of the current status of the node object.
status_reason
body
string
The string representation of the reason why the object has transited to
its current status.
updated_at
body
string
The date and time when the object was last updated. The date and time
stamp format is ISO8601: CCYY-MM-DDThh:mm:ssZ. For example:
2016-01-18T00:00:00Z
Request was accepted for processing, but the processing has not been
completed. A ‘location’ header is included in the response which contains
a link to check the progress of the request.
A unique ID for tracking service request. The request ID associated
with the request by default appears in the service logs.
Location
header
string
For asynchronous object operations, the location header contains a
string that can be interpreted as a relative URI from where users can
track the progress of the action triggered.
node
body
object
A structured description of a node object.
cluster_id
body
UUID
The UUID of the cluster object.
created_at
body
string
The date and time when the object was created. The date and time stamp
format is ISO8601: CCYY-MM-DDThh:mm:ssZ. For example:
2016-01-18T00:00:00Z
data
body
object
A map containing key-value pairs associated with a node object.
domain
body
UUID
The ID of the domain a resource is created in.
id
body
UUID
A UUID string that uniquely identifies a node object.
index
body
integer
An integer that uniquely identifies a node within its owning cluster.
init_at
body
string
The date and time when the object was initialized. The date and
time stamp format is ISO8601: CCYY-MM-DDThh:mm:ssZ. For example:
2016-01-18T00:00:00Z
metadata
body
object
A collection of key-value pairs associated with an object.
name
body
string
The name of the object in question.
physical_id
body
UUID
The UUID of the physical resource represented by the node object.
profile_id
body
UUID
The UUID of the profile.
profile_name
body
string
The name of a profile object. The name must start with an ASCII letter
and can contain ASCII letters, digits, underscores, periods, and hyphens
and its length must be less than 255.
project
body
UUID
The ID of the project a resource is created in.
role
body
string
A string describing the role played by a node inside a cluster.
status
body
string
The string representation of the current status of the node object.
status_reason
body
string
The string representation of the reason why the object has transited to
its current status.
updated_at
body
string
The date and time when the object was last updated. The date and time
stamp format is ISO8601: CCYY-MM-DDThh:mm:ssZ. For example:
2016-01-18T00:00:00Z
Request was accepted for processing, but the processing has not been
completed. A ‘location’ header is included in the response which contains
a link to check the progress of the request.
A unique ID for tracking service request. The request ID associated
with the request by default appears in the service logs.
Location
header
string
For asynchronous object operations, the location header contains a
string that can be interpreted as a relative URI from where users can
track the progress of the action triggered.
Request was accepted for processing, but the processing has not been
completed. A ‘location’ header is included in the response which contains
a link to check the progress of the request.
The <action_name> indicates the requested action while the <param>
keys provide the associated parameters to the action. Each individual
action has its own set of parameters.
A unique ID for tracking service request. The request ID associated
with the request by default appears in the service logs.
Location
header
string
For asynchronous object operations, the location header contains a
string that can be interpreted as a relative URI from where users can
track the progress of the action triggered.
Request was accepted for processing, but the processing has not been
completed. A ‘location’ header is included in the response which contains
a link to check the progress of the request.
The <action_name> indicates the requested action while the <param>
keys provide the associated parameters to the action. Each individual
action has its own set of parameters.
The action_name in the body must be recover. The valid parameters
include:
operation: A string specifying the action to be performed for node
recovery.
check: A boolean specifying whether the engine should check the node’s
actual status before performing the recovery action. This parameter is added
since microversion 1.6.
A unique ID for tracking service request. The request ID associated
with the request by default appears in the service logs.
Location
header
string
For asynchronous object operations, the location header contains a
string that can be interpreted as a relative URI from where users can
track the progress of the action triggered.
POST
/v1/nodes/{node_id}/ops
Perform an Operation on a Node
Perform the specified operation on the specified node.
This API is only available since API microversion 1.4.
Request was accepted for processing, but the processing has not been
completed. A ‘location’ header is included in the response which contains
a link to check the progress of the request.
The <operation_name> specifies the operation to be performed while the
<param_n> keys provide the parameters (if any) to the operation. Each
individual operation has its own set of parameters, as supported by the
profile type of the target cluster or node.
A unique ID for tracking service request. The request ID associated
with the request by default appears in the service logs.
Location
header
string
For asynchronous object operations, the location header contains a
string that can be interpreted as a relative URI from where users can
track the progress of the action triggered.
API microversion request. It takes the form of
OpenStack-API-Version:clustering1.0, where 1.0 is the requested
API version.
limit (Optional)
query
integer
Requests a page size of resources. Returns a number of resources up to the
limit value. Use the limit parameter to make an initial limited request
and use the ID of the last-seen resource from the response as the marker
parameter value in a subsequent limited request.
marker (Optional)
query
UUID
The ID of the last-seen resource. Use the limit parameter to make an
initial limited request and use the ID of the last-seen resource from the
response as the marker parameter value in a subsequent limited request.
sort (Optional)
query
string
Sorts the response by one or more attribute and optional sort direction
combinations. A valid direction is asc (ascending) or desc
(descending). Default direction is asc (ascending).
Specify the list as <key>[:<direction>].
For example, the following query parameters in the URI sort the resources
in the response by name in ascending order and then by status in
descending order:
GET /v1/clusters?sort=name:asc,status:desc
global_project (Optional)
query
boolean
Indicates whether to include resources for all projects or resources for
the current project in the response.
If you are an administrative user and you set this value to true, the
call returns all resources from all projects. Default is false, which
returns only resources in the current project.
name (Optional)
query
string
Filters the response by the name property of the object.
type (Optional)
query
string
Filters the response by the type property of the receiver.
cluster_id (Optional)
query
string
The name, short-ID or UUID of the cluster object.
action (Optional)
query
string
Filters the response by the action targeted by the receiver.
user (Optional)
query
string
Filters the response by the user property of the receiver.
API microversion request. It takes the form of
OpenStack-API-Version:clustering1.0, where 1.0 is the requested
API version.
receiver
body
object
The structured definition of a receiver object.
name
body
string
The name of a receiver object. The name must start with an ASCII letter
and can contain ASCII letters, digits, underscores, periods, and hyphens
and its length must be less than 255.
cluster_id (Optional)
body
string
The name, short-ID or UUID of the cluster object a node belongs to.
type
body
string
The type of the receiver. The valid values include webhook and
message.
action (Optional)
body
string
The action to initiate when the receiver is triggered. A valid value
should be the name of an action that can be applied on a cluster.
actor (Optional)
body
object
A map of key and value pairs to use for authentication.
params (Optional)
body
object
A map of key and value pairs to use for action creation. Some actions
might require certain input parameters.
API microversion request. It takes the form of
OpenStack-API-Version:clustering1.0, where 1.0 is the requested
API version.
limit (Optional)
query
integer
Requests a page size of resources. Returns a number of resources up to the
limit value. Use the limit parameter to make an initial limited request
and use the ID of the last-seen resource from the response as the marker
parameter value in a subsequent limited request.
marker (Optional)
query
UUID
The ID of the last-seen resource. Use the limit parameter to make an
initial limited request and use the ID of the last-seen resource from the
response as the marker parameter value in a subsequent limited request.
sort (Optional)
query
string
Sorts the response by one or more attribute and optional sort direction
combinations. A valid direction is asc (ascending) or desc
(descending). Default direction is asc (ascending).
Specify the list as <key>[:<direction>].
For example, the following query parameters in the URI sort the resources
in the response by name in ascending order and then by status in
descending order:
GET /v1/clusters?sort=name:asc,status:desc
global_project (Optional)
query
boolean
Indicates whether to include resources for all projects or resources for
the current project in the response.
If you are an administrative user and you set this value to true, the
call returns all resources from all projects. Default is false, which
returns only resources in the current project.
oid (Optional)
query
string
Filters the response by the ID of object associated with an event.
Use this filter multiple times to filter by multiple objects.
otype (Optional)
query
string
Filters the response by the type of object associated with an event.
Use this filter multiple times to filter by multiple objects. A valid
value is CLUSTER or NODE.
oname (Optional)
query
string
Filters the response by the name of object associated with an event.
Use this filter multiple times to filter by multiple objects.
cluster_id (Optional)
query
string
The name, short-ID or UUID of the cluster object.
action (Optional)
query
string
Filters the response by the action name associated with an event.
Use this filter multiple times to filter by multiple actions.
Request was accepted for processing, but the processing has not been
completed. A ‘location’ header is included in the response which contains
a link to check the progress of the request.
A unique ID for tracking service request. The request ID associated
with the request by default appears in the service logs.
Location
header
string
For asynchronous object operations, the location header contains a
string that can be interpreted as a relative URI from where users can
track the progress of the action triggered.
API microversion request. It takes the form of
OpenStack-API-Version:clustering1.0, where 1.0 is the requested
API version.
limit (Optional)
query
integer
Requests a page size of resources. Returns a number of resources up to the
limit value. Use the limit parameter to make an initial limited request
and use the ID of the last-seen resource from the response as the marker
parameter value in a subsequent limited request.
marker (Optional)
query
UUID
The ID of the last-seen resource. Use the limit parameter to make an
initial limited request and use the ID of the last-seen resource from the
response as the marker parameter value in a subsequent limited request.
sort (Optional)
query
string
Sorts the response by one or more attribute and optional sort direction
combinations. A valid direction is asc (ascending) or desc
(descending). Default direction is asc (ascending).
Specify the list as <key>[:<direction>].
For example, the following query parameters in the URI sort the resources
in the response by name in ascending order and then by status in
descending order:
GET /v1/clusters?sort=name:asc,status:desc
global_project (Optional)
query
boolean
Indicates whether to include resources for all projects or resources for
the current project in the response.
If you are an administrative user and you set this value to true, the
call returns all resources from all projects. Default is false, which
returns only resources in the current project.
name (Optional)
query
string
Filters the response by the name property of the object.
target (Optional)
query
string
Filters the results by the UUID of the targeted object which is usually
a cluster.
action (Optional)
query
string
Filters the resulted list using the action field of the object.
status (Optional)
query
string
Filters the results by the status property of an action object.
