Get Service Status

Get Service Status

Valid input values are:

  • vcd (alias of vmware-vcd)
  • vmware-vcd
  • vpostgres
  • repmgrd
  • appliance-sync.timer
Request
URI
GET
https://{api_host}/api/1.0.0/services/{service-name}
COPY
Path Parameters
string
service-name
Required

Name of service whose details you want returned

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns ApplianceService of type(s) application/json 
{
    "serviceName": "string",
    "status": "string"
}
string
serviceName
Optional

Name of service.
Currently supported services are:

  • vcd alias vmware-vcd
  • vpostgres
  • repmgrd
string
status
Optional

Status of service. Valid responses include:

  • start
  • running
  • dead
  • dead (normal when appliance is in manual failover mode)

404

service-name value specified is not valid.

Operation doesn't return any data structure

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/1.0.0/services/{service-name}
Availability
Added in 34
On This Page
Appliance Service Operations
GET
Get Service Status
POST
Reload Service