Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Profiles can be managed using REST API.

Profile creation

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

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

Where:

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

Profile changing

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

Code Block
languagejs
themeRDark
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 acquisition rate
  • metrics – metric identifiers list
  • rules – rule identifiers list

Profile deletion

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

Code Block
languagejs
themeRDark
https://hostname:8090/api/profile/delete
{
  "id": "18"
}

Where:

  • id – profile identifier

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

...

Code Block
languagejs
themeRDark
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 For each profile, the response contains the same fields for every profile as /api/profile/update query.