REST API - get

REST API - get

appliance services: get

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

Request:

HTTP request

GET https://{server}/rest/appliance/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:

{
    "value" : {
        "description" : "string",
        "state" : "STARTING"
    }
}

Response Type:

Name	Type	Description
bold = required
value	info	Service Info structure.
value.description	string	Service description. This attribute 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.

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.