GetChangeDataRetentionBarrier
General
Description
Returns the date of the earliest partition retention barrier when multiple partition retention barriers have been set.
When different retention barriers have been set by multiple consuming applications, Replicate will delete old Change Data partitions up to the earliest partition retention barrier.
For information on setting a partition retention barrier, see SetChangeDataRetentionBarrier.
URL
https://{host:port}/attunityenterprisemanager/api/v1/servers/{server}/tasks/ {task}?action=get_change_data_retention_barrier
HTTP method
GET
Required user role
See Required Enterprise Manager permissions.
Request parameters
| Location | Name | Required | Description/Example |
|---|---|---|---|
|
URL |
host [string] |
Yes |
The host name of the Enterprise Manager machine. Example: computer.network.net |
|
URL |
server [string] |
Yes |
The Replicate server name, as defined in Enterprise Manager. Example: myrepsrv1 |
|
URL |
task [string] |
Yes |
The Replicate task name. Example: TargetAWSEMR |
Response body
| Name | Type | Description |
|---|---|---|
|
application |
string |
The name of the consuming application that set the earliest partition retention barrier. |
|
retention_point |
datetime Format: yyyy'-'MM'-'dd'T'HH':'mm':'ss'Z' |
The date of the earliest partition retention barrier. |
cURL example
GET attunityenterprisemanager/api/v1/servers/roni-2012/tasks/Oracle2NULL?action=get_change_data_retention_barrier
Response:
{"application":"xxx","retention_point":"2020-06-30T16:15:00Z"}
Error response
| HTTP Code | Enterprise Manager Code | Text | Description |
|---|---|---|---|
|
500 |
AEM_TASK_NOT_FOUND |
Replication task {task] on server {server} could not be found. |
Returned when an unknown task name is encountered. |