IBM DataPower Operations Dashboard v1.0.20.x

A newer version of this product documentation is available.

You are viewing an older version. View latest at IBM DPOD Documentation.

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

Version 1 Current »

Available API-C Probe capture actions via APIs

Get / Create / Delete / Force Delete API-C probe captures

Authorization:

Authentication: Basic authentication

Roles: it is recommended to read Role Based Access Control page for understanding build-in and custom roles permissions.

From CLI (example):

curl -u username:password https://<dpod hostname>/op/api/v2/apiProbeCaptures

GET Retrieve All API-C Probe Captures

 /op/api/v2/apiProbeCaptures/

URL:

GET - https://{{dpodHostname}}/op/api/v2/apiProbeCaptures/

Authorization:

Required Permissions

More info

  1. Access permissions for API-C product view

  2. Access permissions for API probe capture

  3. Access permissions for investigate

See roles information here: Role Based Access Control

Response:

Response Type

Example value

Description

Successful

{
    "resultCode": "SUCCESS",
    "resultMessage": "API probe captures retrieved successfully",
    "result": {
        "apicPayloadCaptures": [
            {
                "id": 1,
                "captureId": "4789432c-ba12-4b8b-8900-57c1dd72ba8a",
                "deviceName": "apic10_5_idg7",
                "domainName": "APIMgmt_C777777777",
                "captureCount": 5,
                "capturedTransactions": 5,
                "userName": "admin",
                "startTimeInMill": 1702972400560,
                "endTimeInMill": 1702972438719,
                "captureStatus": "COMPLETED"
            }
        ]
    }
}

Status code: 200

resultCode → SUCCESS

resultMessage → “API probe captures retrieved successfully"

GET Get Specific API-C Probe Capture Details

 /op/api/v2/apiProbeCapture/{{apiProbeCaptureId}}

URL:

GET - https://{{dpodHostname}}/op/api/v2/apiProbeCapture/{{apiProbeCaptureId}}

URL Parameters:

Name

Is required

Description

Parameter Type

apiProbeCaptureId

True

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

Number

Authorization:

Required Permissions

More info

  1. Access permissions for API-C product view

  2. Access permissions for API probe capture

  3. Access permissions for investigate

See roles information here: Role Based Access Control

Response:

Response Type

Example value

Description

Successful

{
    "resultCode": "SUCCESS",
    "resultMessage": "API probe payload capture retrieved successfully",
    "result": {
        "id": 1,
        "captureId": "4789432c-ba12-4b8b-8900-57c1dd72ba8a",
        "deviceName": "apic10_5_idg7",
        "domainName": "APIMgmt_C777777777",
        "captureCount": 5,
        "capturedTransactions": 5,
        "userName": "admin",
        "startTimeInMill": 1702972400560,
        "endTimeInMill": 1702972438719,
        "captureStatus": "COMPLETED"
    }
}

Status code: 200

resultCode → SUCCESS

resultMessage → “API probe payload capture retrieved successfully”

Failure

{
    "resultCode": "ERROR",
    "resultErrorCode": "NOT_FOUND",
    "resultMessage": "API-C payload capture not found"
}

Status code: 200

resultCode → ERROR

resultErrorCode → NOT_FOUND

resultMessage → “API-C payload capture not found”

POST Add API-C Probe Capture

 /op/api/v2/apiProbeCaptures/

URL:

POST - https://{{dpodHostname}}/op/api/v2/apiProbeCaptures/

Authorization:

Required Permissions

More info

  1. Access permissions for API-C product view

  2. Access permissions for API probe capture

  3. Access permissions for investigate

See roles information here: Role Based Access Control

Request body:

Type

Parameters

Example Json

Description

Required

  1. List<String>deviceNames

  2. String deviceNamesOperator

  3. List<String>domainNames

  4. String domainNamesOperator

{
    "deviceNames": [
        "apic10_5_idg7"
    ],
    "deviceNamesOperator": "eq",
    "domainNames": [
        "APIMgmt_C777777777"
    ],
    "domainNamesOperator": "eq",
    "catalogNames": [
        "bankcatalog",
        "montiercatalog"
    ],
    "catalogNamesOperator": "eq"
}

  1. deviceNames and domainNames→ support wildcards.

  2. deviceNamesOperator, domainNamesOperator and catalogNamesOperator must be eq.

Optional

  1. Long durationInMinutes

  2. Long captureCount

  3. Long interval

  4. Boolean debugHeader

  5. String logLevel

  6. Map<String, String> additionalFiltersParameters

