移動

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

イベントのサブスクライブ

post

/restproxy/api/v2/channels/{channelId}/event-subscriptions

イベントをサブスクライブします

リクエスト

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

• application/json

パス・パラメータ

• channelId: string
  チャネルのID

本文()

イベントをサブスクライブするリクエスト

ルート・スキーマ: EventSubscription

型: object

ソースの表示

• block(オプション): integer(int64)
  ブロックの番号
• callbackTLSCerts: object callbackTLSCerts
• callbackURL: string
  コールバックURL
• chaincode(オプション): string
  チェーンコードの名前
• encode(オプション): string
  許容値: [ "base64", "raw" ]

  イベント・タイプがチェーンコードの場合、レスポンス・ペイロードがbase64またはRAWとして返されます。デフォルトはbase64です。
• event(オプション): string
  イベントの名前。
• expires(オプション): string
  サブスクリプションの有効期限
• role(オプション): string
  使用するFabric登録の名前
• seek(オプション): string
  許容値: [ "oldest", "newest", "from" ]

  イベントの開始位置。"block"および"filteredblock"タイプにのみ使用されます
• txid(オプション): string
  トランザクションのID
• type: string
  許容値: [ "block", "filteredblock", "transaction", "chaincode" ]

  サブスクライブするイベント・タイプ

{
    "type":"object",
    "required":[
        "type",
        "callbackURL",
        "callbackTLSCerts"
    ],
    "properties":{
        "role":{
            "description":"Name of Fabric enrollment to be used",
            "type":"string"
        },
        "type":{
            "description":"Event type to subscribe to",
            "type":"string",
            "enum":[
                "block",
                "filteredblock",
                "transaction",
                "chaincode"
            ]
        },
        "callbackURL":{
            "description":"Callback URL",
            "type":"string"
        },
        "callbackTLSCerts":{
            "type":"object",
            "properties":{
                "caCert":{
                    "type":"string"
                },
                "clientCert":{
                    "type":"string"
                },
                "keyPassword":{
                    "type":"string"
                }
            }
        },
        "expires":{
            "description":"Expiration of the subscription",
            "type":"string"
        },
        "txid":{
            "description":"ID of the transaction",
            "type":"string"
        },
        "chaincode":{
            "description":"Name of the chaincode",
            "type":"string"
        },
        "event":{
            "description":"Name of the event",
            "type":"string"
        },
        "seek":{
            "description":"Start position of the event. Only used for type \"block\" and \"filteredblock\"",
            "type":"string",
            "enum":[
                "oldest",
                "newest",
                "from"
            ]
        },
        "block":{
            "description":"Number of the block",
            "type":"integer",
            "format":"int64"
        },
        "encode":{
            "description":"When the event type is chaincode, the response payload can be returned either as base64 or raw. The default is base64.",
            "type":"string",
            "enum":[
                "base64",
                "raw"
            ]
        }
    }
}

ネストしたスキーマ: callbackTLSCerts

型: object

ソースの表示

• caCert(オプション): string
• clientCert(オプション): string
• keyPassword(オプション): string

{
    "type":"object",
    "properties":{
        "caCert":{
            "type":"string"
        },
        "clientCert":{
            "type":"string"
        },
        "keyPassword":{
            "type":"string"
        }
    }
}

先頭に戻る

レスポンス

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

• application/json

200レスポンス

操作の成功

本文()

ルート・スキーマ: schema

型: object

ソースの表示

• error(オプション): string
  デフォルト値:

  操作が失敗した場合のエラー・メッセージ
• result(オプション): object result
• returnCode: string
  許容値: [ "Success", "Failure" ]

{
    "type":"object",
    "required":[
        "returnCode"
    ],
    "properties":{
        "returnCode":{
            "$ref":"#/definitions/returnCode"
        },
        "error":{
            "type":"string",
            "description":"Error message when operation fails",
            "default":""
        },
        "result":{
            "type":"object",
            "required":[
                "subid"
            ],
            "properties":{
                "subid":{
                    "description":"ID of the subscription when operation succeeds",
                    "type":"string"
                }
            }
        }
    }
}

ネストしたスキーマ: result

