IBM DataPower Operations Dashboard v1.0.22.x

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

In this page:

POST Retrieve All Probe Captures

 /op/api/v2/probeCaptures/search

Description:

This API retrieves all probe captures.

Required Roles:

  • There shouldn’t be defined a custom role that denies access to “Manage Probe“ and there is a custom role that permits access or a built-in role OpDashAdminRole.

URI:

/op/api/v2/probeCaptures/search

Request:

The request should use the POST method with the following fields in its body:

Name

Required/Optional

Description

Type

Available Options

filters

Optional

Filter a set of search results. For further details see Search Request.

Element

filters[].filterfield

Specifies the filter field name.

String

  • DPOD_DEVICE_NAME

  • DPOD_DOMAIN_NAME

  • DPOD_SERVICE_NAME

  • DPOD_API_PROBE_CAPTURE_ID

  • DPOD_API_PROBE_CAPTURE_STATUS

filters[filterfield=DPOD_API_PROBE_CAPTURE_STATUS].stringValues

The maximum number of records to allow.

String

  • ACTIVE

  • STOPPING

  • COMPLETED

  • ABORTED

pagingDto

Required

Navigate between a set of search results. For further details see Search Request.

Element

Example:

{
  "pagingDto": {
    "pagingMinRecordNum": 1,
    "pagingMaxRecordNum": 100
  },
  "filters": [
    {
      "filterField": "DPOD_DEVICE_NAME",
      "filterOperator": "EQUALS",
      "stringValues": [
        "idg_10_6_0_a"
      ]
    },
    {
      "filterField": "DPOD_DOMAIN_NAME",
      "filterOperator": "EQUALS",
      "stringValues": [
        "BankA_Domain"
      ]
    },
    {
      "filterField": "DPOD_SERVICE_NAME",
      "filterOperator": "EQUALS",
      "stringValues": [
        "YellowPagesService.WSP"
      ]
    },
    {
      "filterField": "DPOD_API_PROBE_CAPTURE_ID",
      "filterOperator": "EQUALS",
      "stringValues": [
        "f5940035-9c29-4e25-8b96-0fe76ecc947c"
      ]
    },
    {
      "filterField": "DPOD_API_PROBE_CAPTURE_STATUS",
      "filterOperator": "EQUALS",
      "stringValues": [
        "ACTIVE"
      ]
    }
  ]
}

Successful Response:

The response includes the following fields in its body:

Name

Description

Type

Available Options

totalResultsCount

The total number of records.

Long

results

Array of Element

results[].id

The id of the record in the Database.

Long

results[].captureId

The id for a transaction probe capture.

String

results[].deviceName

The device name from which the debug probe data was captured.

String

results[].domainName

The domain name from which the debug probe data was captured.

String

results[].serviceName

The service name from which the debug probe data was captured.

String

results[].captureCount

The number of transactions to capture.

Long

results[].capturedTransactions

The number of captured transactions.

Long

results[].userName

The user name who created the capture.

String

results[].startTimeInMill

When the capture started.

Long

results[].endTimeInMill

When the capture finished.

Long

results[].captureStatus

The capture status.

String

  • ACTIVE

  • STOPPING

  • COMPLETED

  • ABORTED

Example:

{
    "resultCode": "SUCCESS",
    "resultMessage": "Probe captures retrieved successfully",
    "result": {
        "totalResultsCount": 1,
        "results": [
            {
                "id": 151,
                "captureId": "f5940035-9c29-4e25-8b96-0fe76ecc947c",
                "deviceName": "idg_10_6_0_a",
                "domainName": "BankA_Domain",
                "serviceName": "YellowPagesService.WSP",
                "captureCount": 10,
                "capturedTransactions": 10,
                "userName": "admin",
                "startTimeInMill": 1727249223659,
                "endTimeInMill": 1727249593870,
                "captureStatus": "COMPLETED"
            }
        ]
    }
}

GET Get Specific Probe Capture Details

 /op/api/v2/probeCapture/{{probeCaptureId}}

Description:

This API retrieves a specific probe capture.

Required Roles:

  • There shouldn’t be defined a custom role that denies access to “Manage Probe“ and there is a custom role that permits access or a built-in role OpDashAdminRole.

URI:

/op/api/v2/probeCapture/{{probeCaptureId}}

Request:

The request should use the GET method with the following URL parameters:

Name

Required/Optional

Description

Type

Available Options

probeCaptureId

Required

The probe capture id (can be retrieved from “Retrieved all probe captures” response)

Element

Successful Response:

The response includes the following fields in its body:

Name

Description

Type

Available Options

id

The id of the record in the Database.

Long

captureId

The id for a transaction probe capture.

String

deviceName

The device name from which the debug probe data was captured.

String

domainName

The domain name from which the debug probe data was captured.

String

serviceName

The service name from which the debug probe data was captured.

String

captureCount

The number of transactions to capture.

Long

capturedTransactions

The number of captured transactions.

Long

userName

The user name who created the capture.

String

startTimeInMill

When the capture started.

Long

endTimeInMill

When the capture finished.

Long

captureStatus

The capture status.

String

  • ACTIVE

  • STOPPING

  • COMPLETED

  • ABORTED

Example:

