Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Replace 'key' parameters by 'id'

...

Use CaseExample Request

Create a manual metric:

  • Key: foo
  • Name: bar
  • Value type: INT
  • Description: blabla
  • Domain: Size

curl -X POST -v -u admin:admin 'http://localhost:9000/api/metrics/?id=foo?&name=bar&val_type=INT&description=blabla&domain=Size'

...

Parameter

Description

Required

Default Value

Example Value

keyid

Key of the manual metric.

Yes

None

foo

nameName of the manual metric.YesNonebar
val_type

Type of the manual metric.

Possible valules: INT | BOOL | FLOAT | PERCENT | STRING | LEVEL

YesNoneINT
descriptionDescription of the manual metric.NoNoneblabla
domainDomain of the manual metric.NoNoneSize

...

Use CaseExample Request

Update the manual metric whose key is 'foo':

  • New name: bar
  • New value type: INT
  • New description: blabla
  • New domain: Size

curl -X PUT -v -u admin:admin 'http://localhost:9000/api/metrics/?id=foo?&name=bar&val_type=INT&description=blabla&domain=Size'

...

Parameter

Description

Required

Default Value

Example Value

keyid

Key of the manual metric.

Yes

None

foo

nameName of the manual metric.YesNonebar
val_type

Type of the manual metric.

Possible valules: INT | BOOL | FLOAT | PERCENT | STRING | LEVEL

YesNoneINT
descriptionDescription of the manual metric.NoNoneblabla
domainDomain of the manual metric.NoNoneSize

...

Use CaseExample Request

Delete the manual metric whose key is 'foo'.

curl -X DELETE -v -u admin:admin 'http://localhost:9000/api/metrics/?id=foo'

Parameters

Parameter

Description

Required

Default Value

Example Value

keyid

Key of the manual metric.

Yes

None

foo