型: object

ソースの表示

• subid: string
  操作が成功した場合のサブスクリプションのID

{
    "type":"object",
    "required":[
        "subid"
    ],
    "properties":{
        "subid":{
            "description":"ID of the subscription when operation succeeds",
            "type":"string"
        }
    }
}

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

403レスポンス

禁止

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

先頭に戻る

例

このエンドポイントは、イベント・サブスクリプションをリクエストするために使用されます。

次の例は、cURLを使用してRESTリソースに対するPOSTリクエストを発行し、イベント・サブスクリプションをリクエストする方法を示しています。

curl -v -u <username>:<password> -X POST \
  "https://<restproxy of your Blockchain instance>/api/v2/channels/default/event-subscriptions" \
  -H "accept: application/json" \
  -H "Content-Type: application/json" \
  --data @<JSON file with the request parameters>

例:

curl -v -u obpuser:<password> -X POST \
  "https://myvm.oracle.com:10000/restproxy/api/v2/channels/default/event-subscriptions" \
  -H "accept: application/json" \
  -H "Content-Type: application/json" \
  --data @file.json

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

{
 "role": "myinstance_defaultuser",
 "type": "chaincode",
 "callbackURL": "http://10.168.108.17:9000",
 "expires": "1m", 
 "callbackTLSCerts": { 
   "caCert": "",
   "clientCert": "",
   "keyPassword": "" },
 "txid": "b1c11242383212cfdcca97d68efc0b3641436b1845a9b4c6e822cf6099ca49ee",
 "chaincode": "obcs-example02",
 "seek": "oldest", 
 "block": 0,
 "event": ".*"
}

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

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

パラメータ	用途	指定できる値
role	ユーザー・ロール
type	イベント・タイプ	transaction: 特定のトランザクションIDに対するイベントに関連します。 chaincode: チェーンコードから生成されたイベントを返します。 block: ブロック内のデータ全体を返します。 filteredtransaction: ブロック番号と各トランザクションIDを、チェーンコード・イベントの検証コードおよびペイロードとともに返します。
callbackURL	イベントのコールバック・アドレス。	有効なHTTP/HTTPSアドレスである必要があります。
expires	現在のリクエスト時以降、サブスクライブ済イベントが期限切れになるまでの時間。	<xx>M、<xx>w、<xx>d、<xx>h、<xx>m: xxは有効な整数です。 Mは月を表します。 wは週です。 dは日です。 hは時間です mは分を示します。 設定されていない場合、デフォルト値は1d (1日)です。
callbackTLSCerts	TLS証明書をコールバックします。	次のものが含まれます。 caCert (オプション): コールバック・サーバーのCA証明書。コールバック・サーバーを検証するために、RESTプロキシによって使用されます。証明書はPEM形式で作成されている必要があります。 clientCert (オプション): コールバック・サーバーへの接続時に、RESTプロキシの証明書として使用されるクライアント証明書。コールバック・サーバーで相互認証を有効にする場合にのみ必要です。証明書はPEM形式で、秘密キーとクライアント証明書を連結したものであることが必要です。 keyPassword (オプション): 暗号化された秘密キーのパスワード。base64でエンコードされている必要があり、clientCertに暗号化された秘密キーが含まれる場合にのみ必要です。
txid	トランザクションID
chaincode	サブスクライブしているチェーンコード・アプリケーションのチェーンコードID。
seek	配信されるブロック。	oldest: すべてのブロックを最も古いブロックから配信します newest: 最新のブロックを配信します from: blockパラメータに指定されたブロック番号から配信します。 このオプションは、typeがblockまたはfilteredblockの場合にのみ使用できます。
block	ブロック番号	この値は、seekがfromの場合に使用されます。
event	チェーンコードのイベント・フィルタ	*は、すべてのイベントを指定します。

ノート:

Blockchainインスタンスのrestproxy値は、インスタンス・コンソールの「ノード」タブから確認できます。

レスポンス本文の例

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

{
   "returnCode": "Success",
   "error": "",
   "result": {
       "subid": "obpuser-dc28b77c-7e58-4b09-ae23-b2c01fa01b70"
   }
}

先頭に戻る