Get service port

Content Platform for Cloud Scale Management API Reference

Version
2.5.x
Audience
anonymous
Part Number
MK-HCPCS007-08

The method public/discovery/get_service_port retrieves the external port used by an HCP for cloud scale service. You don't need an OAuth token to use this method.

HTTP request syntax (URI)

POST https://host_ip:9099/mapi/v1/public/discovery/get_service_port

Request structure

The request body is:

{
  "portType": "type" 
}
Parameter Required Type Description
portType Yes String The type of service:
  • ADMIN_APP: System Management application.
  • JAEGER_QUERY: Tracing service.
  • MAPI: Management API.
  • PROMETHEUS: Metrics service.

Response structure

The response body is:

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

Parameter

Type

Description

portNumber Integer The HTTP port of service.

Return codes

Status code

HTTP name

Description

200 OK The request was executed successfully.
401 Unauthorized Access was denied because credentials are not valid.
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
}