Retrieves a summary of a specific service deployed to a Service Point v4 based on the ID of the service.
Request: GET https://<us|eu>.fleet.bluec.at/user/api/v1/serviceInstances/{id}
Authorization: Bearer token
Path parameter
Name | Description | Type | Required/Optional |
id | The service instance ID | Integer | Required |
Successful response
200 OK
{
"id": "12a345b67c890d123e4567f8a9012345",
"ingressEndpoints": [],
"name": "test-identity-instance",
"parameters": [
{
"name": "DNSForwarderType",
"value": "DoT"
},
{
"name": "EventHubName",
"value": "testLab"
},
{
"name": "EventHubConsumerGroup",
"value": "alpha"
},
{
"name": "EventHubPartitionId",
"value": "0"
},
{
"name": "EventHubConnectionString",
"value": "Endpoint=sb://NamespaceName.servicebus.windows.net/;SharedAccessKeyName=KeyName;SharedAccessKey=KeyValue"
},
{
"name": "UmbrellaOrganizationID",
"value": 0
}
],
"serviceDescriptorID": "edge-id-proxy-2.1.0",
"serviceName": "edge-id-proxy",
"servicePointID": "test-sp4-aws",
"status": "HEALTHY",
"version": "2.1.0"
}
Where the parameters represent the following:
- id—the unique ID of the service
- servicePointID—the unique ID of the service point to which the service is deployed
- serviceName—the name of the service
- version—the version of the service
- name—the user-defined name of the service.
- parameters—information about the service including the following
fields:
- name—the name of the service parameter
- value—the value of the service parameter
- ingressEndpoints—information about the ingress endpoints of the service
including the following fields:
- portLabel—the label for the ingress endpoint
- addresses—the IP addresses of the service point that bind to the ingress endpoint
- status—the status of the service. The status can be one of the
following:
- HEALTHY
- UNHEALTHY
- DEPLOYING
- DEPLOY_FAILED
- DELETED
- errorConditions—a list of error conditions if the service is not healthy
- targetVersion—the version of the software to which the service is to be updated
- updateStatus—the last reported status of the service version update. The
status can be one of the following:
- UPDATE_QUEUED
- UPDATE_IN_PROGRESS
- DELETE_QUEUED
- DELETE_IN_PROGRESS