appliance vmon service: get
Returns the state of a service.
Request:
HTTP request
GET https://{server}/rest/appliance/vmon/service/{service}
Path Parameters
| Name | Type | Description |
|---|---|---|
| Required | ||
| service | string | identifier of the service whose state is being queried. |
Response:
HTTP Status Code: 200
Representation:
{
"value" : {
"name_key" : "string",
"startup_type" : "MANUAL",
"health_messages" : [
{
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
},
{
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
],
"health" : "DEGRADED",
"description_key" : "string",
"state" : "STARTING"
}
}
"value" : {
"name_key" : "string",
"startup_type" : "MANUAL",
"health_messages" : [
{
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
},
{
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
],
"health" : "DEGRADED",
"description_key" : "string",
"state" : "STARTING"
}
}
Response Type:
| Name | Type | Description |
|---|---|---|
| bold = required | ||
| value | info | Service Info structure. |
| value.name_key | string | Service name key. Can be used to lookup resource bundle |
| value.description_key | string | Service description key. Can be used to lookup resource bundle |
| value.startup_type | string | Startup Type. Defines valid Startup Type for services managed by vMon. Value is one of: MANUAL: Service Startup type is Manual, thus issuing an explicit start on the service will start it. AUTOMATIC: Service Startup type is Automatic, thus during starting all services or issuing explicit start on the service will start it. DISABLED: Service Startup type is Disabled, thus it will not start unless the startup type changes to manual or automatic. |
| value.state | string | Running State. Defines valid Run State for services. Value is one of: STARTING: Service Run State is Starting, it is still not functional STOPPING: Service Run State is Stopping, it is not functional STARTED: Service Run State is Started, it is fully functional STOPPED: Service Run State is Stopped |
| value.health | string | Health of service. Defines the possible values for health of a service. Value is one of: DEGRADED: Service is in degraded state, it is not functional. HEALTHY: Service is in a healthy state and is fully functional. HEALTHY_WITH_WARNINGS: Service is healthy with warnings.Optional. It is only relevant when state has value STARTED. This field is optional and it is only relevant when the value of state is STARTED. |
| value.health_messages | localizable_message[] | Localizable messages associated with the health of the service Optional. It is only relevant when state has value STARTED. This field is optional and it is only relevant when the value of state is STARTED. |
| value.health_messages[].id | string | Unique identifier of the localizable string or message template. This identifier is typically used to retrieve a locale-specific string or message template from a message catalog. |
| value.health_messages[].default_message | string | The value of this localizable string or message template in the en_US (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog. |
| value.health_messages[].args | string[] | Positional arguments to be substituted into the message template. This list will be empty if the message uses named arguments or has no arguments. |
Errors:
| HTTP Status Code | Type | Description |
|---|---|---|
| 404 | not_found | if the service associated with service does not exist. |
| 500 | error | if any other error occurs during the execution of the operation. |