In this page:
Table of Contents | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Status | |
---|---|
|
...
|
...
|
...
Search for API
...
Probe Captures
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Description:This API retrieves all API-C performs a search for API probe captures. Required Roles:
URI:
Request:The request should use the
ExampleExample:
Successful Response:The response includes the following fields in its body
Example: Code Block |
Example:
|
Status | ||||
---|---|---|---|---|
|
...
an API
...
Probe Capture
...
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Description:This API retrieves a specific API -C probe capture. Required Roles:
URI:
Request:The request should use the
Successful Response:The response includes the following fields in its body
Example: Code Block |
Example:
|
Status | ||||
---|---|---|---|---|
|
...
Probe
...
Captures
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Description:This API addsl adds API -C probe captures. Required Roles:
URI:
Request:The request should use the
Example:
Successful Response:The response includes the following fields in its body: | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Name | Description | Type | Available Options | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
apiProbeCaptures |
| Array of Element |
| apiProbeCaptures.id | The id of the record in the Database
} |
Successful Response:
The response includes the following fields in its result
element:
Name | Description | Type | Available Options | ||
---|---|---|---|---|---|
apiProbeCaptures | The API probe captures that have been created. | Array of Elements |
| ||
apiProbeCaptures[].id | The ID of the API probe capture. | Long |
| ||
apiProbeCaptures[].captureId | The ID of the API probe capture in the DataPower gateway. | String |
| ||
apiProbeCaptures[].deviceName | The device name from which the API probe data was captured. | String |
| ||
apiProbeCaptures[].domainName | The domain name from which the API probe data was captured. | String |
| ||
apiProbeCaptures[].captureCount | The number of transactions to capture. | Long |
| ||
apiProbeCaptures[].capturedTransactions | The number of captured transactions. | Long |
| ||
apiProbeCaptures[].captureIduserName | The id for a transaction user name who created the API probe capture. | String |
| ||
apiProbeCaptures[].deviceName | The device name from which the debug API-C probe data was captured. | StringstartTimeInMill | When the API probe capture started. | Long |
|
apiProbeCaptures[].domainName | The domain name from which the debug API-C probe data was captured. | String |
| ||
apiProbeCaptures.captureCount | The number of transactions to capture. | Long |
| ||
apiProbeCaptures.capturedTransactions | The number of captured transactions. | Long |
| ||
apiProbeCaptures.userName | The user name who created the capture. | String |
| ||
apiProbeCaptures.startTimeInMill | When the capture started. | Long |
| ||
apiProbeCaptures.captureStatus | The endTimeInMill | When the API probe capture finished. | Long | ||
apiProbeCaptures[].apicApiName | The transaction API name. | String | |||
apiProbeCaptures[].apicCatalogName | The transaction API catalog name. | String | |||
apiProbeCaptures[].clientIp | The transaction client IP address. | String | |||
apiProbeCaptures[].apicClientId | The transaction client ID. | String | |||
apiProbeCaptures[].apicFullUri | The transaction full URI path. | String | |||
apiProbeCaptures[].captureStatus | The API probe capture status. | String |
| ||
apiProbeCaptures[].resultCode | The REST API probe capture creation result code. | String |
| ||
apiProbeCaptures[].resultMessage | The REST API probe capture creation result message. | String |
|
Example:
Code Block |
---|
{ "resultCode": "SUCCESS", "resultMessage": "All API probe captures created successfully", "result": { "apiProbeCaptures": [ { "id": 165, "captureId": "1e070084-56a3-4464-9c09-fa26e6b9ab06", "deviceName": "idg_10_5_0_a", "domainName": "APIC_Mgmt_Domain", "captureCount": 100, "capturedTransactions": 0, "userName": "admin", "startTimeInMill": 1727267288816, "captureStatus": "ACTIVE", "resultCode": "SUCCESS", "resultMessage": "API Probe capture created successfully" } ] } } |
Status | ||||
---|---|---|---|---|
|
...
Probe Capture
Expand | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
Description:This API deletes marks a specific API -C probe captureprobe capture for deletion (with a status of Required Roles:
URI:
Request:The request should use the
Successful Response:Example:
|
...