Oracle Blockchain Platform Enterprise Edition REST API

HSM接続のテスト

post

/api/v1/blockchainPlatforms/hsm/check

指定した各ホストからHSM接続をテストします。

リクエスト

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

application/json

HSMとの通信に必要な詳細

ルート・スキーマ: TestHsmPayload

型: object

HSMとの通信に必要な詳細

ソースの表示

hsmConfiguration: object HSMDetails

HSMとの通信に必要な詳細。
platformHosts: array platformHosts

テスト元のVMのホスト名またはIPアドレスのリスト。VMに複数のIPアドレスがある場合、リストはIPアドレスである必要があります。リストには、コンポーネント・マネージャVMが含まれている必要があります。

{
    "type":"object",
    "description":"Details required to communicate with the HSM",
    "required":[
        "platformHosts",
        "hsmConfiguration"
    ],
    "properties":{
        "platformHosts":{
            "type":"array",
            "description":"A list of host names or IP addresses of the VMs to test from. The list must be IP addresses if a VM has multiple IP addresses. The list must include the component manager VM.",
            "items":{
                "type":"string"
            }
        },
        "hsmConfiguration":{
            "$ref":"#/definitions/HSMDetails"
        }
    }
}

ネストされたスキーマ: HSMDetails

型: object

HSMとの通信に必要な詳細。

ソースの表示

chrystokiConf: string

Chrystoki.confファイルへのパス。
label: string

HSMで使用するパーティション・ラベル。
library: string

libCryptoki2.soライブラリのパス。
pin: string

HSM内のパーティションの暗号化担当者のPIN。

{
    "type":"object",
    "description":"Details required to communicate with the HSM.",
    "required":[
        "library",
        "label",
        "pin",
        "chrystokiConf"
    ],
    "properties":{
        "library":{
            "type":"string",
            "description":"The path for the libCryptoki2.so library."
        },
        "label":{
            "type":"string",
            "description":"The partition label to use in the HSM."
        },
        "pin":{
            "type":"string",
            "description":"The Crypto Officer PIN for the partition in the HSM."
        },
        "chrystokiConf":{
            "type":"string",
            "description":"The path to the Chrystoki.conf file."
        }
    }
}

ネストしたスキーマ: platformHosts

型: array

テスト元のVMのホスト名またはIPアドレスのリスト。VMに複数のIPアドレスがある場合、リストはIPアドレスである必要があります。リストには、コンポーネント・マネージャVMが含まれている必要があります。

ソースの表示

配列: string

{
    "type":"array",
    "description":"A list of host names or IP addresses of the VMs to test from. The list must be IP addresses if a VM has multiple IP addresses. The list must include the component manager VM.",
    "items":{
        "type":"string"
    }
}

先頭に戻る

レスポンス

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

application/json

200レスポンス

400レスポンス

不正なリクエスト

ルート・スキーマ: 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"
    }
}

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

先頭に戻る

例

次の例は、cURLを使用してRESTリソースに対するPOSTリクエストを発行することによって、ハードウェア・セキュリティ・モジュール(HSM)への接続をテストする方法を示しています。

curl -X POST -u <username>:<password> -k \
  "http://<rest_server_url>:port/api/v1/blockchainPlatforms/hsm/check" \
  -H "accept: application/json" \
  -H "Content-Type: application/json" \
  --data @<JSON file with the request parameters>

例:

curl -X POST -u <username>:<password> -k \
  "http://<rest_server_url>:port/api/v1/blockchainPlatforms/hsm/check" \
  -H "accept: application/json" \
  -H "Content-Type: application/json" \
  --data @file.json

file.jsonの内容は次のとおりです。

{
  "platformHosts":["vm1.example.com"],
  "hsmConfiguration":
    {
      "library":"/etc/hyperledger/fabric/dpod/fabric/libs/64/libCryptoki2.so",
      "label":"fabric",
      "pin":"PasswordPO1",
      "chrystokiConf":"/etc/hyperledger/fabric/dpod/fabric/"
    }
}

ペイロード・ファイルの各パラメータは、次を表しています。

表-ペイロードのパラメータ

パラメータ	用途	指定できる値
`platformHosts`	テスト元の仮想マシン(VM)のリスト	ホスト名またはIPアドレスの配列。VMに複数のIPアドレスがある場合、リストはIPアドレスである必要があります。リストには、コンポーネント・マネージャVMが含まれている必要があります。
`library`	暗号化ライブラリ・ファイル	libCryptoki2ライブラリ・ファイルへのパス。
`label`	パーティション・ラベル	HSMでテストするパーティションのラベル。
`pin`	暗号化担当者のPIN	HSMでテストするパーティションの暗号化担当者のPIN。
`chrystokiConf`	構成ファイル	`Chrystoki.conf`ファイルへのパス。

レスポンス本文の例

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

{
    "status": "200",
    "message": "HSM connectivity verified"
}

先頭に戻る