移動

• リクエスト
• レスポンス
• 例

外部ロード・バランサ・ポート・マッピングの取得

get

/api/v1/blockchainPlatforms/instances/{id}/lbrportmapping

インスタンスの外部ロード・バランサ・ポートのマッピングを取得します。

リクエスト

サポートされるメディア・タイプ

• application/json

パス・パラメータ

• id: string
  プラットフォーム・インスタンスの一意の識別子

先頭に戻る

レスポンス

サポートされるメディア・タイプ

• application/json

200レスポンス

OK

本文()

ルート・スキーマ: LBRPortMappingWrapper

型: object

外部ロード・バランサ・ポートのマッピング・リストのラッパー

ソースの表示

• portMapping(オプション): array portMapping
  外部ロード・バランサ・ポートのマッピングのリスト

{
    "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"
            }
        }
    }
}

ネストしたスキーマ: portMapping

型: array

外部ロード・バランサ・ポートのマッピングのリスト

ソースの表示

• 配列: object LBRPortMapping
  外部ロード・バランサ・ポートのマッピング

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

ネストしたスキーマ: LBRPortMapping

型: object

外部ロード・バランサ・ポートのマッピング

ソースの表示

• enableSSL(オプション): boolean
  ポートのSSLの有効化または無効化
• externalHost(オプション): string
  外部ホスト
• externalPort(オプション): integer
  外部ポート番号
• internalHost(オプション): string
  内部ホスト
• internalPort(オプション): integer
  内部ポート番号
• serviceName(オプション): string
  サービス名

{
    "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レスポンス

未認可

本文()

ルート・スキーマ: Error

型: object

エラー情報。

ソースの表示

• errors(オプション): array errors
  エラーのリスト
• message: string
  判読可能なエラー文字列。
• status: string
  プログラムによる解析を目的とした、エラーを定義する短いエラー・ステータス。
• warnings(オプション): array 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"
            }
        }
    }
}

ネストしたスキーマ: errors

型: array

エラーのリスト

ソースの表示

• 配列: string

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

ネストしたスキーマ: warnings

型: array

警告のリスト

ソースの表示

• 配列: string

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

404レスポンス

見つかりません

本文()

ルート・スキーマ: Error

型: object

エラー情報。

ソースの表示

• errors(オプション): array errors
  エラーのリスト
• message: string
  判読可能なエラー文字列。
• status: string
  プログラムによる解析を目的とした、エラーを定義する短いエラー・ステータス。
• warnings(オプション): array 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"
            }
        }
    }
}

ネストしたスキーマ: errors

型: array

エラーのリスト

ソースの表示

• 配列: string

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

ネストしたスキーマ: warnings

型: array

警告のリスト

ソースの表示

• 配列: string

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

500レスポンス

内部サーバー・エラー

本文()

ルート・スキーマ: Error

型: object

エラー情報。

ソースの表示

• errors(オプション): array errors
  エラーのリスト
• message: string
  判読可能なエラー文字列。
• status: string
  プログラムによる解析を目的とした、エラーを定義する短いエラー・ステータス。
• warnings(オプション): array 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"
            }
        }
    }
}

ネストしたスキーマ: errors

型: array

エラーのリスト

ソースの表示

• 配列: string

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

ネストしたスキーマ: warnings

型: array

警告のリスト

ソースの表示

• 配列: string

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

先頭に戻る

例

このエンドポイントは、特定のBlockchain Platformインスタンスの外部Loadbalancerポート・マッピングを取得するために使用されます。

次の例は、cURLを使用してRESTリソースに対するGETリクエストを発行し、特定のBlockchain Platformインスタンスを起動する方法を示しています。

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'
  

レスポンス本文の例

JSON形式のレスポンス本文のコンテンツの例を次に示します。

{
  "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": ""
    }
  ]
}

先頭に戻る