移動

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

Blockchain Platformインスタンスのスケール・アウト

post

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

Blockchain Platformインスタンスをスケール・アウトします。

リクエスト

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

• application/json

パス・パラメータ

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

本文()

JSONのリクエスト・ペイロード

ルート・スキーマ: ScaleOutPayload

型: object

scaleOutペイロード

ソースの表示

• newOrderers(オプション): array newOrderers
  新規オーダラ・リスト
• newPeers(オプション): array newPeers
  新規ピア・リスト
• newReplicas(オプション): object ScaleOutReplicaNumberDetails
  追加する1つのノード(サービス)番号
• newVMs(オプション): object ClusterCreationDetails
  クラスタを構成するためのVM

{
    "type":"object",
    "description":"scaleOut payload",
    "properties":{
        "newVMs":{
            "$ref":"#/definitions/ClusterCreationDetails"
        },
        "newReplicas":{
            "$ref":"#/definitions/ScaleOutReplicaNumberDetails"
        },
        "newPeers":{
            "type":"array",
            "description":"New peers list",
            "items":{
                "$ref":"#/definitions/ScaleOutPeerDetails"
            }
        },
        "newOrderers":{
            "type":"array",
            "description":"new Orderers list",
            "items":{
                "$ref":"#/definitions/ScaleOutOrdererDetails"
            }
        }
    }
}

ネストしたスキーマ: newOrderers

型: array

新規オーダラ・リスト

ソースの表示

• 配列: object ScaleOutOrdererDetails
  追加するオーダラ詳細

{
    "type":"array",
    "description":"new Orderers list",
    "items":{
        "$ref":"#/definitions/ScaleOutOrdererDetails"
    }
}

ネストしたスキーマ: newPeers

型: array

新規ピア・リスト

ソースの表示

• 配列: object ScaleOutPeerDetails
  追加する1つのピアの詳細

{
    "type":"array",
    "description":"New peers list",
    "items":{
        "$ref":"#/definitions/ScaleOutPeerDetails"
    }
}

ネストしたスキーマ: ScaleOutReplicaNumberDetails

型: object

追加する1つのノード(サービス)番号

ソースの表示

• CA(オプション): integer
  追加するCAレプリカ数
• proxy(オプション): integer
  追加するRESTプロキシ・レプリカ数

{
    "type":"object",
    "description":"One node(service) number to be  added",
    "properties":{
        "proxy":{
            "type":"integer",
            "description":"REST proxy replicas number to add"
        },
        "CA":{
            "type":"integer",
            "description":"CA replicas number to add"
        }
    }
}

ネストしたスキーマ: ClusterCreationDetails

型: object

クラスタを構成するためのVM

ソースの表示

• crcHosts(オプション): array crcHosts
  CRC VM (swarm内にない)のリスト
• platformHosts(オプション): array platformHosts
  マネージャVMリスト: ホスト名またはIP。複数のIPを持つVMの場合、これはIPである必要があり、現在呼び出されているコンポーネント・マネージャが含まれている必要があります

{
    "type":"object",
    "description":"VM to construct cluster",
    "properties":{
        "platformHosts":{
            "type":"array",
            "description":"Manager VM list: hostname or IP. For VM with multiple IPs, this must be IP, and it must include the current called Component Manager",
            "items":{
                "type":"string"
            }
        },
        "crcHosts":{
            "type":"array",
            "description":"CRC VM list, not in swarm",
            "items":{
                "type":"string"
            }
        }
    }
}

ネストしたスキーマ: ScaleOutOrdererDetails

型: object

追加するオーダラ詳細

ソースの表示

• completedLBRPortMapping(オプション): boolean
  デフォルト値: false

  外部ロード・バランサが使用されている場合は、これをtrueに設定して、外部ロード・バランサのポート・マッピング構成が完了していることを確認します。
• logLevel(オプション): string
  許容値: [ "PANIC", "ERROR", "WARNING", "INFO", "NOTICE", "DEBUG" ]

  ピアのログ・レベル
• org(オプション): string
  組織名
• vm(オプション): string
  ピアを特定するためのVMホスト名

