Skip to content

Latest commit

 

History

History
274 lines (174 loc) · 9.52 KB

GcApi.md

File metadata and controls

274 lines (174 loc) · 9.52 KB

\GcApi

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

Method HTTP request Description
CreateGCSchedule Post /system/gc/schedule Create a gc schedule.
GetGC Get /system/gc/{gc_id} Get gc status.
GetGCHistory Get /system/gc Get gc results.
GetGCLog Get /system/gc/{gc_id}/log Get gc job log.
GetGCSchedule Get /system/gc/schedule Get gc's schedule.
StopGC Put /system/gc/{gc_id} Stop the specific GC execution
UpdateGCSchedule Put /system/gc/schedule Update gc's schedule.

CreateGCSchedule

CreateGCSchedule(ctx, schedule, optional) Create a gc schedule.

This endpoint is for update gc schedule.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
schedule Schedule Updates of gc's schedule.
optional *GcApiCreateGCScheduleOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GcApiCreateGCScheduleOpts 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]

GetGC

GcHistory GetGC(ctx, gcId, optional) Get gc status.

This endpoint let user get gc status filtered by specific ID.

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a GcApiGetGCOpts struct

Name Type Description Notes

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

Return type

GcHistory

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]

GetGCHistory

[]GcHistory GetGCHistory(ctx, optional) Get gc results.

This endpoint let user get gc execution history.

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a GcApiGetGCHistoryOpts 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

[]GcHistory

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]

GetGCLog

string GetGCLog(ctx, gcId, optional) Get gc job log.

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

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a GcApiGetGCLogOpts 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]

GetGCSchedule

GcHistory GetGCSchedule(ctx, optional) Get gc's schedule.

This endpoint is for get schedule of gc job.

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a GcApiGetGCScheduleOpts struct

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

Return type

GcHistory

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]

StopGC

StopGC(ctx, gcId, optional) Stop the specific GC execution

Stop the GC execution specified by ID

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a GcApiStopGCOpts 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]

UpdateGCSchedule

UpdateGCSchedule(ctx, schedule, optional) Update gc's schedule.

This endpoint is for update gc schedule.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
schedule Schedule Updates of gc's schedule.
optional *GcApiUpdateGCScheduleOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GcApiUpdateGCScheduleOpts 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]