Skip to content

user.cluster_resource

Manage user's cluster resources

Create

Path
POST /v7.0/users/{user_id}/cluster_resources
Description
Create a cluster resource for user
Authentication required
yes
Scope
user.cluster_resource#create
Aliases
new
Blocking
no

Input parameters

Layout
object
Namespace
cluster_resource
ParameterTypeRequiredDetails
environment
Environment
 Resource yes
cluster_resource
ClusterResource
 Resource yes
value
Value
 Integer no

Default: null

Output parameters

Layout
object
Namespace
cluster_resource
ParameterTypeDescription
id
Id
 Integer
environment
Environment
 Resource
cluster_resource
ClusterResource
 Resource
value
Value
 Integer
used
Used
 Integer Number of used resource units
free
Free
 Integer Number of free resource units

Index

Path
GET /v7.0/users/{user_id}/cluster_resources
Description
List user cluster resources
Authentication required
yes
Scope
user.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
environment
Environment
 Resource no

Output parameters

Layout
object_list
Namespace
cluster_resources
ParameterTypeDescription
id
Id
 Integer
environment
Environment
 Resource
cluster_resource
ClusterResource
 Resource
value
Value
 Integer
used
Used
 Integer Number of used resource units
free
Free
 Integer Number of free resource units

Show

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

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
cluster_resource
ParameterTypeDescription
id
Id
 Integer
environment
Environment
 Resource
cluster_resource
ClusterResource
 Resource
value
Value
 Integer
used
Used
 Integer Number of used resource units
free
Free
 Integer Number of free resource units