Vcenter Services Service get

Vcenter Services Service get

Returns the state of a service.

This operation was added in vSphere API 6.7.

Request
URI
GET
https://{api_host}/api/vcenter/services/{service}
COPY
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.

Authentication
This operation uses the following authentication methods.
Responses
200

Service Info structure.

Returns Vcenter Services Service Info of type(s) application/json 
{
    "name_key": "string",
    "description_key": "string",
    "startup_type": "string",
    "state": "string",
    "health": "string",
    "health_messages": [
        {
            "id": "string",
            "default_message": "string",
            "args": [
                "string"
            ],
            "params": {
                "params": {
                    "s": "string",
                    "dt": "string",
                    "i": 0,
                    "d": "number",
                    "l": "Vapi Std NestedLocalizableMessage Object",
                    "format": "string",
                    "precision": 0
                }
            },
            "localized": "string"
        }
    ]
}
string
name_key
Required

Service name key. Can be used to lookup resource bundle

This property was added in vSphere API 6.7.

string
description_key
Required

Service description key. Can be used to lookup resource bundle

This property was added in vSphere API 6.7.

string
startup_type
Required

Startup Type.

For more information see: Vcenter Services Service StartupType.

This property was added in vSphere API 6.7.

string
state
Required

Running State.

For more information see: Vcenter Services Service State.

This property was added in vSphere API 6.7.

string
health
Optional

Health of service.

For more information see: Vcenter Services Service Health.

This property was added in vSphere API 6.7.

This property is optional and it is only relevant when the value of state is Vcenter Services Service State.STARTED.

array of object
health_messages
Optional

Localizable messages associated with the health of the service

This property was added in vSphere API 6.7.

This property is optional and it is only relevant when the value of state is Vcenter Services Service State.STARTED.


404

if the service associated with service does not exist.

Returns Vapi Std Errors NotFound of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors NotFound0 
"Vapi Std Errors NotFound Object"

500

if any other error occurs during the execution of the operation.

Returns Vapi Std Errors Error of type(s) application/json 
"Vapi Std Errors Error Object"
array of object
messages
Required

Stack of one or more localizable messages for human error consumers.

The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.

Each subsequent message in the stack describes the "cause" of the prior message.

object
data
Optional

Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.

Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.

The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.

Some operations will not set this property when reporting errors.

string
error_type
Required

Discriminator field to help API consumers identify the structure type.

For more information see: Vapi Std Errors Error Type.

This property was added in vSphere API 6.7.2.

Can be missing or null for compatibility with preceding implementations.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/vcenter/services/{service}
On This Page
Vcenter Operations
POST
Vcenter Services Service start
POST
Vcenter Services Service stop
POST
Vcenter Services Service restart
GET
Vcenter Services Service get
PATCH
Vcenter Services Service update
GET
Vcenter Services Service listDetails