Skip to content

cluster_resource

Manage environment resources

Create

Path
POST /v7.0/cluster_resources
Description
Create an environment resource
Authentication required
yes
Scope
cluster_resource#create
Aliases
new
Blocking
no

Input parameters

Layout
object
Namespace
cluster_resource
ParameterTypeRequiredDetails
name
Resource name for internal purposes
 String no

Default: null
label
Label
 String no

Default: null
min
Minimum value
 Integer no

When an object is allocating a resource, it must use more than minimum

Default: null
max
Maximum value
 Integer no

When an object is allocating a resource, it must not use more than maximum

Default: null
stepsize
Step size
 Integer no

Steps in which the objects allocated resource value may be iterated

Default: null
resource_type
Resource_type
 String no

Default: numeric

Validation rules
RuleDetails
Include

Allowed values:

  • numeric
  • object

Validation error message: %{value} cannot be used
allocate_chain
Allocation chain
 String no

Default: null
free_chain
Free chain
 String no

Default: null

Output parameters

Layout
object
Namespace
cluster_resource
ParameterTypeDescription
id
Id
 Integer
name
Resource name for internal purposes
 String
label
Label
 String
min
Minimum value
 Integer When an object is allocating a resource, it must use more than minimum
max
Maximum value
 Integer When an object is allocating a resource, it must not use more than maximum
stepsize
Step size
 Integer Steps in which the objects allocated resource value may be iterated
resource_type
Resource_type
 String
allocate_chain
Allocation chain
 String
free_chain
Free chain
 String

Index

Path
GET /v7.0/cluster_resources
Description
List environment resources
Authentication required
yes
Scope
cluster_resource#index
Aliases
list
Blocking
no

Input parameters

Layout
object
Namespace
cluster_resource
ParameterTypeRequiredDetails
from_id
From ID
 Integer no

List objects with IDs greater or lower than this value

Default: null

Validation rules
RuleDetails
Number
  • Must be a number after parameter type conversion.
  • Minimum: 0 (inclusive).

Validation error message: must be at least 0
limit
Limit
 Integer no

Number of objects to retrieve

Default: null

Validation rules
RuleDetails
Number
  • Must be a number after parameter type conversion.
  • Minimum: 0 (inclusive).
  • Maximum: 1000 (inclusive).

Validation error message: must be between 0 and 1000

Output parameters

Layout
object_list
Namespace
cluster_resources
ParameterTypeDescription
id
Id
 Integer
name
Resource name for internal purposes
 String
label
Label
 String
min
Minimum value
 Integer When an object is allocating a resource, it must use more than minimum
max
Maximum value
 Integer When an object is allocating a resource, it must not use more than maximum
stepsize
Step size
 Integer Steps in which the objects allocated resource value may be iterated
resource_type
Resource_type
 String
allocate_chain
Allocation chain
 String
free_chain
Free chain
 String

Show

Path
GET /v7.0/cluster_resources/{cluster_resource_id}
Description
Show environment resource
Authentication required
yes
Scope
cluster_resource#show
Aliases
find
Blocking
no

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
cluster_resource
ParameterTypeDescription
id
Id
 Integer
name
Resource name for internal purposes
 String
label
Label
 String
min
Minimum value
 Integer When an object is allocating a resource, it must use more than minimum
max
Maximum value
 Integer When an object is allocating a resource, it must not use more than maximum
stepsize
Step size
 Integer Steps in which the objects allocated resource value may be iterated
resource_type
Resource_type
 String
allocate_chain
Allocation chain
 String
free_chain
Free chain
 String

Update

Path
PUT /v7.0/cluster_resources/{cluster_resource_id}
Description
Update an environment resource
Authentication required
yes
Scope
cluster_resource#update
Aliases
Blocking
no

Input parameters

Layout
object
Namespace
cluster_resource
ParameterTypeRequiredDetails
name
Resource name for internal purposes
 String no

Default: null
label
Label
 String no

Default: null
min
Minimum value
 Integer no

When an object is allocating a resource, it must use more than minimum

Default: null
max
Maximum value
 Integer no

When an object is allocating a resource, it must not use more than maximum

Default: null
stepsize
Step size
 Integer no

Steps in which the objects allocated resource value may be iterated

Default: null
resource_type
Resource_type
 String no

Default: numeric

Validation rules
RuleDetails
Include

Allowed values:

  • numeric
  • object

Validation error message: %{value} cannot be used
allocate_chain
Allocation chain
 String no

Default: null
free_chain
Free chain
 String no

Default: null

Output parameters

Layout
object
Namespace
cluster_resource
ParameterTypeDescription
id
Id
 Integer
name
Resource name for internal purposes
 String
label
Label
 String
min
Minimum value
 Integer When an object is allocating a resource, it must use more than minimum
max
Maximum value
 Integer When an object is allocating a resource, it must not use more than maximum
stepsize
Step size
 Integer Steps in which the objects allocated resource value may be iterated
resource_type
Resource_type
 String
allocate_chain
Allocation chain
 String
free_chain
Free chain
 String