Jump to

• Request
• Response
• Examples

Get Current Channels and Peers Joined on Each Channel

get

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

Gets a list of the currently existing channels and the peers joined on each channel.

Request

Supported Media Types

• application/json

Query Parameters

• channel(optional): string
  Channel name

Back to Top

Response

Supported Media Types

• application/json

200 Response

Response with channel infos by restriction

Body ()

Root Schema : schema

Type: object

Show Source

• data(optional): array data

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

Nested Schema : data

Type: array

Show Source

• Array of: object StatsChannelInfo

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

Nested Schema : StatsChannelInfo

Type: object

Show Source

• channelName(optional): string
• peerNum(optional): number
• peers(optional): array peers

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

Nested Schema : peers

Type: array

Show Source

• Array of: string

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

400 Response

Invalid arguments

Body ()

Root Schema : 400errorModels

Type: object

Show Source

• key(optional): string
• value(optional): string

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

Example:

{
    "respMesg":"invalid argument"
}

Default Response

Unexpected error

Body ()

Root Schema : errorModel

Type: object

Show Source

• code: integer(int32)
• message: string

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

Back to Top

Examples

This endpoint is used to get the number of currently existing channels and the list of channel names. For each channel the peers joined on the channel are returned. Time range is not supported for channelInfo.

The following example shows how to generate the channel information report by submitting a GET request on the REST resource using cURL.

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

For example,

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

Example of the Response Body

The following example shows the contents of the response body in JSON format:

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

Back to Top