イベント・サブスクリプションのリスト
get
/restproxy/api/v2/channels/{channelId}/event-subscriptions
すべてのイベント・サブスクリプションをリストします
リクエスト
サポートされるメディア・タイプ
- application/json
パス・パラメータ
- channelId: string
チャネルのID
問合せパラメータ
- role: string
使用するFabric登録の名前
- subscription-id: string
操作が成功した場合のサブスクリプションのID
- user-id: string
ユーザー名。Basic認証で定義されているユーザーと同じである必要があります。
レスポンス
サポートされるメディア・タイプ
- application/json
200レスポンス
操作の成功
ルート・スキーマ: schema
型:
ソースの表示
object- error(オプション): string
デフォルト値:操作が失敗した場合のエラー・メッセージ
- result(オプション): array result
- returnCode: string
許容値:
[ "Success", "Failure" ]
ネストしたスキーマ: 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" ]サブスクライブするイベント・タイプ
400レスポンス
不正なリクエスト
ルート・スキーマ: Error
型:
objectエラー情報。
ソースの表示
- errors(オプション): array errors
エラーのリスト
- message: string
判読可能なエラー文字列。
- status: string
プログラムによる解析を目的とした、エラーを定義する短いエラー・ステータス。
- warnings(オプション): array warnings
警告のリスト
401レスポンス
未認可
ルート・スキーマ: Error
型:
objectエラー情報。
ソースの表示
- errors(オプション): array errors
エラーのリスト
- message: string
判読可能なエラー文字列。
- status: string
プログラムによる解析を目的とした、エラーを定義する短いエラー・ステータス。
- warnings(オプション): array warnings
警告のリスト
403レスポンス
禁止
404レスポンス
見つかりません
ルート・スキーマ: Error
型:
objectエラー情報。
ソースの表示
- errors(オプション): array errors
エラーのリスト
- message: string
判読可能なエラー文字列。
- status: string
プログラムによる解析を目的とした、エラーを定義する短いエラー・ステータス。
- warnings(オプション): array warnings
警告のリスト
500レスポンス
内部サーバー・エラー
ルート・スキーマ: Error
型:
objectエラー情報。
ソースの表示
- errors(オプション): array errors
エラーのリスト
- message: string
判読可能なエラー文字列。
- status: string
プログラムによる解析を目的とした、エラーを定義する短いエラー・ステータス。
- warnings(オプション): array warnings
警告のリスト
例
このエンドポイントは、指定したチャネルでBlockchainユーザーがサブスクライブしているすべてのイベントのリストを生成するために使用されます。
次の例では、cURLを使用してRESTリソースに対するGETリクエストを発行し、イベント・サブスクリプションのリストを取得する方法を示しています。
curl -v -u <username>:<password> -X GET \ "<restproxy of your Blockchain instance>/api/v2/channels/default/event-subscriptions?role=<role>&user-id=<username>&subscription-id=<subscription ID>&channelId=<channel ID>"
例:
curl -v -u obpuser:<password> -X GET \ "https://myvm.oracle.com:10001/restproxy/api/v2/channels/default/event-subscriptions?role=myinstance_defaultuser&user-id=obpuser&subscription-id=obpuser-dc28b77c-7e58-4b09-ae23-b2c01fa01b70&channelId=default"
ノート:
Blockchainインスタンスのrestproxy値は、インスタンス・コンソールの「ノード」タブから確認できます。レスポンス本文の例
JSON形式のレスポンス本文のコンテンツの例を次に示します。
{
"returnCode": "Success",
"error": "",
"result": {
"subid": "obpuser-b75db132-605a-41a1-86d2-d5be9237c826",
"type": "chaincode",
"callbackURL": "http://10.168.108.17:9000",
"callbackTLSCerts": {},
"expires": "1m",
"expireTime": "2019-08-20T04:33:53+0000",
"txid": "b1c11242383212cfdcca97d68efc0b3641436b1845a9b4c6e822cf6099ca49ee",
"chaincode": "obcs-example02",
"event": ".*",
"seek": "newest",
"block": 0
}
}
説明:
subidは、サブスクリプションIDです。typeは、イベント・タイプを指定します。この例では、chaincodeは、チェーンコードから生成されたイベントが返されることを示しています。callbackURLは、有効なHTTP/HTTPSアドレスであるイベント・コールバック・アドレスを指定します。expiresは、このサブスクリプションが現在のリクエスト時から1か月後に期限切れになることを示します。txidは、トランザクションIDです。chaincodeは、サブスクライブしているチェーンコード・アプリケーションのチェーンコードIDです。eventはチェーンコード・イベント・フィルタです。*は、ユーザーが指定されたチェーンコード内のすべてのイベントにサブスクライブしていることを示します。seekは、配信するブロックを指定します。この例では、newestは、このサブスクリプションが最新のブロックを配信することを示しています。blockは、ブロック番号を示します。