Displaying the properties that relate to resource statistics collection by using the administration REST API

You can use the IBM® App Connect Enterprise administration REST API to display the properties that relate to resource statistics collection on an integration server.

Before you begin

Read the following topics:

Procedure

Use one of the following REST API methods to query the resource statistics properties of an integration server.

  • For an independent integration server:
    GET http://hostname:port/apiv2/statistics/resource-stats

    For example, use the following curl command:

    curl -X GET http://hostname:port/apiv2/statistics/resource-stats
    If the command is successful, an HTTP status code 200 and a response similar to the following are returned:
    {
      "hasChildren": false,
      "name": "resource-stats",
      "type": "resourceStats",
      "uri": "/apiv2/statistics/resource-stats",
      "properties": {
        "name": "Resource",
        "outputFormat": "inherit",
        "reportingOn": true,
        "type": "Resource"
      },
      "descriptiveProperties": {},
      "active": {
        "reportingOn": true
      },
      "actions": {
        "unavailable": {
          "start-collection": "/apiv2/statistics/resource-stats/start-collection"
        },
        "available": {
          "stop-collection": "/apiv2/statistics/resource-stats/stop-collection"
        }
      },
      "children": {},
      "links": []
    }
    
  • For an integration server that is managed by an integration node:
    GET http://hostname:port/apiv2/servers/integrationServerName/statistics/resource-stats

    For example, to display the resource statistics properties on integration server ACESERV1, which is managed by an integration node, use the following curl command:

    curl -X GET http://hostname:port/apiv2/servers/ACESERV1/statistics/resource-stats
    If the command is successful, an HTTP status code 200 and a response similar to the following are returned.:
    {
      "hasChildren": false,
      "name": "resource-stats",
      "type": "resourceStats",
      "uri": "/apiv2/servers/ACESERV1/statistics/resource-stats",
      "properties": {
        "name": "Resource",
        "outputFormat": "inherit",
        "reportingOn": true,
        "type": "Resource"
      },
      "descriptiveProperties": {},
      "active": {
        "reportingOn": true
      },
      "actions": {
        "unavailable": {
          "start-collection": "/apiv2/servers/ACESERV1/statistics/resource-stats/start-collection"
        },
        "available": {
          "stop-collection": "/apiv2/servers/ACESERV1/statistics/resource-stats/stop-collection"
        }
      },
      "children": {},
      "links": []
    }