Get Service Deprecated
Returns the state of a service.
Request
URLURL
https://{api_host}/rest/vcenter/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.vcenter.services.Service.
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
ServicesServiceGetResponseBody of type application/json
Service Info structure.
{
"value": {
"description_key": "string",
"health": "DEGRADED",
"health_messages": [
{
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": [
{
"key": "key1",
"value": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
]
}
],
"name_key": "string",
"startup_type": "MANUAL",
"state": "STARTING"
}
}
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
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/rest/vcenter/services/{service}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-new-method: get
x-vmw-doc-new-path: /api/vcenter/services/{service}
x-vmw-doc-operation: get
Availability
Added in 6.7
On This Page
Service Operations
get
patch
post
post
post
