Skip to content

oom_report_rule

Manage VPS OOM report rules

Create

Path
POST /v7.0/oom_report_rules
Description
Create a new OOM report rule
Authentication required
yes
Scope
oom_report_rule#create
Aliases
new
Blocking
no

Input parameters

Layout
object
Namespace
oom_report_rule
ParameterTypeRequiredDetails
vps
VPS
 Resource yes
action
Action
 String yes

Default: null

Validation rules
RuleDetails
Include

Allowed values:

  • notify
  • ignore

Validation error message: %{value} cannot be used

Present

Must be supplied and cannot be null. Must not be empty; strings must contain a non-whitespace character.

Validation error message: must be present and non-empty
cgroup_pattern
Cgroup path pattern
 String yes

Default: null

Validation rules
RuleDetails
Present

Must be supplied and cannot be null. Must not be empty; strings must contain a non-whitespace character.

Validation error message: must be present and non-empty

Length
  • Maximum length: 255 characters (inclusive).

Validation error message: length must be at most 255
hit_count
Hit count
 Integer no

Default: null

Output parameters

Layout
object
Namespace
oom_report_rule
ParameterTypeDescription
id
Id
 Integer
vps
VPS
 Resource
action
Action
 String
cgroup_pattern
Cgroup path pattern
 String
hit_count
Hit count
 Integer
label
Label
 String
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime

Delete

Path
DELETE /v7.0/oom_report_rules/{oom_report_rule_id}
Description
Delete OOM report rule
Authentication required
yes
Scope
oom_report_rule#delete
Aliases
destroy
Blocking
no

Input parameters

No parameters.

Output parameters

No parameters.

Index

Path
GET /v7.0/oom_report_rules
Description
Authentication required
yes
Scope
oom_report_rule#index
Aliases
list
Blocking
no

Input parameters

Layout
object
Namespace
oom_report_rule
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
vps
VPS
 Resource no

Output parameters

Layout
object_list
Namespace
oom_report_rules
ParameterTypeDescription
id
Id
 Integer
vps
VPS
 Resource
action
Action
 String
cgroup_pattern
Cgroup path pattern
 String
hit_count
Hit count
 Integer
label
Label
 String
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime

Show

Path
GET /v7.0/oom_report_rules/{oom_report_rule_id}
Description
Show OOM report rule
Authentication required
yes
Scope
oom_report_rule#show
Aliases
find
Blocking
no

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
oom_report_rule
ParameterTypeDescription
id
Id
 Integer
vps
VPS
 Resource
action
Action
 String
cgroup_pattern
Cgroup path pattern
 String
hit_count
Hit count
 Integer
label
Label
 String
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime

Update

Path
PUT /v7.0/oom_report_rules/{oom_report_rule_id}
Description
Update OOM report rule
Authentication required
yes
Scope
oom_report_rule#update
Aliases
Blocking
no

Input parameters

Layout
object
Namespace
oom_report_rule
ParameterTypeRequiredDetails
action
Action
 String no

Default: null

Validation rules
RuleDetails
Include

Allowed values:

  • notify
  • ignore

Validation error message: %{value} cannot be used
cgroup_pattern
Cgroup path pattern
 String no

Default: null

Validation rules
RuleDetails
Length
  • Maximum length: 255 characters (inclusive).

Validation error message: length must be at most 255

Output parameters

Layout
object
Namespace
oom_report_rule
ParameterTypeDescription
id
Id
 Integer
vps
VPS
 Resource
action
Action
 String
cgroup_pattern
Cgroup path pattern
 String
hit_count
Hit count
 Integer
label
Label
 String
created_at
Created_at
 Datetime
updated_at
Updated_at
 Datetime