REST API - get

vcenter services service: get

Returns the state of a service. This operation was added in vSphere API 6.7

Request:

HTTP request

GET https://{server}/rest/vcenter/services/{service}

Path Parameters

Name	Type	Description
Required
service	string	identifier of the service whose state is being queried.

Response:

HTTP Status Code: 200

Representation:

JSON

{
    "value": {
        "description_key": "string",
        "health": "DEGRADED",
        "health_messages": [
            {
                "args": [
                    "string",
                    "string"
                ],
                "default_message": "string",
                "id": "string"
            },
            {
                "args": [
                    "string",
                    "string"
                ],
                "default_message": "string",
                "id": "string"
            }
        ],
        "name_key": "string",
        "startup_type": "MANUAL",
        "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. This attribute was added in vSphere API 6.7
value.description_key	string	Service description key. Can be used to lookup resource bundle. This attribute was added in vSphere API 6.7
value.startup_type	string	Startup Type. This attribute was added in vSphere API 6.7 Defines valid Startup Type for vCenter Server services. This enumeration was added in vSphere API 6.7 Value is one of: MANUAL: Service Startup type is Manual, thus issuing an explicit start on the service will start it. This constant was added in vSphere API 6.7 AUTOMATIC: Service Startup type is Automatic, thus during starting all services or issuing explicit start on the service will start it. This constant was added in vSphere API 6.7 DISABLED: Service Startup type is Disabled, thus it will not start unless the startup type changes to manual or automatic. This constant was added in vSphere API 6.7
value.state	string	Running State. This attribute was added in vSphere API 6.7 Defines valid Run State for services. This enumeration was added in vSphere API 6.7 Value is one of: STARTING: Service Run State is Starting, it is still not functional. This constant was added in vSphere API 6.7 STOPPING: Service Run State is Stopping, it is not functional. This constant was added in vSphere API 6.7 STARTED: Service Run State is Started, it is fully functional. This constant was added in vSphere API 6.7 STOPPED: Service Run State is Stopped. This constant was added in vSphere API 6.7
value.health	string	Health of service. This attribute was added in vSphere API 6.7 Defines the possible values for health of a service. This enumeration was added in vSphere API 6.7 Value is one of: DEGRADED: Service is in degraded state, it is not functional. This constant was added in vSphere API 6.7 HEALTHY: Service is in a healthy state and is fully functional. This constant was added in vSphere API 6.7 HEALTHY_WITH_WARNINGS: Service is healthy with warnings. This constant was added in vSphere API 6.7Optional. 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. This attribute was added in vSphere API 6.7 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[]	Arguments to be substituted into a message template.

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.