移動

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

新規Blockchain Platformインスタンスの作成

post

/api/v1/blockchainPlatforms/instances

新規Blockchain Platformインスタンスを作成します。

リクエスト

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

• multipart/form-data

フォーム・パラメータ

• payload(必須):
  新しいサービスの詳細。

先頭に戻る

レスポンス

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

• application/json

202レスポンス

受理

ヘッダー

• Location: string
  リクエストのステータスを問い合せるためのURLを含むロケーション・ヘッダー。
• Retry-After: integer
  N秒後に再試行します。

400レスポンス

不正なリクエスト

401レスポンス

未認可

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インスタンスを作成するために使用されます。

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

curl -X POST \
  http://<hostname>:<port>/api/v1/blockchainPlatforms/instances \
  -H 'Authorization: Basic b2JwdXNlcjpXZWxjb21lMQ==' \
  -H 'Content-Type: application/json'
  
  

リクエスト本文の例

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

"name": "obpinstance1",
"desc": "test instance",
"platformRole": "founder",
"configuration": "Developer",
"domainName": "example.com",
"peer": 4,
}

レスポンス本文の例

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

202 Accepted

先頭に戻る