Get External Load Balancer Port Mapping
get
/api/v1/blockchainPlatforms/instances/{id}/lbrportmapping
Get the external load balancer port mapping for an instance.
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
Unique platform instance identifier
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : LBRPortMappingWrapper
Type:
object
External load balancer port mapping list wrapper
Show Source
-
portMapping(optional):
array portMapping
List of external load balancer Port mapping
Nested Schema : portMapping
Type:
array
List of external load balancer Port mapping
Show Source
-
Array of:
object LBRPortMapping
External load balancer port mapping
Nested Schema : LBRPortMapping
Type:
object
External load balancer port mapping
Show Source
-
enableSSL(optional):
boolean
Enable or disable SSL for a port
-
externalHost(optional):
string
External host
-
externalPort(optional):
integer
External port number
-
internalHost(optional):
string
Internal host
-
internalPort(optional):
integer
Internal port number
-
serviceName(optional):
string
Service name
401 Response
Unauthorized
Root Schema : Error
Type:
object
Error Information.
Show Source
-
errors(optional):
array errors
list of errors
-
message:
string
A human-readable error string.
-
status:
string
A short error status that defines the error, meant for programmatic parsing.
-
warnings(optional):
array warnings
list of warnings
404 Response
Not Found
Root Schema : Error
Type:
object
Error Information.
Show Source
-
errors(optional):
array errors
list of errors
-
message:
string
A human-readable error string.
-
status:
string
A short error status that defines the error, meant for programmatic parsing.
-
warnings(optional):
array warnings
list of warnings
500 Response
Internal Server Error
Root Schema : Error
Type:
object
Error Information.
Show Source
-
errors(optional):
array errors
list of errors
-
message:
string
A human-readable error string.
-
status:
string
A short error status that defines the error, meant for programmatic parsing.
-
warnings(optional):
array warnings
list of warnings
Examples
This endpoint is used to get the External Loadbalancer port mapping for a particular Blockchain Platform instance.
The following example shows how to start a particular Blockchain Platform instance by submitting a GET request on the REST resource using cURL.
curl -X GET \ http://<hostname>:<port>/api/v1/blockchainPlatforms/instances/e1f7bcfe-cc7e-4d19-97fb-772b231fcf99/lbrportmapping \ -H 'Authorization: Basic b2JwdXNlcjpXZWxjb21lMQ==' \ -H 'Content-Type: application/json'
Example of the Response Body
The following example shows the contents of the response body in JSON format:
{ "portMapping": [ { "serviceName": "e1f7bcfe-cc7e-4d19-97fb-772b231fcf44-restproxy", "externalPort": 10001, "externalHost": "myvm.oracle.com", "internalPort": 10001, "internalHost": "" }, { "serviceName": "e1f7bcfe-cc7e-4d19-97fb-772b231fcf44-ca", "externalPort": 10002, "externalHost": "myvm.oracle.com", "internalPort": 10002, "internalHost": "" }, { "serviceName": "e1f7bcfe-cc7e-4d19-97fb-772b231fcf44-prometheus", "externalPort": 10003, "externalHost": "myvm.oracle.com", "internalPort": 10003, "internalHost": "" }, { "serviceName": "e1f7bcfe-cc7e-4d19-97fb-772b231fcf44-console0", "externalPort": 10000, "externalHost": "myvm.oracle.com", "internalPort": 10000, "internalHost": "" }, { "serviceName": "e1f7bcfe-cc7e-4d19-97fb-772b231fcf44-orderer0", "externalPort": 10004, "externalHost": "myvm.oracle.com", "internalPort": 10004, "internalHost": "" }, { "serviceName": "e1f7bcfe-cc7e-4d19-97fb-772b231fcf44-orderer0", "externalPort": 10005, "externalHost": "myvm.oracle.com", "internalPort": 10005, "internalHost": "" }, { "serviceName": "e1f7bcfe-cc7e-4d19-97fb-772b231fcf44-orderer1", "externalPort": 10006, "externalHost": "myvm.oracle.com", "internalPort": 10006, "internalHost": "" }, { "serviceName": "e1f7bcfe-cc7e-4d19-97fb-772b231fcf44-orderer1", "externalPort": 10007, "externalHost": "myvm.oracle.com", "internalPort": 10007, "internalHost": "" }, { "serviceName": "e1f7bcfe-cc7e-4d19-97fb-772b231fcf44-peer0", "externalPort": 10036, "externalHost": "myvm.oracle.com", "internalPort": 10036, "internalHost": "" } ] }