Jump to

• Request
• Response
• Examples

Get the Current Number of Instantiated Chaincodes on the Specified Channel

get

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

Get the current number of instantiated chaincodes on the specified 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 the total number and a list of chaincode names for each channel by restriction

Body ()

Root Schema : schema

Type: object

Show Source

• data(optional): array data

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

Nested Schema : data

Type: array

Show Source

• Array of: object StatsChaincodeInstantiated

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

Nested Schema : StatsChaincodeInstantiated

Type: object

Show Source

• chaincodeNum(optional): number
• chaincodes(optional): array chaincodes
• channelName(optional): string

{
    "type":"object",
    "properties":{
        "channelName":{
            "type":"string"
        },
        "chaincodeNum":{
            "type":"number"
        },
        "chaincodes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/StatsChaincodeInfo"
            }
        }
    }
}

Nested Schema : chaincodes

Type: array

Show Source

• Array of: object StatsChaincodeInfo

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

Nested Schema : StatsChaincodeInfo

Type: object

Show Source

• ccName(optional): string
• ccVersion(optional): string

{
    "type":"object",
    "properties":{
        "ccName":{
            "type":"string"
        },
        "ccVersion":{
            "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 and list of instantiated chaincodes on the specified channel if a channel is specified, or on all channels if not. The result contains a total number and a list of chaincode names for each channel. Time range is not supported for chaincodeInstantiated.

The following example shows how to generate the chaincode 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/v1.1/dashboard/statistics/chaincodeInstantiated?channel=<channel>"

For example,

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

Example of the Response Body

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

{
  "data": [
    {
      "channelName": "tfzch01",
      "chaincodeNum": 1,
      "chaincodes": [
        {
          "ccName": "tfzcc01",
          "ccVersion": "v1"
        }
      ]
    }
  ]
}

Back to Top