{
    "deviceNames": [
        "apic10_5_idg7"
    ],
    "deviceNamesOperator": "eq",
    "domainNames": [
        "APIMgmt_C777777777"
    ],
    "domainNamesOperator": "eq",
    "durationInMinutes": 60,
    "captureCount": 5,
    "interval": 1,
    "debugHeader": false,
    "logLevel": "debug",
    "additionalFiltersParameters" : {
      "apicCatalogName":"bankcatalog", 
      "apicApiName":"balance-convert", 
      "clientIp":"172.17.100.131",
      "apicClientId":"b580876c023e5936fe622da39d78142a",
      "apicFullUri": "/montierorg10/bankcatalog/balance-convert-102/convert"
    }
}

  1. The duration in minutes to capture should be a positive number

  2. The number of transactions to capture should be a positive number

  3. The interval in seconds between which the data for two consecutive transactions can be captured is between 1 - 3600

  4. additionalFiltersParameters→ List of filters. List can be sent empty.

Response:

Response Type

Example value

Description

Successful

{
    "resultCode": "SUCCESS",
    "resultMessage": "All API probe captures created successfully",
    "result": {
        "apicPayloadCaptures": [
            {
                "id": 3,
                "captureId": "f705e48f-5601-441a-b4bc-57c1dd72cb34",
                "deviceName": "apic10_5_idg7",
                "domainName": "APIMgmt_C777777777",
                "captureCount": 100,
                "capturedTransactions": 0,
                "userName": "admin",
                "startTimeInMill": 1702976576044,
                "captureStatus": "ACTIVE",
                "resultCode": "SUCCESS",
                "resultMessage": "API probe capture created successfully"
            }
        ]
    }
}

Status code: 200

resultCode → SUCCESS

resultMessage → “All API probe captures created successfully”

Partial success

{
    "resultCode": "WARNING",
    "resultErrorCode": "SOME_CAPTURES_FAILED",
    "resultMessage": "Some API probe captures created successfully",
    "result": {
        "apicPayloadCaptures": [
            {
                "deviceName": "apic10_5_idg8",
                "domainName": "APIMgmt_C777777777",
                "resultCode": "ERROR",
                "resultErrorCode": "NO_ROMA_PORT_DEFINED_FOR_DEVICE",
                "resultMessage": "No ROMA port defined for this device"
            },
            {
                "id": 4,
                "captureId": "8aea845a-380e-40af-89d1-57c1dd72405a",
                "deviceName": "apic10_5_idg7",
                "domainName": "APIMgmt_C777777777",
                "captureCount": 100,
                "capturedTransactions": 0,
                "userName": "admin",
                "startTimeInMill": 1702976632734,
                "captureStatus": "ACTIVE",
                "resultCode": "SUCCESS",
                "resultMessage": "API probe capture created successfully"
            }
        ]
    }
}

Status code: 200

resultCode → WARNING

resultErrorCode → SOME_CAPTURES_FAILED

resultMessage → “Some API probe captures created successfully”

Failure

{
    "resultCode": "ERROR",
    "resultErrorCode": "ALL_CAPTURES_FAILED",
    "resultMessage": "All API probe captures failed",
    "result": {
        "apicPayloadCaptures": [
            {
                "deviceName": "apic10_5_idg8",
                "domainName": "APIMgmt_C777777777",
                "resultCode": "ERROR",
                "resultErrorCode": "NO_ROMA_PORT_DEFINED_FOR_DEVICE",
                "resultMessage": "No ROMA port defined for this device"
            }
        ]
    }
}

Status code: 200

resultCode → ERROR

resultErrorCode → ALL_CAPTURES_FAILED

resultMessage → “All API probe captures failed”

DELETE Delete API-C Probe Capture

 /op/api/v2/apiProbeCapture/{{apiProbeCaptureId}}

URL:

DELETE - https://{{dpodHostname}}/op/api/v2/apiProbeCapture/{{apiProbeCaptureId}}

URL Parameters:

Name

Is required

Description

Parameter Type

apiProbeCaptureId

True

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

Number

Authorization:

Required Permissions

More info

  1. Access permissions for API-C product view

  2. Access permissions for API probe capture

  3. Access permissions for investigate

See roles information here: Role Based Access Control

Response:

Response Type

Example value

Description

Successful

{
    "resultCode": "SUCCESS",
    "resultMessage": "API probe capture is stopping"
}

Status code: 200

resultCode → SUCCESS

resultMessage → “API probe capture is stopping”

  • No labels

Copyright © 2015 MonTier Software (2015) Ltd.