Jump to

• Request
• Response
• Examples

Get the List of Configured Chaincodes (Deprecated in 20.3.1)

get

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

Get the list of configured chaincodes for a specified proxy or for all proxies.

Request

Supported Media Types

• application/json

Query Parameters

• nodeID(optional): string
  Node ID of a specific proxy

Back to Top

Response

Supported Media Types

• application/json

200 Response

Response with the configured chaincode by restriction

Body ()

Root Schema : schema

Type: object

Show Source

• data(optional): array data

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

Nested Schema : data

Type: array

Show Source

• Array of: object StatsProxyConfiguredCC

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

Nested Schema : StatsProxyConfiguredCC

Type: object

Show Source

• configuredCC(optional): array configuredCC
• configuredCCNum(optional): number
• nodeID(optional): string

{
    "type":"object",
    "properties":{
        "nodeID":{
            "type":"string"
        },
        "configuredCCNum":{
            "type":"number"
        },
        "configuredCC":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/StatsConfiguredCC"
            }
        }
    }
}

Nested Schema : configuredCC

Type: array

Show Source

• Array of: object StatsConfiguredCC

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

Nested Schema : StatsConfiguredCC

Type: object

Show Source

• chaincode(optional): string
• channelName(optional): string
• endorsers(optional): array endorsers

{
    "type":"object",
    "properties":{
        "channelName":{
            "type":"string"
        },
        "chaincode":{
            "type":"string"
        },
        "endorsers":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : endorsers

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 current number of configured chaincodes for the specified proxy if using nodeID, or for all proxies if the node is not specified. The result contains a total number and a list of chaincode names for each proxy in the specified scope. Time range parameters are not applicable.

The following example shows how to generate the configured chaincodes metrics 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/v1.1/dashboard/statistics/proxyConfiguredCC?nodeID=<nodeID>"

For example,

curl -X GET -u [e-mail]:mypswd -k 
"http://server.oracle.com:10000/console/admin/api/v1.1/dashboard/proxyConfiguredCC?nodeID=restproxy1"

Example of the Response Body

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

{
  "data": [
    {
      "nodeID": "restproxy1",
      "configuredCCNum": 4,
      "configuredCC": [
        {
          "channel": "test",
          "chaincode": "obcs-example02",

          "endorsers": [

             "peer0-1",

             "peer0-2"

          ]
        },
        {
          "channel": "tfzch01",
          "chaincode": "tfzcc01",

          "endorsers": [

             "peer0-1"

          ]

        },
        {
          "channel": "tfzch02",
          "chaincode": "tfzcc02",

          "endorsers": [

             "peer0-1",

             "peer0-2"

          ]

        }
      ]
    }
  ]
}

Back to Top