Jump to

• Request
• Response

Update Reporter Information of a Member

post

/management/coherence/cluster/reporters/{memberIdentifier}

Use this endpoint to update the configuration parameters for a reporter member.

Request

Path Parameters

• memberIdentifier: string
  An identifier of the member, it can either be the name or the nodeId of the member.

Body ()

Root Schema : reporter

Type: object

Show Source

• autoStart(optional): boolean
  Read Only: true

  True when the Reporter starts automatically with the node.
• configFile(optional): string
  The configuration file for the Reporter.
• currentBatch(optional): number(int64)
  The batch identifier for the Reporter.
• intervalSeconds(optional): number(int64)
  The interval between executions in seconds.
• lastExecuteTime(optional): string(date-time)
  Read Only: true

  The last time a report batch was executed.
• lastReport(optional): string
  Read Only: true

  The last report to execute.
• location(optional): string
  Read Only: true

  The location of the MBean server
• member(optional): string
  Name of the cluster member
• nodeId(optional): integer(int64)
  Read Only: true

  The ID of member to which the MBean belongs
• outputPath(optional): string
  The path where report output will be located.
• reports(optional): array reports
  Read Only: true

  The list of reports executed.
• runAverageMillis(optional): number(double)
  Read Only: true

  The average batch runtime in milliseconds since the statistics were last reset.
• runLastMillis(optional): integer(int64)
  Read Only: true

  The last batch runtime in milliseconds since the statistics were last reset..
• runMaxMillis(optional): integer(int64)
  Read Only: true

  The maximum batch runtime in milliseconds since the statistics were last reset.
• state(optional): string
  The state of the Reporter. Valid values are: Running (reports are being executed); Sleeping (reporter is sleeping between report invocations); Waiting (the reporter is waiting for the interval to complete); Starting (the reporter is being started); Stopping (the reporter is attempting to stop execution and waiting for running reports to complete); Stopped (the reporter is stopped).
• type(optional): string
  Read Only: true

  Allowed Values: [ "Node" ]

  The type of the MBean

{
    "type":"object",
    "properties":{
        "nodeId":{
            "type":"integer",
            "format":"int64",
            "description":"The ID of member to which the MBean belongs",
            "readOnly":true
        },
        "location":{
            "type":"string",
            "description":"The location of the MBean server",
            "readOnly":true
        },
        "type":{
            "type":"string",
            "description":"The type of the MBean",
            "enum":[
                "Node"
            ],
            "readOnly":true
        },
        "member":{
            "type":"string",
            "description":"Name of the cluster member"
        },
        "autoStart":{
            "type":"boolean",
            "description":"True when the Reporter starts automatically with the node.",
            "readOnly":true
        },
        "configFile":{
            "type":"string",
            "description":"The configuration file for the Reporter.",
            "readOnly":false
        },
        "currentBatch":{
            "type":"number",
            "format":"int64",
            "description":"The batch identifier for the Reporter.",
            "readOnly":false
        },
        "intervalSeconds":{
            "type":"number",
            "format":"int64",
            "description":"The interval between executions in seconds.",
            "readOnly":false
        },
        "lastExecuteTime":{
            "type":"string",
            "format":"date-time",
            "description":"The last time a report batch was executed.",
            "readOnly":true
        },
        "lastReport":{
            "type":"string",
            "description":"The last report to execute.",
            "readOnly":true
        },
        "outputPath":{
            "type":"string",
            "description":"The path where report output will be located.",
            "readOnly":false
        },
        "reports":{
            "type":"array",
            "description":"The list of reports executed.",
            "items":{
                "type":"string"
            },
            "readOnly":true
        },
        "runAverageMillis":{
            "type":"number",
            "format":"double",
            "description":"The average batch runtime in milliseconds since the statistics were last reset.",
            "readOnly":true
        },
        "runLastMillis":{
            "type":"integer",
            "format":"int64",
            "description":"The last batch runtime in milliseconds since the statistics were last reset..",
            "readOnly":true
        },
        "runMaxMillis":{
            "type":"integer",
            "format":"int64",
            "description":"The maximum batch runtime in milliseconds since the statistics were last reset.",
            "readOnly":true
        },
        "state":{
            "type":"string",
            "description":"The state of the Reporter. Valid values are:\n\nRunning (reports are being executed);\nSleeping (reporter is sleeping between report invocations);\nWaiting (the reporter is waiting for the interval to complete);\nStarting (the reporter is being started);\nStopping (the reporter is attempting to stop execution and waiting for running reports to complete);\nStopped (the reporter is stopped).",
            "readOnly":false
        }
    }
}

Nested Schema : reports

Type: array

Read Only: true

The list of reports executed.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The list of reports executed.",
    "items":{
        "type":"string"
    },
    "readOnly":true
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

A successful request that updates the reporter parameters for a member

Back to Top