Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Profiles can be manages using REST API

Profile creation

A new profile can be created with REST API query /api/profile/create

https://hostname:8090/api/profile/create
{
  "name": "profile1",
  "rate": "1",
  "metrics": ["4", "11"],
  "rules": ["13"]
}

Where:

  • name – profile name
  • rate – metric aquisition rate
  • metrics – metric identifiers list
  • rules – rule identifiers list

Profile changing

The profile can be changed with REST API query /api/profile/update

https://hostname:8090/api/profile/update
{
  "id": "18",
  "name": "profile1",
  "rate": "1",
  "metrics": ["4", "11"],
  "rules": ["13"]
}

Where:

  • id – profile identifier
  • name – profile name
  • rate – metric aquisition rate
  • metrics – metric identifiers list
  • rules – rule identifiers list

Profile deletion

The profile can be deleted with REST API query /api/profile/delete

https://hostname:8090/api/profile/delete
{
  "id": "18"
}

Where:

  • id – profile identifier

When profile is deleted, its metrics aquisition will be stopped on all nodes for which the profile was set.

Obtaining profile information

The profile information can be obtained with REST API query /api/profile/list

https://hostname:8090/api/profile/list
{
  "id": "18"
}

Where:

  • id – profile identifier

If profile Id is set, the response will contain this profile information only. If profile Id is not set, the response will contain information about all the profiles on backend server.

The response contains the same fields for every profile as /api/profile/update response.

  • No labels