移動

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

現在のチャネルと各チャネルに参加しているピアの取得

get

/console/admin/api/v2/dashboard/statistics/channelInfo

現在存在しているチャネルおよび各チャネルに参加しているピアのリストを取得します。

リクエスト

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

• application/json

問合せパラメータ

• channel: string
  チャネル名

先頭に戻る

レスポンス

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

• application/json

200レスポンス

制約の結果のチャネル情報を含むレスポンス

本文()

ルート・スキーマ: schema

型: object

ソースの表示

• data: array data

{
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/StatsChannelInfo"
            }
        }
    }
}

ネストしたスキーマ: data

型: array

ソースの表示

• 配列: object StatsChannelInfo

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

ネストしたスキーマ: StatsChannelInfo

型: object

ソースの表示

• channelName: string
• peerNum: number
• peers: array peers

{
    "type":"object",
    "properties":{
        "channelName":{
            "type":"string"
        },
        "peerNum":{
            "type":"number"
        },
        "peers":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

ネストしたスキーマ: peers

型: array

ソースの表示

• 配列: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

先頭に戻る

例

このエンドポイントは、現在存在しているチャネルの数およびチャネル名のリストを取得するために使用されます。チャネルごとに、チャネルに参加しているピアが返されます。時間範囲はchannelInfoではサポートされていません。

次の例は、cURLを使用してRESTリソースに対するGETリクエストを送信し、チャネル情報のレポートを生成する方法を示しています。

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

たとえば、

curl -X GET -u [e-mail]:mypswd -k 
"http://server.oracle.com:10000/console/admin/api/v2/dashboard/statistics/channelInfo?channel=default"

レスポンス本文の例

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

{
  "data": [
    {
      "channelName": "default",
      "peerNum": 4,
      "peers": [
        "peer0",
        "peer1",
        "peer2"
      ]
    }
  ]
}

先頭に戻る