This API has a deprecated equivalent from v7.0U1.
List Services
Lists details of vCenter services.
Request
URLURL
https://{api_host}/api/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
map of
ServicesInfo
of type application/json
Map of service identifiers to service Info structures. The key in the result map will be an identifier for the resource type: com.vmware.appliance.services.
{
"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
500
com.vmware.vapi.std.errors.error : if any 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-ApplianceListServices
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/appliance/services
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
x-vmw-doc-operation: list
Availability
Added in 7.0U2
