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","required":false,"type":"Map","updatable":false},"disable_rollback":{"default":true,"description":"A boolean specifying whether a stack operation can be rolled back.","required":false,"type":"Boolean","updatable":true},"environment":{"default":{},"description":"A map that specifies the environment used for stack operations.","required":false,"type":"Map","updatable":true},"files":{"default":{},"description":"Contents of files referenced by the template, if any.","required":false,"type":"Map","updatable":true},"parameters":{"default":{},"description":"Parameters to be passed to Heat for stack operations.","required":false,"type":"Map","updatable":true},"template":{"default":{},"description":"Heat stack template.","required":false,"type":"Map","updatable":true},"template_url":{"default":"","description":"Heat stack template url.","required":false,"type":"String","updatable":true},"timeout":{"description":"A integer that specifies the number of minutes that a stack operation times out.","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","required":false,"type":"Map","updatable":false},"disable_rollback":{"default":true,"description":"A boolean specifying whether a stack operation can be rolled back.","required":false,"type":"Boolean","updatable":true},"environment":{"default":{},"description":"A map that specifies the environment used for stack operations.","required":false,"type":"Map","updatable":true},"files":{"default":{},"description":"Contents of files referenced by the template, if any.","required":false,"type":"Map","updatable":true},"parameters":{"default":{},"description":"Parameters to be passed to Heat for stack operations.","required":false,"type":"Map","updatable":true},"template":{"default":{},"description":"Heat stack template.","required":false,"type":"Map","updatable":true},"template_url":{"default":"","description":"Heat stack template url.","required":false,"type":"String","updatable":true},"timeout":{"description":"A integer that specifies the number of minutes that a stack operation times out.","required":false,"type":"Integer","updatable":true}},"support_status":{"1.0":[{"status":"SUPPORTED","since":"2016.04"}]}}}

{"operations":{"reboot":{"description":"Reboot the nova server.","parameters":{"type":{"constraints":[{"constraint":["SOFT","HARD"],"type":"AllowedValues"}],"default":"SOFT","description":"Type of reboot which can be 'SOFT' or 'HARD'.","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.

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.

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.

name (Optional)

query

string

Filters the response by the specified name property of the object,
such as policy_name or name property of 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:

GET /v1/clusters?sort=name:asc,status:desc

type (Optional)

query

string

Filters the response by the specified type property of the object,
such as policy_type property of cluster-policy binding object or
type property of policy object.

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.","required":false,"type":"String","updatable":false},"enable_drs_extension":{"default":false,"description":"Enable vSphere DRS extension.","required":false,"type":"Boolean","updatable":false},"servergroup":{"description":"Properties of the VM server group","required":false,"schema":{"name":{"description":"The name of the server group","required":false,"type":"String","updatable":false},"policies":{"constraints":[{"constraint":["affinity","anti-affinity"],"type":"AllowedValues"}],"default":"anti-affinity","description":"The server group policies.","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.","required":false,"type":"String","updatable":false},"enable_drs_extension":{"default":false,"description":"Enable vSphere DRS extension.","required":false,"type":"Boolean","updatable":false},"servergroup":{"description":"Properties of the VM server group","required":false,"schema":{"name":{"description":"The name of the server group","required":false,"type":"String","updatable":false},"policies":{"constraints":[{"constraint":["affinity","anti-affinity"],"type":"AllowedValues"}],"default":"anti-affinity","description":"The server group policies.","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 specified name property of the object,
such as policy_name or name property of cluster.

type (Optional)

query

string

Filters the response by the specified type property of the object,
such as policy_type property of cluster-policy binding object or
type property of policy object.

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 specified name property of the object,
such as policy_name or name property of cluster.

status (Optional)

query

string

Filters the resource collection by the status property.

The sorting keys include name, status, init_at, created_at
and updated_at.

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.

config (Optional)

body

object

The structured config associated with the cluster.

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.

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

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

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_id

path

string

The name, UUID or short-UUID of a cluster object.

action

body

object

A structured definition of an action to be executed. The object is
usually expressed as:

<action_name>:{<param_1>:<value_1><param_2>:<value_2>...}

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.

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.

action

body

object

A structured definition of an action to be executed. The object is
usually expressed as:

<action_name>:{<param_1>:<value_1><param_2>:<value_2>...}

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.

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.

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 specified name property of the object,
such as policy_name or name property of cluster.

A structured definition of an operation to be performed. The object is
usually expressed as:

<operation_name>:{<param_1>:<value_1><param_2>:<value_2>...}

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.

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 specified name property of the object,
such as policy_name or name property of cluster.

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.

level (Optional)

body

string

The level of an event object.

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.

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 specified name property of the object,
such as policy_name or name property of cluster.

target (Optional)

query

string

Filters the results by the UUID of the targeted object which is usually
a cluster.