ON THIS PAGE
GET /disaster_recovery/ariel_copy_profiles
SUMMARY Retrieves a list of the Ariel Copy Profiles.
Retrieves a list of the Ariel Copy Profiles.
| MIME Type |
|---|
application/json |
| Parameter | Type | Optionality | Data Type | MIME Type | Description |
|---|---|---|---|---|---|
fields |
query |
Optional |
String |
text/plain |
Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas. |
filter |
query |
Optional |
String |
text/plain |
Optional - This parameter is used to restrict the elements in a list base on the contents of various fields. |
| HTTP Response Code | Unique Code | Description |
|---|---|---|
200 |
The list of Ariel Copy Profiles was retrieved. |
|
500 |
1000 |
An error occurred during the attempt to retrieve the list of Ariel Copy profiles. |
Response Description
A list of Ariel Copy profile objects containing the following fields:
- id - Long - The ID of the Ariel Copy Profile.
- host_id - Long - The ID of the Ariel Copy host. The host_id references the /config/deployment/hosts endpoint.
- destination_port - Long - The port of the managed host over which the Ariel data is sent.
- destination_host_ip - String - The IP address of the managed host where the Ariel data is sent.
- exclude_event_retention_bucket_ids - Array[Long] - The ID of the event retention bucket where events are not copied from. The exclude_event_retention_bucket_id references the /config/event_retention_buckets endpoint.
- exclude_flow_retention_bucket_ids - Array[Long] - The ID of the flow retention bucket where flow data is not copied from. The exclude_flow_retention_bucket_id references the /config/flow_retention_buckets endpoint.
- bandwidth_limit - Long - The amount to limit the bandwidth in bytes per second for copying data.
- enabled - Boolean - Whether Ariel Copy is enabled on the host. The enabled field is set to false by default
- frequency - Long - The frequency, in milliseconds, that Ariel Copy will run.
- start_date - Long - The date to start copying Ariel data from.
- end_date - Long - The date to copy Ariel data up until.
- last_successful_transfer_ariel_type - Enum - The type of Ariel data transferred during most recent successful transfer. Can be one of: EVENTS_PAYLOAD, EVENTS_RECORD, EVENTS_MD, FLOWS_PAYLOAD, FLOWS_RECORD, FLOWS_MD
- last_successful_ariel_content_transferred - Long - The date of the Ariel content transferred during most recent successful transfer
- last_successful_transfer_date - Long - The date the most recent successful transfer occurred
- last_error_ariel_type - String - The type of Ariel data attempted transferred during most recent error, Can be one of: EVENTS_PAYLOAD, EVENTS_RECORD, EVENTS_MD, FLOWS_PAYLOAD, FLOWS_RECORD, FLOWS_MD
- last_error_ariel_content_transferred - Long - The type of Ariel data attempted to be transferred during last unsuccessful transfer
- last_error_date - Long - The date the most recent error occurred
- last_error_max_threshold_surpassed_date - Long - The most recent date Ariel copy was forced to abort due to error threshold being surpassed
Response Sample
[
{
"bandwidth_limit": 42,
"destination_host_ip": "String",
"destination_port": 42,
"enabled": true,
"end_date": 42,
"exclude_event_retention_bucket_ids": [
42
],
"exclude_flow_retention_bucket_ids": [
42
],
"frequency": 42,
"host_id": 42,
"id": 42,
"last_error_ariel_content_transferred": 42,
"last_error_ariel_type": "String <one of: EVENTS_PAYLOAD, EVENTS_RECORD, EVENTS_MD, FLOWS_PAYLOAD, FLOWS_RECORD, FLOWS_MD>",
"last_error_date": 42,
"last_error_max_threshold_surpassed_date": 42,
"last_successful_ariel_content_transferred": 42,
"last_successful_transfer_ariel_type": "String <one of: EVENTS_PAYLOAD, EVENTS_RECORD, EVENTS_MD, FLOWS_PAYLOAD, FLOWS_RECORD, FLOWS_MD>",
"last_successful_transfer_date": 42,
"start_date": 42
}
]