{
    "type":"object",
    "description":"Orderer details to be added",
    "properties":{
        "org":{
            "type":"string",
            "description":"Organization name"
        },
        "logLevel":{
            "type":"string",
            "description":"Peer log level",
            "enum":[
                "PANIC",
                "ERROR",
                "WARNING",
                "INFO",
                "NOTICE",
                "DEBUG"
            ]
        },
        "vm":{
            "type":"string",
            "description":"VM hostname to locate peer"
        },
        "completedLBRPortMapping":{
            "type":"boolean",
            "default":false,
            "description":"If an external load balancer is used, set this to true to confirm the port mapping configuration in the exteral load balancer is complete."
        }
    }
}

ネストしたスキーマ: ScaleOutPeerDetails

型: object

追加する1つのピアの詳細

ソースの表示

• alias(オプション): string
  ピアの別名
• completedLBRPortMapping(オプション): boolean
  デフォルト値: false

  外部ロード・バランサが使用されている場合は、これをtrueに設定して、外部ロード・バランサのポート・マッピング構成が完了していることを確認します。
• logLevel(オプション): string
  許容値: [ "PANIC", "ERROR", "WARNING", "INFO", "NOTICE", "DEBUG" ]

  ピアのログ・レベル
• org(オプション): string
  組織名
• role(オプション): string
  許容値: [ "Member", "Admin" ]

  ピアのロール
• vm(オプション): string
  ピアを特定するためのVMホスト名

{
    "type":"object",
    "description":"One peer details to be added",
    "properties":{
        "org":{
            "type":"string",
            "description":"Organization name"
        },
        "role":{
            "type":"string",
            "description":"Peer role",
            "enum":[
                "Member",
                "Admin"
            ]
        },
        "logLevel":{
            "type":"string",
            "description":"Peer log level",
            "enum":[
                "PANIC",
                "ERROR",
                "WARNING",
                "INFO",
                "NOTICE",
                "DEBUG"
            ]
        },
        "alias":{
            "type":"string",
            "description":"Peer alias"
        },
        "vm":{
            "type":"string",
            "description":"VM hostname to locate peer"
        },
        "completedLBRPortMapping":{
            "type":"boolean",
            "default":false,
            "description":"If an external load balancer is used, set this to true to confirm the port mapping configuration in the exteral load balancer is complete."
        }
    }
}

ネストしたスキーマ: crcHosts

型: array

CRC VM (swarm内にない)のリスト

ソースの表示

• 配列: string

{
    "type":"array",
    "description":"CRC VM list, not in swarm",
    "items":{
        "type":"string"
    }
}

ネストしたスキーマ: platformHosts

型: array

マネージャVMリスト: ホスト名またはIP。複数のIPを持つVMの場合、これはIPである必要があり、現在呼び出されているコンポーネント・マネージャが含まれている必要があります

ソースの表示

• 配列: string

{
    "type":"array",
    "description":"Manager VM list: hostname or IP. For VM with multiple IPs, this must be IP, and it must include the current called Component Manager",
    "items":{
        "type":"string"
    }
}

先頭に戻る

レスポンス

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

• application/json

202レスポンス

受理

ヘッダー

• Location: string
  リクエストのステータスを問い合せるためのURLを含むロケーション・ヘッダー。

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

409レスポンス

操作の競合

本文()

ルート・スキーマ: 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インスタンスをスケール・アウトするために使用されます。

次のいずれかの方法を使用して、インスタンスをスケール・アウトできます。

• 新規VMの作成: クラスタに新しいVMを追加します(プラットフォーム・ホスト、チェーンコード・ホストまたはZookeeper/Kafkaホスト)。
• 新規レプリカの作成: 追加ノードを追加します(RESTプロキシまたはCA)。
• 新しいピアの作成:一度に1つのピアを追加します。

次の例では、cURLを使用してRESTリソースに対するPOSTリクエストを発行し、特定のBlockchain Platformインスタンスを問い合せてスケール・アウトする方法を示します。

curl -X POST \
  http://<hostname>:<port>/api/v1/blockchainPlatforms/instances/e1f7bcfe-cc7e-4d19-97fb-772b231fcf99/scaleout \
  -H 'Authorization: Basic b2JwdXNlcjpXZWxjb21lMQ==' \
  -H 'Content-Type: application/json'
    

リクエスト本文の例

JSON形式のリクエスト本文のコンテンツの例を次に示します。

{
 "newPeers": [
   {
     "org": "currentinstance",
     "role": "Member",
     "logLevel": "PANIC",
     "alias": "abcd",
     "vm": "myvm.oracle.com"
   }
 ]
}

レスポンス本文の例

次の例は、レスポンス本文の内容を示しています。

202 Accepted

先頭に戻る