Jump to

• Request
• Response

Get Load Balancer Port Mapping for Instance Creation

get

/api/v1/blockchainPlatforms/instances/generateLBRPortMapping

Returns the external load balancer port mapping that is used in instance creation.

Request

Supported Media Types

• application/json

Query Parameters

• lbrFqdn: string
  External load balancer host
• peerCount(optional): integer
  Number of peers to be created.
• platformHosts: string
  List of comma separated platform hosts
• startPort(optional): integer
  Starting port for external load balancer port mapping

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

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

{
    "description":"External load balancer port mapping list wrapper",
    "type":"object",
    "properties":{
        "portMapping":{
            "description":"List of external load balancer Port mapping",
            "type":"array",
            "items":{
                "$ref":"#/definitions/LBRPortMapping"
            }
        }
    }
}

Nested Schema : portMapping

Type: array

List of external load balancer Port mapping

Show Source

• Array of: object LBRPortMapping
  External load balancer port mapping

{
    "description":"List of external load balancer Port mapping",
    "type":"array",
    "items":{
        "$ref":"#/definitions/LBRPortMapping"
    }
}

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

{
    "description":"External load balancer port mapping",
    "type":"object",
    "properties":{
        "serviceName":{
            "description":"Service name",
            "type":"string"
        },
        "externalPort":{
            "description":"External port number",
            "type":"integer"
        },
        "externalHost":{
            "description":"External host",
            "type":"string"
        },
        "enableSSL":{
            "description":"Enable or disable SSL for a port",
            "type":"boolean"
        },
        "internalPort":{
            "description":"Internal port number",
            "type":"integer"
        },
        "internalHost":{
            "description":"Internal host",
            "type":"string"
        }
    }
}

401 Response

Unauthorized

Body ()

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

{
    "description":"Error Information.",
    "required":[
        "status",
        "message"
    ],
    "properties":{
        "status":{
            "description":"A short error status that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        },
        "errors":{
            "type":"array",
            "description":"list of errors",
            "items":{
                "type":"string"
            }
        },
        "warnings":{
            "type":"array",
            "description":"list of warnings",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : errors

Type: array

list of errors

Show Source

• Array of: string

{
    "type":"array",
    "description":"list of errors",
    "items":{
        "type":"string"
    }
}

Nested Schema : warnings

Type: array

list of warnings

Show Source

• Array of: string

{
    "type":"array",
    "description":"list of warnings",
    "items":{
        "type":"string"
    }
}

404 Response

Not Found

Body ()

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

{
    "description":"Error Information.",
    "required":[
        "status",
        "message"
    ],
    "properties":{
        "status":{
            "description":"A short error status that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        },
        "errors":{
            "type":"array",
            "description":"list of errors",
            "items":{
                "type":"string"
            }
        },
        "warnings":{
            "type":"array",
            "description":"list of warnings",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : errors

Type: array

list of errors

Show Source

• Array of: string

{
    "type":"array",
    "description":"list of errors",
    "items":{
        "type":"string"
    }
}

Nested Schema : warnings

Type: array

list of warnings

Show Source

• Array of: string

{
    "type":"array",
    "description":"list of warnings",
    "items":{
        "type":"string"
    }
}

500 Response

Internal Server Error

Body ()

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

{
    "description":"Error Information.",
    "required":[
        "status",
        "message"
    ],
    "properties":{
        "status":{
            "description":"A short error status that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        },
        "errors":{
            "type":"array",
            "description":"list of errors",
            "items":{
                "type":"string"
            }
        },
        "warnings":{
            "type":"array",
            "description":"list of warnings",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : errors

Type: array

list of errors

Show Source

• Array of: string

{
    "type":"array",
    "description":"list of errors",
    "items":{
        "type":"string"
    }
}

Nested Schema : warnings

Type: array

list of warnings

Show Source

• Array of: string

{
    "type":"array",
    "description":"list of warnings",
    "items":{
        "type":"string"
    }
}

Back to Top