移動

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

指定したピアが参加しているチャネルの現在の数とリストの取得

get

/console/admin/api/v2/dashboard/statistics/channelsJoined

このエンドポイントは、nodeIDを使用してピアを指定した場合は指定したピアが、指定しない場合はすべてのピアが参加しているチャネルの現在の数とリストを取得するために使用されます。

リクエスト

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

• application/json

問合せパラメータ

• nodeID: string
  特定のピアのノードID

先頭に戻る

レスポンス

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

• application/json

200レスポンス

制約の結果の各ピアのチャネルの合計数と名前のリストを含むレスポンス

本文()

ルート・スキーマ: schema

型: object

ソースの表示

• data: array data

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

ネストしたスキーマ: data

型: array

ソースの表示

• 配列: object StatsChannelsJoined

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

ネストしたスキーマ: StatsChannelsJoined

型: object

ソースの表示

• channelNum: number
• channels: array channels
• nodeID: string

{
    "type":"object",
    "properties":{
        "nodeID":{
            "type":"string"
        },
        "channelNum":{
            "type":"number"
        },
        "channels":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

ネストしたスキーマ: channels

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

先頭に戻る

例

このエンドポイントは、nodeIDを使用してピアを指定した場合は指定したピアが、指定しない場合はすべてのピアが参加しているチャネルの現在の数とリストを取得するために使用されます。結果には、各ピアのチャネルの合計数と名前のリストが含まれます。時間範囲はchannelsJoinedではサポートされていません。

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

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

たとえば、

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

レスポンス本文の例

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

{
  "data": [
    {
      "nodeID": "peer1",
      "channelNum": 4,
      "channels": [
        "tfzch01",
        "default",
        "mych01",
        "test"
      ]
    }
  ]
} 

先頭に戻る