{
    "resultCode": "SUCCESS",
    "resultMessage": "Probe capture retrieved successfully",
    "result": {
        "id": 151,
        "captureId": "f5940035-9c29-4e25-8b96-0fe76ecc947c",
        "deviceName": "idg_10_6_0_a",
        "domainName": "BankA_Domain",
        "serviceName": "YellowPagesService.WSP",
        "captureCount": 10,
        "capturedTransactions": 10,
        "userName": "admin",
        "startTimeInMill": 1727249223659,
        "endTimeInMill": 1727249593870,
        "captureStatus": "COMPLETED"
    }
}

POST Add Probe Capture

 /op/api/v2/ProbeCaptures/

Description:

This API retrieves all probe captures.

Required Roles:

  • There shouldn’t be defined a custom role that denies access to “Manage Probe“ and there is a custom role that permits access or a built-in role OpDashAdminRole.

URI:

/op/api/v2/probeCaptures/

Request:

The request should use the POST method with the following fields in its body:

Name

Required/Optional

Description

Type

Available Options

deviceNames

Required

The device names on which to create a probe capture.

Array of String

Supports wildcards

deviceNamesOperator

Required

The device names operator.

String

  • eq

domainNames

Required

The domain names on which to create a probe capture.

Array of String

Supports wildcards

domainNamesOperator

Required

The domain names operator.

String

  • eq

serviceNames

Required

The service names on which to create a probe capture.

Array of String

Supports wildcards

serviceNameOperator

Required

The service names operator.

Array of String

  • eq

durationInMinutes

Required

the duration in minutes to capture.

Long

Positive number

captureCount

Required

The number of transactions to capture.

Long

Number between 10 - 200

interval

Optional

The interval in seconds between which the data for two consecutive transactions can be captured.

Long

Number between 1 - 3600

additionalFiltersParameters

Optional

Probe Filters.

Element

additionalFiltersParameters.httpHeaderName

Optional

Filter transactions by the HTTP header name.

String

additionalFiltersParameters.clientInUri

Optional

Filter transactions by the client IP address.

String

additionalFiltersParameters.clientIp

Optional

Filter transactions by the request URI path.

String

Example:

{
    "deviceNames": ["idg_10_6_0_a"],
    "deviceNamesOperator": "eq",
    "domainNames": ["BankA_Domain"],
    "domainNamesOperator": "eq",
    "serviceNames": ["YellowPagesService.WSP"],
    "serviceNameOperator": "eq",
    "durationInMinutes": 60,
    "captureCount": 15,
    "interval": 1,
    "additionalFiltersParameters": {
        "httpHeaderName": "",
        "clientInUri": "",
        "clientIp": ""
    }
}

Successful Response:

The response includes the following fields in its body:

Name

Description

Type

Available Options

probeCaptures

Array of Element

probeCaptures.id

The id of the record in the Database.

Long

probeCaptures.captureId

The id for a transaction probe capture.

String

probeCaptures.deviceName

The device name from which the debug probe data was captured.

String

probeCaptures.domainName

The domain name from which the debug probe data was captured.

String

probeCaptures.serviceName

The service name from which the debug probe data was captured.

String

probeCaptures.captureCount

The number of transactions to capture.

Long

probeCaptures.capturedTransactions

The number of captured transactions.

Long

probeCaptures.userName

The user name who created the capture.

String

probeCaptures.startTimeInMill

When the capture started.

Long

probeCaptures.captureStatus

The capture status.

String

  • ACTIVE

  • STOPPING

  • COMPLETED

  • ABORTED

probeCaptures.resultCode

The REST API result code.

String

  • SUCCESS

  • WARNING

  • ERROR

probeCaptures.resultMessage

The REST API result message.

String

Example:

{
    "resultCode": "SUCCESS",
    "resultMessage": "All probe captures created successfully",
    "result": {
        "probeCaptures": [
            {
                "id": 155,
                "captureId": "7a8c48a8-bc1c-4459-9a77-0fe76ecca35b",
                "deviceName": "idg_10_6_0_a",
                "domainName": "BankA_Domain",
                "serviceName": "YellowPagesService.WSP",
                "captureCount": 15,
                "capturedTransactions": 0,
                "userName": "admin",
                "startTimeInMill": 1727262911381,
                "captureStatus": "ACTIVE",
                "resultCode": "SUCCESS",
                "resultMessage": "Probe capture created successfully"
            }
        ]
    }
}

DELETE Delete Probe Capture

 /op/api/v2/probeCapture/{{apiProbeCaptureId}}

Description:

This API deletes a specific probe capture.

Required Roles:

  • There shouldn’t be defined a custom role that denies access to “Manage Probe“ and there is a custom role that permits access or a built-in role OpDashAdminRole.

URI:

/op/api/v2/probeCapture/{{probeCaptureId}}

Request:

The request should use the DELETE method with the following URL parameters:

Name

Required/Optional

Description

Type

Available Options

probeCaptureId

Required

The probe capture id (can be retrieved from “Retrieved all probe captures” response)

Element

Successful Response:

Example:

{
    "resultCode": "SUCCESS",
    "resultMessage": "Probe capture is stopping"
}
  • No labels

Copyright © 2015 MonTier Software (2015) Ltd.