Jump to

• Request
• Response
• Examples

Get the Number of Synchronous Invocations

get

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

Get the total number of synchronous invocations.

Request

Supported Media Types

• application/json

Query Parameters

• endTime(optional): string
  The end time of a time range in the format 'yyyyMMddhhmmss'
• nodeID(optional): string
  Node ID of a specific proxy
• startTime(optional): string
  The start time of a time range in the format 'yyyyMMddhhmmss'

Back to Top

Response

Supported Media Types

• application/json

200 Response

Response with a series of synchronous invocations by restriction

Body ()

Root Schema : schema

Type: object

Show Source

• data(optional): array data

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

Nested Schema : data

Type: array

Show Source

• Array of: object StatsProxySyncInvocation

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

Nested Schema : StatsProxySyncInvocation

Type: object

Show Source

• asyncInvocation(optional): number
• endTime(optional): string
• nodeID(optional): string
• startTime(optional): string

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

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 synchronous 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 synchronous invocations for the specified scope in the specified time range.

The following example shows how to generate the synchronous 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/v1.1/dashboard/statistics/proxySyncInvocation?nodeID=<nodeID>&startTime=<yyyymmddhhmmss>&endTime=yyyymmddhhmmss"

For example,

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

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 2019 03:00:00 GMT",
        "endTime": "Sun, 24 Feb 2019 05:00:00 GMT",
        "syncInvocation": 1
      }
    ]
  }
}

Back to Top