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(ctx, schedule, optional) Create a gc schedule.
This endpoint is for update gc schedule.
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 are passed through a pointer to a GcApiCreateGCScheduleOpts struct
Name | Type | Description | Notes |
---|
xRequestId | optional.String| An unique ID for the request |
(empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GcHistory GetGC(ctx, gcId, optional) Get gc status.
This endpoint let user get gc status filtered by specific ID.
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 are passed through a pointer to a GcApiGetGCOpts struct
Name | Type | Description | Notes |
---|
xRequestId | optional.String| An unique ID for the request |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]GcHistory GetGCHistory(ctx, optional) Get gc results.
This endpoint let user get gc execution history.
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 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= |
|
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] |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
string GetGCLog(ctx, gcId, optional) Get gc job log.
This endpoint let user get gc job logs filtered by specific ID.
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 are passed through a pointer to a GcApiGetGCLogOpts struct
Name | Type | Description | Notes |
---|
xRequestId | optional.String| An unique ID for the request |
string
- Content-Type: application/json
- Accept: text/plain
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GcHistory GetGCSchedule(ctx, optional) Get gc's schedule.
This endpoint is for get schedule of gc job.
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 are passed through a pointer to a GcApiGetGCScheduleOpts struct
Name | Type | Description | Notes |
---|---|---|---|
xRequestId | optional.String | An unique ID for the request |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
StopGC(ctx, gcId, optional) Stop the specific GC execution
Stop the GC execution specified by ID
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 are passed through a pointer to a GcApiStopGCOpts struct
Name | Type | Description | Notes |
---|
xRequestId | optional.String| An unique ID for the request |
(empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UpdateGCSchedule(ctx, schedule, optional) Update gc's schedule.
This endpoint is for update gc schedule.
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 are passed through a pointer to a GcApiUpdateGCScheduleOpts struct
Name | Type | Description | Notes |
---|
xRequestId | optional.String| An unique ID for the request |
(empty response body)
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]