ServicesServiceInfo

The Service.Info structure contains information about a service.

Properties

string

description_key Required

Service description key. Can be used to lookup resource bundle

string

name_key Required

Service name key. Can be used to lookup resource bundle

ServicesServiceStartupType Enum

startup_type Required

Startup Type.

Possible values are: MANUAL , AUTOMATIC , DISABLED

ServicesServiceState Enum

state Required

Running State.

Possible values are: STARTING , STOPPING , STARTED , STOPPED

ServicesServiceHealth Enum

health Optional

Health of service. This field is optional and it is only relevant when the value of Service.Info.state is STARTED.

Possible values are: DEGRADED , HEALTHY , HEALTHY_WITH_WARNINGS

array of StdLocalizableMessage

health_messages Optional

Localizable messages associated with the health of the service This field is optional and it is only relevant when the value of Service.Info.state is STARTED.

JSON Example

Show optional properties

{
    "description_key": "string",
    "name_key": "string",
    "startup_type": "enum",
    "state": "enum"
}

{
    "description_key": "string",
    "health": "enum",
    "health_messages": [
        {
            "args": [
                "string"
            ],
            "default_message": "string",
            "id": "string",
            "localized": "string",
            "params": {
                "key": {
                    "d": 0,
                    "dt": "string",
                    "format": "enum",
                    "i": 0,
                    "l": {
                        "id": "string",
                        "params": "StdLocalizationParam Object"
                    },
                    "precision": 0,
                    "s": "string"
                }
            }
        }
    ],
    "name_key": "string",
    "startup_type": "enum",
    "state": "enum"
}

Returned By

List Details Service
Get Service

ServicesServiceInfo

Properties

JSON Example

Returned By

Was this page helpful?