移動

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

ブロック数の取得

get

/console/admin/api/v2/dashboard/statistics/blocks

このエンドポイントは、指定した時間範囲内の指定したチャネルまたはすべてのチャネルのブロック数を取得するために使用されます。

リクエスト

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

• application/json

問合せパラメータ

• channel: string
  チャネル名
• endTime: string
  'yyyyMMddhhmmss'形式の時間範囲の終了時間
• startTime: string
  'yyyyMMddhhmmss'形式の時間範囲の開始時間

先頭に戻る

レスポンス

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

• application/json

200レスポンス

制約の結果の一連のブロックを含むレスポンス

本文()

ルート・スキーマ: schema

型: object

ソースの表示

• data: object StatsBlocks

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

ネストしたスキーマ: StatsBlocks

型: object

ソースの表示

• blocks: array blocks

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

ネストしたスキーマ: blocks

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

先頭に戻る

例

このエンドポイントは、指定した時間範囲内の指定したチャネルまたはすべてのチャネルでのコミット数を取得するために使用されます。結果は、指定した時間範囲内の指定したスコープの合計数を含むJSONファイルです。このAPIは、ファウンダ・インスタンスにのみ適用できます。

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

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

たとえば、

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

レスポンス本文の例

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

{
  "data": {
    "blocks": [
      {
        "channelName": "tfzch01",
        "startTime": "Sun, 24 Feb 2021 03:00:00 GMT",
        "endTime": "Sun, 24 Feb 2021 05:00:00 GMT",
        "trans": 2
      }
    ]
  }
}

先頭に戻る