This API has a deprecated equivalent from v7.0U1.
Get Services
Returns the state of a service.
Request
URLURL
https://{api_host}/api/appliance/services/{service}
Path Parameters
Path Parameters
string
service
Required
identifier of the service whose state is being queried. The parameter must be an identifier for the resource type: com.vmware.appliance.services.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
ServicesInfo
of type application/json
Service Info structure.
{
"description": "string",
"state": "STARTING"
}
string
description
Required
Service description
state
Required
The Services.State enumerated type defines valid Run State for services.
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
Possible values are: STARTING , STOPPING , STARTED , STOPPED
Errors
404
com.vmware.vapi.std.errors.not_found : if the service associated with service does not exist.
500
com.vmware.vapi.std.errors.error : if any other error occurs during the execution of the operation.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
Invoke-ApplianceGetService -Service "MyService"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/appliance/services/{service}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: get
x-vmw-doc-deprecated-path: /rest/appliance/services/{service}
x-vmw-doc-operation: get
Availability
Added in 7.0U2
