Health Service
{ urn:com.soa.admin.health.jaxrs } JAXRSHealthService
The Health Service provides an API to manage and query any health-related measurable attributes in the system.
GETgetMetadata
Reponse
Produces application/jsonapplication/xml
Status Code
Reason
Model
200
Success
healthMeasurableSet
healthMeasurableSet {
healthMeasurableMetadata {
options {
atomLink {
monitoredAttribute {
threshold {
measurables( Collection of healthMeasurableMetadata )
links( Collection of atomLink )
}
healthMeasurableMetadata {
path( string )
children( Collection of healthMeasurableMetadata )
editable( boolean )
name( string )
options( options )
childCount( int )
attributes( Collection of monitoredAttribute )
links( Collection of atomLink )
id( string )
state( string )
}
options {
enableAuth( boolean )
links( Collection of atomLink )
}
atomLink {
hreflang( string )
length( string )
rel( string )
href( anyURI )
title( string )
type( string )
}
monitoredAttribute {
path( string )
name( string )
description( string )
threshold( threshold )
links( Collection of atomLink )
units( string )
state( string )
type( string )
value( anyType )
}
threshold {
normal( string )
failure( string )
warning( string )
links( Collection of atomLink )
}
GET/measurablesgetMeasurables
Reponse
Produces application/json
Status Code
Reason
Model
200
Success
healthMeasurableMetadata
healthMeasurableMetadata {
options {
atomLink {
monitoredAttribute {
threshold {
path( string )
children( Collection of healthMeasurableMetadata )
editable( boolean )
name( string )
options( options )
childCount( int )
attributes( Collection of monitoredAttribute )
links( Collection of atomLink )
id( string )
state( string )
}
options {
enableAuth( boolean )
links( Collection of atomLink )
}
atomLink {
hreflang( string )
length( string )
rel( string )
href( anyURI )
title( string )
type( string )
}
monitoredAttribute {
path( string )
name( string )
description( string )
threshold( threshold )
links( Collection of atomLink )
units( string )
state( string )
type( string )
value( anyType )
}
threshold {
normal( string )
failure( string )
warning( string )
links( Collection of atomLink )
}
POST/measurablescreateConfiguration
Adds a health configuration. A health configuration is comprised of a set of standard Monitorable attributes defined using the OSGi MonitorAdmin service interfaces. A health configuration allows attributes from different Monitorable instances to be combined into a hierarchy, and thresholds may then be placed on those attributes. The state of the hierarchy will then reflect the combined state of all the component attributes with respect to their configured thresholds.
Request:
POST /admin/health HTTP/1.1
Content-Type: application/json
{"name":"My Health Variables"}
Responses:
- HTTP/1.1 201 Created
- HTTP/1.1 300 Bad Request if a name or ID is not provided by the client
Sample Response:
201 Created
Content-Type: application/json
Location: http://localhost:9905/admin/health/measurables/my.health.variables
{
"id" : "my.health.variables",
"name" : "My Health Variables",
"state" : "NORMAL",
"attributes" : [ ],
"children" : [ ],
"editable" : true,
"links" : [ {
"rel" : "self",
"href" : "http://localhost:9905/admin/health/measurables/my.health.variables"
}, {
"rel" : "brief",
"href" : "http://localhost:9905/admin/health/measurables/my.health.variables?brief=true"
}, {
"rel" : "children",
"href" : "http://localhost:9905/admin/health/measurables/my.health.variables/children"
}, {
"rel" : "values",
"href" : "http://localhost:9905/admin/health/measurables/my.health.variables/values"
} ]
}
Parameters
Accepts application/json
Name
Type
Description
Model
body
entity
healthMeasurableMetadata
healthMeasurableMetadata {
options {
atomLink {
monitoredAttribute {
threshold {
path( string )
children( Collection of healthMeasurableMetadata )
editable( boolean )
name( string )
options( options )
childCount( int )
attributes( Collection of monitoredAttribute )
links( Collection of atomLink )
id( string )
state( string )
}
options {
enableAuth( boolean, required )
links( Collection of atomLink )
}
atomLink {
hreflang( string )
length( string )
rel( string )
href( anyURI, required )
title( string )
type( string )
}
monitoredAttribute {
path( string )
name( string )
description( string )
threshold( threshold )
links( Collection of atomLink )
units( string )
state( string )
type( string )
value( anyType )
}
threshold {
normal( string )
failure( string )
warning( string )
links( Collection of atomLink )
}
Reponse
Produces application/json
Status Code
Reason
Model
200
Success
healthMeasurableMetadata
healthMeasurableMetadata {
options {
atomLink {
monitoredAttribute {
threshold {
path( string )
children( Collection of healthMeasurableMetadata )
editable( boolean )
name( string )
options( options )
childCount( int )
attributes( Collection of monitoredAttribute )
links( Collection of atomLink )
id( string )
state( string )
}
options {
enableAuth( boolean )
links( Collection of atomLink )
}
atomLink {
hreflang( string )
length( string )
rel( string )
href( anyURI )
title( string )
type( string )
}
monitoredAttribute {
path( string )
name( string )
description( string )
threshold( threshold )
links( Collection of atomLink )
units( string )
state( string )
type( string )
value( anyType )
}
threshold {
normal( string )
failure( string )
warning( string )
links( Collection of atomLink )
}
GET/availablegetAvailable
Reponse
Produces application/json
Status Code
Reason
Model
200
Success
healthMeasurableMetadata
healthMeasurableMetadata {
options {
atomLink {
monitoredAttribute {
threshold {
path( string )
children( Collection of healthMeasurableMetadata )
editable( boolean )
name( string )
options( options )
childCount( int )
attributes( Collection of monitoredAttribute )
links( Collection of atomLink )
id( string )
state( string )
}
options {
enableAuth( boolean )
links( Collection of atomLink )
}
atomLink {
hreflang( string )
length( string )
rel( string )
href( anyURI )
title( string )
type( string )
}
monitoredAttribute {
path( string )
name( string )
description( string )
threshold( threshold )
links( Collection of atomLink )
units( string )
state( string )
type( string )
value( anyType )
}
threshold {
normal( string )
failure( string )
warning( string )
links( Collection of atomLink )
}
GET/measurables/{id}getMetadataDetail
Parameters
Name
Type
Description
Model
id
path
string
normal-status
query
string
warning-status
query
string
failure-status
query
string
children
query
boolean
brief
query
boolean
Reponse
Produces application/json
Status Code
Reason
Model
200
Success
healthMeasurableMetadata
healthMeasurableMetadata {
options {
atomLink {
monitoredAttribute {
threshold {
path( string )
children( Collection of healthMeasurableMetadata )
editable( boolean )
name( string )
options( options )
childCount( int )
attributes( Collection of monitoredAttribute )
links( Collection of atomLink )
id( string )
state( string )
}
options {
enableAuth( boolean )
links( Collection of atomLink )
}
atomLink {
hreflang( string )
length( string )
rel( string )
href( anyURI )
title( string )
type( string )
}
monitoredAttribute {
path( string )
name( string )
description( string )
threshold( threshold )
links( Collection of atomLink )
units( string )
state( string )
type( string )
value( anyType )
}
threshold {
normal( string )
failure( string )
warning( string )
links( Collection of atomLink )
}
DELETE/measurables/{id}deleteMetadata
Parameters
Name
Type
Description
Model
id
path
string
Reponse
Status Code
Reason
Model
200
Success
any
PUT/measurables/{id}/configurationupdateOptions
Parameters
Accepts application/json
Name
Type
Description
Model
id
path
string
body
entity
options
options {
atomLink {
enableAuth( boolean, required )
links( Collection of atomLink )
}
atomLink {
hreflang( string )
length( string )
rel( string )
href( anyURI, required )
title( string )
type( string )
}
Reponse
Produces application/json
Status Code
Reason
Model
200
Success
options
options {
atomLink {
enableAuth( boolean )
links( Collection of atomLink )
}
atomLink {
hreflang( string )
length( string )
rel( string )
href( anyURI )
title( string )
type( string )
}
GET/measurables/{id}/childrengetMetadataChildren
Parameters
Name
Type
Description
Model
id
path
string
Reponse
Produces application/json
Status Code
Reason
Model
200
Success
healthMeasurableSet
healthMeasurableSet {
healthMeasurableMetadata {
options {
atomLink {
monitoredAttribute {
threshold {
measurables( Collection of healthMeasurableMetadata )
links( Collection of atomLink )
}
healthMeasurableMetadata {
path( string )
children( Collection of healthMeasurableMetadata )
editable( boolean )
name( string )
options( options )
childCount( int )
attributes( Collection of monitoredAttribute )
links( Collection of atomLink )
id( string )
state( string )
}
options {
enableAuth( boolean )
links( Collection of atomLink )
}
atomLink {
hreflang( string )
length( string )
rel( string )
href( anyURI )
title( string )
type( string )
}
monitoredAttribute {
path( string )
name( string )
description( string )
threshold( threshold )
links( Collection of atomLink )
units( string )
state( string )
type( string )
value( anyType )
}
threshold {
normal( string )
failure( string )
warning( string )
links( Collection of atomLink )
}
GET/measurables/{id}/valuesgetMeasurableValues
Parameters
Name
Type
Description
Model
id
path
string
format
query
string
path
query
boolean
Reponse
Produces application/json
Status Code
Reason
Model
200
Success
nameValue
nameValue {
name( string )
state( string )
value( anyType )
timestamp( long )
}
PUT/measurables/{id}/childrensetMetadataChildren
Parameters
Accepts application/json
Name
Type
Description
Model
id
path
string
body
entity
healthMeasurableMetadata
healthMeasurableMetadata {
options {
atomLink {
monitoredAttribute {
threshold {
path( string )
children( Collection of healthMeasurableMetadata )
editable( boolean )
name( string )
options( options )
childCount( int )
attributes( Collection of monitoredAttribute )
links( Collection of atomLink )
id( string )
state( string )
}
options {
enableAuth( boolean, required )
links( Collection of atomLink )
}
atomLink {
hreflang( string )
length( string )
rel( string )
href( anyURI, required )
title( string )
type( string )
}
monitoredAttribute {
path( string )
name( string )
description( string )
threshold( threshold )
links( Collection of atomLink )
units( string )
state( string )
type( string )
value( anyType )
}
threshold {
normal( string )
failure( string )
warning( string )
links( Collection of atomLink )
}
Reponse
Produces application/json
Status Code
Reason
Model
200
Success
healthMeasurableSet
healthMeasurableSet {
healthMeasurableMetadata {
options {
atomLink {
monitoredAttribute {
threshold {
measurables( Collection of healthMeasurableMetadata )
links( Collection of atomLink )
}
healthMeasurableMetadata {
path( string )
children( Collection of healthMeasurableMetadata )
editable( boolean )
name( string )
options( options )
childCount( int )
attributes( Collection of monitoredAttribute )
links( Collection of atomLink )
id( string )
state( string )
}
options {
enableAuth( boolean )
links( Collection of atomLink )
}
atomLink {
hreflang( string )
length( string )
rel( string )
href( anyURI )
title( string )
type( string )
}
monitoredAttribute {
path( string )
name( string )
description( string )
threshold( threshold )
links( Collection of atomLink )
units( string )
state( string )
type( string )
value( anyType )
}
threshold {
normal( string )
failure( string )
warning( string )
links( Collection of atomLink )
}
GET/measurables/{id}/configurationgetOptions
Parameters
Name
Type
Description
Model
id
path
string
Reponse
Produces application/json
Status Code
Reason
Model
200
Success
options
options {
atomLink {
enableAuth( boolean )
links( Collection of atomLink )
}
atomLink {
hreflang( string )
length( string )
rel( string )
href( anyURI )
title( string )
type( string )
}
GET/measurables/{parent}/children/{child}getMetadataChild
Parameters
Name
Type
Description
Model
parent
path
string
child
path
string
Reponse
Produces application/json
Status Code
Reason
Model
200
Success
healthMeasurableMetadata
healthMeasurableMetadata {
options {
atomLink {
monitoredAttribute {
threshold {
path( string )
children( Collection of healthMeasurableMetadata )
editable( boolean )
name( string )
options( options )
childCount( int )
attributes( Collection of monitoredAttribute )
links( Collection of atomLink )
id( string )
state( string )
}
options {
enableAuth( boolean )
links( Collection of atomLink )
}
atomLink {
hreflang( string )
length( string )
rel( string )
href( anyURI )
title( string )
type( string )
}
monitoredAttribute {
path( string )
name( string )
description( string )
threshold( threshold )
links( Collection of atomLink )
units( string )
state( string )
type( string )
value( anyType )
}
threshold {
normal( string )
failure( string )
warning( string )
links( Collection of atomLink )
}
PUT/measurables/{parent}/children/{child}updateMetadataChild
Parameters
Name
Type
Description
Model
parent
path
string
child
path
string
body
entity
healthMeasurableMetadata
healthMeasurableMetadata {
options {
atomLink {
monitoredAttribute {
threshold {
path( string )
children( Collection of healthMeasurableMetadata )
editable( boolean )
name( string )
options( options )
childCount( int )
attributes( Collection of monitoredAttribute )
links( Collection of atomLink )
id( string )
state( string )
}
options {
enableAuth( boolean, required )
links( Collection of atomLink )
}
atomLink {
hreflang( string )
length( string )
rel( string )
href( anyURI, required )
title( string )
type( string )
}
monitoredAttribute {
path( string )
name( string )
description( string )
threshold( threshold )
links( Collection of atomLink )
units( string )
state( string )
type( string )
value( anyType )
}
threshold {
normal( string )
failure( string )
warning( string )
links( Collection of atomLink )
}
Reponse
Produces application/json
Status Code
Reason
Model
200
Success
healthMeasurableMetadata
healthMeasurableMetadata {
options {
atomLink {
monitoredAttribute {
threshold {
path( string )
children( Collection of healthMeasurableMetadata )
editable( boolean )
name( string )
options( options )
childCount( int )
attributes( Collection of monitoredAttribute )
links( Collection of atomLink )
id( string )
state( string )
}
options {
enableAuth( boolean )
links( Collection of atomLink )
}
atomLink {
hreflang( string )
length( string )
rel( string )
href( anyURI )
title( string )
type( string )
}
monitoredAttribute {
path( string )
name( string )
description( string )
threshold( threshold )
links( Collection of atomLink )
units( string )
state( string )
type( string )
value( anyType )
}
threshold {
normal( string )
failure( string )
warning( string )
links( Collection of atomLink )
}
DELETE/measurables/{parent}/children/{child}deleteMetadataChild
Parameters
Name
Type
Description
Model
parent
path
string
child
path
string
GET/measurables/{parent}/children/{child}/variables/{var}getVariable
Parameters
Name
Type
Description
Model
parent
path
string
child
path
string
var
path
string
Reponse
Produces application/json
Status Code
Reason
Model
200
Success
monitoredAttribute
monitoredAttribute {
threshold {
atomLink {
path( string )
name( string )
description( string )
threshold( threshold )
links( Collection of atomLink )
units( string )
state( string )
type( string )
value( anyType )
}
threshold {
normal( string )
failure( string )
warning( string )
links( Collection of atomLink )
}
atomLink {
hreflang( string )
length( string )
rel( string )
href( anyURI )
title( string )
type( string )
}
PUT/measurables/{parent}/children/{child}/variables/{var}/thresholdupdateThreshold
Parameters
Name
Type
Description
Model
parent
path
string
child
path
string
var
path
string
body
entity
threshold
threshold {
atomLink {
normal( string )
failure( string )
warning( string )
links( Collection of atomLink )
}
atomLink {
hreflang( string )
length( string )
rel( string )
href( anyURI, required )
title( string )
type( string )
}
Reponse
Produces application/json
Status Code
Reason
Model
200
Success
threshold
threshold {
atomLink {
normal( string )
failure( string )
warning( string )
links( Collection of atomLink )
}
atomLink {
hreflang( string )
length( string )
rel( string )
href( anyURI )
title( string )
type( string )
}
GET/measurables/{parent}/children/{child}/variables/{var}/thresholdgetThreshold
Parameters
Name
Type
Description
Model
parent
path
string
child
path
string
var
path
string
Reponse
Produces application/json
Status Code
Reason
Model
200
Success
threshold
threshold {
atomLink {
normal( string )
failure( string )
warning( string )
links( Collection of atomLink )
}
atomLink {
hreflang( string )
length( string )
rel( string )
href( anyURI )
title( string )
type( string )
}