移動

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

イベントからのサブスクライブ解除

delete

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

イベントからサブスクライブ解除します。

リクエスト

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

• application/json

パス・パラメータ

• channelName(必須): string
  チャネルのID

問合せパラメータ

• role: string
  使用するHyperledger Fabric登録の名前
• subscription-id: string
  操作が成功した場合のサブスクリプションのID
• user-id: string
  ユーザー名。Basic認証で定義されているユーザーと同じである必要があります。

先頭に戻る

レスポンス

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

• application/json

200レスポンス

操作の成功

本文()

ルート・スキーマ: schema

型: object

ソースの表示

• error: string
• result: array result
• returnCode(必須): string
  許容値: [ "Success", "Failure" ]

{
    "type":"object",
    "required":[
        "returnCode"
    ],
    "properties":{
        "returnCode":{
            "$ref":"#/definitions/returnCode"
        },
        "error":{
            "type":"string"
        },
        "result":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UnEventSubscription"
            }
        }
    }
}

ネストしたスキーマ: result

型: array

ソースの表示

• 配列: object UnEventSubscription

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/UnEventSubscription"
    }
}

ネストしたスキーマ: UnEventSubscription

型: object

ソースの表示

• errorMessage: string
• status: string
• subid(必須): string
  成功時のサブスクリプションのID

{
    "type":"object",
    "required":[
        "subid"
    ],
    "properties":{
        "subid":{
            "description":"ID of the subscription when successful",
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        }
    }
}

400レスポンス

不正なリクエスト

401レスポンス

未認可

403レスポンス

禁止されています

404レスポンス

無効なパラメータ

500レスポンス

サービス使用不可

先頭に戻る

例

このエンドポイントは、イベントからサブスクライブ解除するために使用されます。

次の例は、cURLを使用してRESTリソースに対するDELETEリクエストを発行し、イベントからサブスクライブ解除する方法を示しています。

curl -v -u <username>:<password> -X DELETE \
  '<restproxy of your blockchain instance>/api/v2/channels/<channelName>/event-subscriptions?role=<role>&user-id=<username>&subscription-id=<subscription ID>&channelName=<channel_name>'

たとえば、

curl -v -u obpuser:<password> -X DELETE \
  'https://myvm.oracle.com:10000/restproxy/api/v2/channels/default/event-subscriptions?role=myinstance_defaultuser&user-id=user1&subscription-id=testuser1-dc28b77c-7e58-4b09-ae23-b2c01fa01b70&channelId=default'

ノート:

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

レスポンス本文の例

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

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

先頭に戻る