移動

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

請求可能トランザクション数の取得

get

/console/admin/api/v1.1/dashboard/statistics/billableTrans

請求可能トランザクションの数を取得します。

リクエスト

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

• application/json

問合せパラメータ

• channel(オプション): string
  チャネル名
• endTime(オプション): string
  'yyyyMMddhhmmss'形式の時間範囲の終了時間
• nodeID(オプション): string
  特定のピアのノードID
• startTime(オプション): string
  'yyyyMMddhhmmss'形式の時間範囲の開始時間

先頭に戻る

レスポンス

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

• application/json

200レスポンス

制約の結果の一連の請求可能トランザクションを含むレスポンス

本文()

ルート・スキーマ: schema

型: object

ソースの表示

• data(オプション): object StatsBillableTrans

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

ネストしたスキーマ: StatsBillableTrans

型: object

ソースの表示

• billableTrans(オプション): array billableTrans
• nodeId(オプション): string

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

ネストしたスキーマ: billableTrans

型: 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パラメータは、問合せの範囲の設定に使用します。結果は、指定した時間範囲内の指定したスコープの合計数を含むJSONファイルです。

• nodeIDを使用してピアを指定し、チャネルを指定しない場合、すべてのチャネルでのこのピアによる請求可能トランザクションの合計数が返されます。
• channelを使用してチャネルを指定し、ピア・ノードを指定しない場合、すべてのピアによるこのチャネルでの請求可能トランザクションの合計数が返されます。
• ピアとチャネルの両方を指定した場合、指定したチャネルでの指定したピアによる請求可能トランザクションの数が返されます。

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

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

例:

curl -X GET -u [e-mail]:mypswd -k 
"http://server.oracle.com:10000/console/admin/api/v1.1/dashboard/billableTrans?nodeID=peer0-1&channel=tfzch01&startTime=20190224030000&endTime=20190224050000"

レスポンス本文の例

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

{
  "data": {
    "nodeId": "peer0-1",
    "billableTrans": [
      {
        "channelName": "tfzch01",
        "startTime": "Sun, 24 Feb 2019 03:00:00 GMT",
        "endTime": "Sun, 24 Feb 2019 05:00:00 GMT",
        "trans": 2
      }
    ]
  }
}

先頭に戻る