REST API for Oracle Blockchain Platform Enterprise Edition

Get the Number of Asynchronous Invocations

get

/console/admin/api/v2/dashboard/statistics/proxyAsyncInvocation

This endpoint is used to get the number of asynchronous invocations on the specified proxy if you specify nodeID, or on all proxies if not specified.

Request

Supported Media Types

application/json

Query Parameters

endTime: string

The end time of a time range in the format 'yyyyMMddhhmmss'
nodeID: string

Node ID of a specific proxy
startTime: string

The start time of a time range in the format 'yyyyMMddhhmmss'

Response

Supported Media Types

application/json

200 Response

Response with a series of asynchronous invocations by restriction

Root Schema : schema

Type: object

Show Source

data: array data

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

Nested Schema : data

Type: array

Show Source

Array of: object StatsProxyAsyncInvocation

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

Nested Schema : StatsProxyAsyncInvocation

Type: object

Show Source

asyncInvocation: number
endTime: string
nodeID: string
startTime: string

{
    "type":"object",
    "properties":{
        "nodeID":{
            "type":"string"
        },
        "startTime":{
            "type":"string"
        },
        "endTime":{
            "type":"string"
        },
        "asyncInvocation":{
            "type":"number"
        }
    }
}

400 Response

Invalid arguments

Root Schema : 400errorModels

Type: object

Show Source

key: string
value: string

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

Example:

{
    "respMesg":"invalid argument"
}

Default Response

Unexpected error

Root Schema : errorModel

Type: object

Show Source

code(required): integer(int32)
message(required): string

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

Examples

This endpoint is used to get the number of asynchronous invocations on the specified proxy if you specify nodeID, or on all proxies if not specified. The result is a JSON file including the total number of asynchronous invocations for the specified scope in the specified time range.

The following example shows how to generate the asynchronous invocation 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/v2/dashboard/statistics/proxyAsyncInvocation?nodeID=<nodeID>&startTime=<yyyymmddhhmmss>&endTime=<yyyymmddhhmmss>"

For example,

curl -X GET -u myname@oracle.com:mypswd -k 
"http://server.oracle.com:10000/console/admin/api/v2/dashboard/proxyAsyncInvocation?nodeID=restproxy1&startTime=20210224030000&endTime=20210224050000"

Example of the Response Body

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

{
  "data": [
      {
        "nodeID": "restproxy1",
        "startTime": "Sun, 24 Feb 2021 03:00:00 GMT",
        "endTime": "Sun, 24 Feb 2021 05:00:00 GMT",
        "asyncInvocation": 1
      }
    ]
  }
}