Skip to content

PurgeApi.md

Latest commit

 

History

History
274 lines (174 loc) · 10.9 KB

PurgeApi.md

File metadata and controls

274 lines (174 loc) · 10.9 KB

\PurgeApi

All URIs are relative to http://localhost/api/v2.0

Method HTTP request Description
CreatePurgeSchedule Post /system/purgeaudit/schedule Create a purge job schedule.
GetPurgeHistory Get /system/purgeaudit Get purge job results.
GetPurgeJob Get /system/purgeaudit/{purge_id} Get purge job status.
GetPurgeJobLog Get /system/purgeaudit/{purge_id}/log Get purge job log.
GetPurgeSchedule Get /system/purgeaudit/schedule Get purge's schedule.
StopPurge Put /system/purgeaudit/{purge_id} Stop the specific purge audit log execution
UpdatePurgeSchedule Put /system/purgeaudit/schedule Update purge job's schedule.

CreatePurgeSchedule

CreatePurgeSchedule(ctx, schedule, optional) Create a purge job schedule.

This endpoint is for update purge job schedule.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
schedule Schedule The purge job's schedule, it is a json object. ｜ The sample format is ｜ {"parameters":{"audit_retention_hour":168,"dry_run":true, "include_operations":"create,delete,pull"},"schedule":{"type":"Hourly","cron":"0 0 * * * *"}} ｜ the include_operation should be a comma separated string, e.g. create,delete,pull, if it is empty, no operation will be purged.
optional *PurgeApiCreatePurgeScheduleOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a PurgeApiCreatePurgeScheduleOpts struct

Name Type Description Notes

xRequestId | optional.String| An unique ID for the request |

Return type

(empty response body)

Authorization

basic

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetPurgeHistory

[]ExecHistory GetPurgeHistory(ctx, optional) Get purge job results.

get purge job execution history.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *PurgeApiGetPurgeHistoryOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a PurgeApiGetPurgeHistoryOpts struct

Name Type Description Notes
xRequestId optional.String An unique ID for the request
q optional.String Query string to query resources. Supported query patterns are "exact match(k=v)", "fuzzy match(k=v)", "range(k=[minmax])", "list with union releationship(k={v1 v2 v3})" and "list with intersetion relationship(k=(v1 v2 v3))". The value of range and list can be string(enclosed by " or '), integer or time(in format "2020-04-09 02:36:00"). All of these query patterns should be put in the query string "q=xxx" and splitted by ",". e.g. q=k1=v1,k2=v2,k3=[minmax]
sort optional.String Sort the resource list in ascending or descending order. e.g. sort by field1 in ascending orderr and field2 in descending order with "sort=field1,-field2"
page optional.Int64 The page number [default to 1]
pageSize optional.Int64 The size of per page [default to 10]

Return type

[]ExecHistory

Authorization

basic

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetPurgeJob

ExecHistory GetPurgeJob(ctx, purgeId, optional) Get purge job status.

This endpoint let user get purge job status filtered by specific ID.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
purgeId int64 The ID of the purge log
optional *PurgeApiGetPurgeJobOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a PurgeApiGetPurgeJobOpts struct

Name Type Description Notes

xRequestId | optional.String| An unique ID for the request |

Return type

ExecHistory

Authorization

basic

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetPurgeJobLog

string GetPurgeJobLog(ctx, purgeId, optional) Get purge job log.

This endpoint let user get purge job logs filtered by specific ID.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
purgeId int64 The ID of the purge log
optional *PurgeApiGetPurgeJobLogOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a PurgeApiGetPurgeJobLogOpts struct

Name Type Description Notes

xRequestId | optional.String| An unique ID for the request |

Return type

string

Authorization

basic

HTTP request headers

  • Content-Type: application/json
  • Accept: text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetPurgeSchedule

ExecHistory GetPurgeSchedule(ctx, optional) Get purge's schedule.

This endpoint is for get schedule of purge job.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *PurgeApiGetPurgeScheduleOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a PurgeApiGetPurgeScheduleOpts struct

Name Type Description Notes
xRequestId optional.String An unique ID for the request

Return type

ExecHistory

Authorization

basic

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

StopPurge

StopPurge(ctx, purgeId, optional) Stop the specific purge audit log execution

Stop the purge audit log execution specified by ID

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
purgeId int64 The ID of the purge log
optional *PurgeApiStopPurgeOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a PurgeApiStopPurgeOpts struct

Name Type Description Notes

xRequestId | optional.String| An unique ID for the request |

Return type

(empty response body)

Authorization

basic

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdatePurgeSchedule

UpdatePurgeSchedule(ctx, schedule, optional) Update purge job's schedule.

This endpoint is for update purge job schedule.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
schedule Schedule The purge job's schedule, it is a json object. ｜ The sample format is ｜ {"parameters":{"audit_retention_hour":168,"dry_run":true, "include_operations":"create,delete,pull"},"schedule":{"type":"Hourly","cron":"0 0 * * * *"}} ｜ the include_operation should be a comma separated string, e.g. create,delete,pull, if it is empty, no operation will be purged.
optional *PurgeApiUpdatePurgeScheduleOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a PurgeApiUpdatePurgeScheduleOpts struct

Name Type Description Notes

xRequestId | optional.String| An unique ID for the request |

Return type

(empty response body)

Authorization

basic

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]