Get OHS instance details for a tenant
Requesters are able to get details for all of the OHS instances for a given tenant. The information retrieved by this request will need to be captured and passed in other requests.
Variables
Variable | Description |
---|---|
TenantId | Tenant Management Tenant IE GUID. |
CorrelationId | Correlation identifier GUID as set by the requester for tracking requests to responses. |
Sample cURL Request
curl --location --request GET 'https://k8s.itrontotal.com/ihcconfiggateway/api/v1/tenants/{TenantId}
/tenantinstances'
--header 'Content-Type: application/json'
--header 'Correlationid: {CorrelationId}'
--header 'Authorization: Bearer eyJhbGciOiJSUzI1Ni' \
Sample JSON Response
{ "ohsInstanceInfos": [ { "tenantInstanceId": "83ad9966-452a-4c38-bc86-0b53308d98a1", "instanceName": "demoinstance123454", "status": "NotApplied", "isDownloadEnabled": true, "datasources": [ "File Transfer" ], "outcomes": [ "Forecasting" ], "instanceId": "88083542-3b33-45fe-ba91-ac6255c97fb6", "ohsVersion": "2.4.0.9" }, { "tenantInstanceId": "13278436-7b6e-4a53-9eb1-859cc0acf562", "instanceName": "InstanceForFeatureDemo", "status": "Configured", "isDownloadEnabled": true, "datasources": [ "OWOC-CE/CM" ], "outcomes": [ "Itron Analytics", "Distributed Intelligence" ], "instanceId": "f3356ce5-f593-48f3-a15e-253e8d1276f6", "ohsVersion": "2.4.0.16", "hostName": "VMForOHSTest", "clientId": "4666ee37-2807-4afb-8e1e-120e01ac07b2", "healthStatus": "Running" } ] }
Tip: To get details of the OHS instance configured on your machine when there are multiple instance details in the response, use the following procedure:
|