移動

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

ピア、チャネルまたはネットワークのユーザー・トランザクション数の取得

get

/console/admin/api/v2/dashboard/statistics/userTrans

ピア、チャネルまたはネットワーク全体のユーザー・トランザクションの数を取得します。同じリクエストでノードとネットワークを問い合せることはできません。

リクエスト

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

• application/json

問合せパラメータ

• channel: string
  チャネル名
• endTime: string
  'yyyyMMddhhmmss'形式の時間範囲の終了時間
• nodeID: string
  特定のピアのノードIDこれはオーダラと同時にリクエストできません。
• orderer: string
  値はYまたはNで、オーダラがネットワーク全体について収集したメトリックを返す必要があるのか、ファウンダについてのみかを示しますこれはノードと同時にリクエストできません。
• startTime: string
  'yyyyMMddhhmmss'形式の時間範囲の開始時間

先頭に戻る

レスポンス

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

• application/json

200レスポンス

制約の結果の一連のユーザー・トランザクションを含むレスポンス

本文()

ルート・スキーマ: schema

型: object

ソースの表示

• data: object StatsUserTrans

{
    "type":"object",
    "properties":{
        "data":{
            "$ref":"#/definitions/StatsUserTrans"
        }
    }
}

ネストしたスキーマ: StatsUserTrans

型: object

ソースの表示

• nodeId: string
• orderer: string
• userTrans: array userTrans

{
    "type":"object",
    "properties":{
        "nodeId":{
            "type":"string"
        },
        "orderer":{
            "type":"string"
        },
        "userTrans":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/StatsTransInfo"
            }
        }
    }
}

ネストしたスキーマ: userTrans

型: array

ソースの表示

• 配列: object StatsTransInfo

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

ネストしたスキーマ: StatsTransInfo

型: object

ソースの表示

• channelName: string
• endTime: string
• startTime: string
• trans: number

{
    "type":"object",
    "properties":{
        "channelName":{
            "type":"string"
        },
        "startTime":{
            "type":"string"
        },
        "endTime":{
            "type":"string"
        },
        "trans":{
            "type":"number"
        }
    }
}

400レスポンス

無効な引数

本文()

ルート・スキーマ: 400errorModels

型: object

ソースの表示

• key: string
• value: string

{
    "type":"object",
    "properties":{
        "key":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    },
    "example":{
        "respMesg":"invalid argument"
    }
}

例:

{
    "respMesg":"invalid argument"
}

デフォルト・レスポンス

予期しないエラー

本文()

ルート・スキーマ: errorModel

型: object

ソースの表示

• code(必須): integer(int32)
• message(必須): string

{
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"integer",
            "format":"int32"
        },
        "message":{
            "type":"string"
        }
    }
}

先頭に戻る

例

このエンドポイントは、ピア、チャネルまたはネットワーク全体のユーザー・トランザクションの数を取得するために使用されます。パラメータnodeID、channelおよびordererは、その動作に影響します。結果は、指定した時間範囲内の指定したスコープのユーザー・トランザクションの合計数を含むJSONファイルです。

• nodeIDを使用してピアを指定し、channelを指定しない場合、すべてのチャネルでのこのピアの合計数が返されます。
• channelを使用してチャネルを指定し、nodeIDを指定しない場合、すべてのピアのこのチャネルの合計数が返されます。
• nodeIDとchannelの両方を指定した場合、結果は、指定したチャネル上の指定したピアに関するものです。
• ordererをYに設定し、nodeIDを指定しない場合、参加者組織を含むネットワーク全体のトランザクションの合計数が返されます。
• ordererパラメータとpeerパラメータは、同時に指定できません。

次の例は、cURLを使用してRESTリソースに対するGETリクエストを送信し、ユーザー・トランザクションのメトリックを生成する方法を示しています。

curl -X GET -u username:password -k 
"http://<rest_server_url>:port/console/admin/api/v2/dashboard/statistics/userTrans?nodeID=<nodeID>&channel=<channel>&startTime=<yyyymmddhhmmss>&endTime=<yyyymmddhhmmss>"

たとえば、

curl -X GET -u [e-mail]:mypswd -k 
"http://server.oracle.com:10000/console/admin/api/v2/dashboard/userTrans?nodeID=peer1&channel=tfzch01&startTime=20210224030000&endTime=20210224050000"

レスポンス本文の例

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

{
  "data": {
    "nodeId": "peer1",
    "userTrans": [
      {
        "channelName": "tfzch01",
        "startTime": "Sun, 24 Feb 2021 03:00:00 GMT",
        "endTime": "Sun, 24 Feb 2021 05:00:00 GMT",
        "trans": 1
      }
    ]
  }
}

先頭に戻る