Skip to main content

We've Moved!

Product Documentation has moved to docs.hitachivantara.com
Hitachi Vantara Knowledge

Public resources

This module describes the public resources.

Get service port

You can retrieve the external port used by an HCP for cloud scale service. You don't need an OAuth token to use this endpoint.

HTTP request syntax (URI)
POST https://host_ip:9099/mapi/v1/public/discovery/get_service_port
Request structure

The request body is shown below:

{
  "portType": "type" 
}
ParameterRequiredTypeDescription
portTypeYesStringThe type of service:
  • ADMIN_APP: System Management application.
  • JAEGER_QUERY: Tracing service.
  • MAPI: Management APIs.
  • PROMETHEUS: Metrics service.
Response structure

The response body is shown below:

{
  "portType": "type",
  "portNumber": nnnnn
}

Parameter

Type

Description

portNumberIntegerThe HTTP port of service.
Return codes

Status code

HTTP name

Description

200 OK The request was executed successfully.
401 Unauthorized Access was denied due to invalid credentials.
405 Method Not Allowed The specified HTTP method is not allowed for public data. Resend using POST.
Example

Request example:

POST https://10.10.24.195:9099/mapi/v1/discovery/get_service_port

JSON request:

{
  "portType": "ADMIN_APP" 
}

JSON response:

{
  "portType": "ADMIN_APP",
  "portNumber": 8000
}