POST - /kubernetes/item/hpa

Owned by antoine hage
Last updated: Aug 21, 2020
1 min read

This API creates an HPA.

Description

This API creates an HPA.

Input

Type: application/json

Param

Source

Type

Required

Description

Param

Source

Type

Required

Description

 configuration

body

object

 yes

 

 item

body

object

yes

 

env

body.item

string

yes

 

name

body.item

string

yes

 

version

body.item

string

yes

 

replica

body

object

yes

 

min

body.replica

integer

yes

"minimum": 1

max

body.replica

integer

yes

"minimum": 1

metrics

body

array of objects

yes

conditional

  body.metrics

Conditional anyOf the following objects:

  • ["type", "name", "target", "percentage"]

  • ["type", "name", "target", "value"]

  • ["type", "name", "target", "value"]

Param

Source

Type

Required

Description

Param

Source

Type

Required

Description

type

body.metrics

enum

Yes

 ["Resource"]

name

body.metrics

enum

Yes

 ["cpu", "memory"]

taget

body.metrics

enum

Yes

["AverageValue", "Utilization"]

percentage

body.metrics

integer

Yes

"minimum": 1, "maximum": 100

Param

Source

Type

Required

Description

Param

Source

Type

Required

Description

type

body.metrics

enum

Yes

  ["Pods"]

name

body.metrics

enum

Yes

 ["packets-per-second"]

taget

body.metrics

enum

Yes

 ["AverageValue"]

value

body.metrics

string

Yes

 

Param

Source

Type

Required

Description

Param

Source

Type

Required

Description

type

body.metrics

enum

Yes

  ["Object"]

name

body.metrics

enum

Yes

 ["requests-per-second"]

taget

body.metrics

enum

Yes

 ["AverageValue", "Value"]

value

body.metrics

string

Yes

Â