Gets the serviceStatus for the specified serviceId.

Gets the serviceStatus for the specified serviceId.

This API returns the maximum amount of status information by making a connection to the url defined in the status type endpoint. It gathers the data from then ServiceRegistryStatus responses and populates it in the ServiceStatus objects. Note: This service request makes a call to an external system.

Request

URI

GET

https://{api_host}/component-registry/services/status/current/{serviceId}

COPY

Path Parameters

string

serviceId

Required

the id of a given service instance

Responses

200

successful operation

Returns ServiceStatus of type(s) */*

{
    "unregisterDenied": false,
    "lastUpdated": "string",
    "statusEndPointUrl": "string",
    "serviceStatus": {
        "serviceInitializationStatus": "string",
        "startedTime": "string",
        "defaultServiceEndpointType": "string",
        "solutionUser": "string",
        "sslCertificateInfo": {
            "notValidBefore": "string",
            "identityCertificateExists": false,
            "issuerName": "string",
            "notValidAfter": "string",
            "thumbprint": "string",
            "principalName": "string"
        },
        "errorMessage": "string",
        "initialized": false,
        "serviceName": "string",
        "identityCertificateInfo": {
            "notValidBefore": "string",
            "identityCertificateExists": false,
            "issuerName": "string",
            "notValidAfter": "string",
            "thumbprint": "string",
            "principalName": "string"
        },
        "serviceRegistrationId": "string"
    },
    "sslTrust": "string",
    "serviceTypeId": "string",
    "serviceId": "string",
    "serviceName": "string",
    "notAvailable": false
}

boolean

unregisterDenied

Optional

Indicates if it is forbidden to unregister the service. The list of forbidden services is defined in /etc/vcac/services-unregister.deny

string As date-time As date-time

lastUpdated

Optional

The last updated date.

string As url As url

statusEndPointUrl

Optional

The service status/health endpoint url where information about service status could be retrieved. No authentication is required.

ServiceRegistryStatus

serviceStatus

Optional

serviceStatus

string

sslTrust

Optional

The default ssl trust for a service.

string

serviceTypeId

Optional

The service type id. Generated based on the productId and typeId.

string As uuid As uuid

serviceId

Optional

The service id from the registration in the Component Registry.

string

serviceName

Optional

The name of the service.

boolean

notAvailable

Optional

Indicates whether the service is not currently available.

On This Page

Request

Path Parameters

200 Response Body

Component Registry Operations

API To generate A resolved link which points To A specific UI page and takes into account anyrequired parameters for the UI view page To render properly. The best way To see how To usethis API Is By looking At A real-world example.

Create Or update A service.

Create Endpoint Type Extension

Create Endpoint Type Spec

Creates A new ModelAndView object with 'docs/odata'view name and sets the base bath To /services

DELETE calls are not allowed

DELETE Method not allowed

Delete Endpoint

Delete Endpoint Type Extension

Delete Endpoint Type Spec

Deletes the endpoint associated with the provided service Id and endpointTypeId.

Get all serviceStatuses for services with registered status type endpoints.

GET Method not allowed

Get the config.js needed for API Explorer

Get Endpoint Type Extension

Get Endpoint Type Spec

Gets A new Form resource By endpointTypeId. The form provided will Be A composition Of all forms registered via An EndPointTypeExtension instance and the base Form generated based On the EndPointTypeSpec.

Gets A new ModelAndView object with 'docs/auth' view name and sets the base bath To /services

Gets all distinct endpoint types

Gets all distinct endpoint types associated with endpoints with services that match the provided serviceTypeId.

Gets all distinct service types In the system.

Gets all documentation endpoints

Gets all endpoint instances for A given service instance.

Gets all endpoint instances that implement the provided endpointTypeId

Gets all endpoints

Gets all endpoints associated with services that match the provided serviceTypeId AND that match the provided endpointTypeId.

Gets all endpoints associated with services that match the provided serviceTypeId.

Gets all registered services

Gets all services associated with the provided serviceTypeId.

Gets An edit Form resource By endpointId. The form provided will Be A composition Of all forms registered via An EndPointTypeExtension instance and the base Form generated based On the EndPointTypeSpec

Gets the 'default' endpoint instance that implements the provided endpointTypeId

Gets the default endpoint associated with the identity service's token endpoint (used To create Bearer tokens).

Gets the default endpoint associated with the SSO server endpoint type.

Gets the default service associated with the provided serviceTypeId

Gets the endpoint identified By Id

Gets the endpoint instance that implements endpointTypeId for A given service instance.

Gets the LoggerEntity Of the given category for provided serviceTypeId

Gets the service identified By id.

Gets the serviceStatus for the specified serviceId.

Handler for DELETE HTTP operations

Handler for POST HTTP operations

Handler for PUT HTTP operations

List Endpoint Type Extension

List Endpoint Type Spec

POST calls are not allowed

POST Method not allowed

PUT calls are not allowed

Registers A new service To the component registry.

Removes (i.e.: deregisters) the service matching the provided id.

Sets the given level To category To all services with endpoint

Sets the given severity level To category for the provided serviceTypeId

Similar To /services/status, this API gets all serviceStatuses for services with registered status type endpoints.

Submits A new EndPointFormData resource By endpointTypeId. The values In the form submitted will Be used To create A new EndPoint Of the provided enpointTypeId.

Submits An updated version Of An EndPoint through the EndPointFormData resource. The values In the form submitted will Be used To update An existing EndPoint with the provided endpointId As part Of the URL parameters.

This Is A convenience method which creates A new solution user, registers It with the SSO server, and then registers the provided service As new solution user In A single call

Update Or create A service.

Update Endpoint

Update Endpoint Type Extension

Update Endpoint Type Spec

Updates Or creates An endpoint associated with the provided service Id and endpointTypeId.