Skip to content

Latest commit

 

History

History
1066 lines (653 loc) · 35.3 KB

SyncApi.md

File metadata and controls

1066 lines (653 loc) · 35.3 KB
Raw

\SyncApi

All URIs are relative to https://YOUR_CLUSTER_HOSTNAME_OR_NODE_IP:8080

Method HTTP request Description
CreateSyncJob Post /platform/3/sync/jobs
CreateSyncPolicy Post /platform/3/sync/policies
CreateSyncReportsRotateItem Post /platform/1/sync/reports-rotate
CreateSyncRule Post /platform/3/sync/rules
DeleteSyncPolicies Delete /platform/3/sync/policies
DeleteSyncPolicy Delete /platform/3/sync/policies/{SyncPolicyId}
DeleteSyncRule Delete /platform/3/sync/rules/{SyncRuleId}
DeleteSyncRules Delete /platform/3/sync/rules
DeleteTargetPolicy Delete /platform/1/sync/target/policies/{TargetPolicyId}
GetHistoryCpu Get /platform/3/sync/history/cpu
GetHistoryFile Get /platform/1/sync/history/file
GetHistoryNetwork Get /platform/1/sync/history/network
GetHistoryWorker Get /platform/3/sync/history/worker
GetSyncJob Get /platform/3/sync/jobs/{SyncJobId}
GetSyncLicense Get /platform/5/sync/license
GetSyncPolicy Get /platform/3/sync/policies/{SyncPolicyId}
GetSyncReport Get /platform/4/sync/reports/{SyncReportId}
GetSyncReports Get /platform/4/sync/reports
GetSyncRule Get /platform/3/sync/rules/{SyncRuleId}
GetSyncSettings Get /platform/3/sync/settings
GetTargetPolicies Get /platform/1/sync/target/policies
GetTargetPolicy Get /platform/1/sync/target/policies/{TargetPolicyId}
GetTargetReport Get /platform/4/sync/target/reports/{TargetReportId}
GetTargetReports Get /platform/4/sync/target/reports
ListSyncJobs Get /platform/3/sync/jobs
ListSyncPolicies Get /platform/3/sync/policies
ListSyncReportsRotate Get /platform/1/sync/reports-rotate
ListSyncRules Get /platform/3/sync/rules
UpdateSyncJob Put /platform/3/sync/jobs/{SyncJobId}
UpdateSyncPolicy Put /platform/3/sync/policies/{SyncPolicyId}
UpdateSyncRule Put /platform/3/sync/rules/{SyncRuleId}
UpdateSyncSettings Put /platform/3/sync/settings

CreateSyncJob

CreateResponse CreateSyncJob(ctx, syncJob)

Start a SyncIQ job.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
syncJob SyncJobCreateParams

Return type

CreateResponse

Authorization

basicAuth

HTTP request headers

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

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

CreateSyncPolicy

CreateResponse CreateSyncPolicy(ctx, syncPolicy)

Create a SyncIQ policy.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
syncPolicy SyncPolicyCreateParams

Return type

CreateResponse

Authorization

basicAuth

HTTP request headers

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

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

CreateSyncReportsRotateItem

CreateSyncReportsRotateItemResponse CreateSyncReportsRotateItem(ctx, syncReportsRotateItem)

Rotate the records in the database(s).

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
syncReportsRotateItem Empty

Return type

CreateSyncReportsRotateItemResponse

Authorization

basicAuth

HTTP request headers

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

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

CreateSyncRule

CreateResponse CreateSyncRule(ctx, syncRule)

Create a new SyncIQ performance rule.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
syncRule SyncRuleCreateParams

Return type

CreateResponse

Authorization

basicAuth

HTTP request headers

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

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

DeleteSyncPolicies

DeleteSyncPolicies(ctx, optional)

Delete all SyncIQ policies.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
localOnly bool Skip deleting the policy association on the target.
force bool Ignore any running jobs when preparing to delete a policy.

Return type

(empty response body)

Authorization

basicAuth

HTTP request headers

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

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

DeleteSyncPolicy

DeleteSyncPolicy(ctx, syncPolicyId, optional)

Delete a single SyncIQ policy.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
syncPolicyId string Delete a single SyncIQ policy.
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
syncPolicyId string Delete a single SyncIQ policy.
localOnly bool Skip deleting the policy association on the target.
force bool Ignore any running jobs when preparing to delete a policy.

Return type

(empty response body)

Authorization

basicAuth

HTTP request headers

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

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

DeleteSyncRule

DeleteSyncRule(ctx, syncRuleId)

Delete a single SyncIQ performance rule.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
syncRuleId string Delete a single SyncIQ performance rule.

Return type

(empty response body)

Authorization

basicAuth

HTTP request headers

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

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

DeleteSyncRules

DeleteSyncRules(ctx, optional)

Delete all SyncIQ performance rules or all rules of a specified type.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
type_ string Delete all rules of the specified rule type only.

Return type

(empty response body)

Authorization

basicAuth

HTTP request headers

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

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

DeleteTargetPolicy

DeleteTargetPolicy(ctx, targetPolicyId, optional)

Break the target association with this cluster for this policy.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
targetPolicyId string Break the target association with this cluster for this policy.
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
targetPolicyId string Break the target association with this cluster for this policy.
force bool Ignore any running jobs when preparing to delete the policy target association.

Return type

(empty response body)

Authorization

basicAuth

HTTP request headers

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

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

GetHistoryCpu

HistoryFile GetHistoryCpu(ctx, optional)

List cpu performance data.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
begin int32 Begin timestamp for time-series report.
end int32 End timestamp for time-series report.

Return type

HistoryFile

Authorization

basicAuth

HTTP request headers

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

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

GetHistoryFile

HistoryFile GetHistoryFile(ctx, optional)

List file operations performance data.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
begin int32 Begin timestamp for time-series report.
end int32 End timestamp for time-series report.

Return type

HistoryFile

Authorization

basicAuth

HTTP request headers

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

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

GetHistoryNetwork

HistoryFile GetHistoryNetwork(ctx, optional)

List network operations performance data.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
begin int32 Begin timestamp for time-series report.
end int32 End timestamp for time-series report.

Return type

HistoryFile

Authorization

basicAuth

HTTP request headers

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

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

GetHistoryWorker

HistoryFile GetHistoryWorker(ctx, optional)

List worker performance data.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
begin int32 Begin timestamp for time-series report.
end int32 End timestamp for time-series report.

Return type

HistoryFile

Authorization

basicAuth

HTTP request headers

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

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

GetSyncJob

SyncJobs GetSyncJob(ctx, syncJobId)

View a single SyncIQ job.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
syncJobId string View a single SyncIQ job.

Return type

SyncJobs

Authorization

basicAuth

HTTP request headers

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

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

GetSyncLicense

LicenseLicense GetSyncLicense(ctx, )

Retrieve license information.

Required Parameters

This endpoint does not need any parameter.

Return type

LicenseLicense

Authorization

basicAuth

HTTP request headers

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

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

GetSyncPolicy

SyncPolicies GetSyncPolicy(ctx, syncPolicyId)

View a single SyncIQ policy.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
syncPolicyId string View a single SyncIQ policy.

Return type

SyncPolicies

Authorization

basicAuth

HTTP request headers

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

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

GetSyncReport

SyncReports GetSyncReport(ctx, syncReportId)

View a single SyncIQ report.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
syncReportId string View a single SyncIQ report.

Return type

SyncReports

Authorization

basicAuth

HTTP request headers

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

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

GetSyncReports

SyncReportsExtended GetSyncReports(ctx, optional)

Get a list of SyncIQ reports. By default 10 reports are returned per policy, unless otherwise specified by 'reports_per_policy'.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
sort string The field that will be used for sorting.
resume string Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).
newerThan int32 Filter the returned reports to include only those whose jobs started more recently than the specified number of days ago.
policyName string Filter the returned reports to include only those with this policy name.
state string Filter the returned reports to include only those whose jobs are in this state.
limit int32 Return no more than this many results at once (see resume).
reportsPerPolicy int32 If specified, only the N most recent reports will be returned per policy. If no other query args are present this argument defaults to 10.
dir string The direction of the sort.

Return type

SyncReportsExtended

Authorization

basicAuth

HTTP request headers

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

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

GetSyncRule

SyncRules GetSyncRule(ctx, syncRuleId)

View a single SyncIQ performance rule.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
syncRuleId string View a single SyncIQ performance rule.

Return type

SyncRules

Authorization

basicAuth

HTTP request headers

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

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

GetSyncSettings

SyncSettings GetSyncSettings(ctx, )

Retrieve the global SyncIQ settings.

Required Parameters

This endpoint does not need any parameter.

Return type

SyncSettings

Authorization

basicAuth

HTTP request headers

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

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

GetTargetPolicies

TargetPoliciesExtended GetTargetPolicies(ctx, optional)

List all SyncIQ target policies.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
sort string The field that will be used for sorting.
targetPath string Filter the returned policies to include only those with this target path.
limit int32 Return no more than this many results at once (see resume).
dir string The direction of the sort.
resume string Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).

Return type

TargetPoliciesExtended

Authorization

basicAuth

HTTP request headers

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

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

GetTargetPolicy

TargetPolicies GetTargetPolicy(ctx, targetPolicyId)

View a single SyncIQ target policy.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
targetPolicyId string View a single SyncIQ target policy.

Return type

TargetPolicies

Authorization

basicAuth

HTTP request headers

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

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

GetTargetReport

TargetReports GetTargetReport(ctx, targetReportId)

View a single SyncIQ target report.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
targetReportId string View a single SyncIQ target report.

Return type

TargetReports

Authorization

basicAuth

HTTP request headers

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

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

GetTargetReports

TargetReportsExtended GetTargetReports(ctx, optional)

Get a list of SyncIQ target reports. By default 10 reports are returned per policy, unless otherwise specified by 'reports_per_policy'.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
sort string The field that will be used for sorting.
resume string Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).
newerThan int32 Filter the returned reports to include only those whose jobs started more recently than the specified number of days ago.
policyName string Filter the returned reports to include only those with this policy name.
state string Filter the returned reports to include only those whose jobs are in this state.
limit int32 Return no more than this many results at once (see resume).
reportsPerPolicy int32 If specified, only the N most recent reports will be returned per policy. If no other query args are present this argument defaults to 10.
dir string The direction of the sort.

Return type

TargetReportsExtended

Authorization

basicAuth

HTTP request headers

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

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

ListSyncJobs

SyncJobsExtended ListSyncJobs(ctx, optional)

Get a list of SyncIQ jobs.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
sort string The field that will be used for sorting.
state string The state of the job.
limit int32 Return no more than this many results at once (see resume).
dir string The direction of the sort.
resume string Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).

Return type

SyncJobsExtended

Authorization

basicAuth

HTTP request headers

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

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

ListSyncPolicies

SyncPoliciesExtended ListSyncPolicies(ctx, optional)

List all SyncIQ policies.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
sort string The field that will be used for sorting.
resume string Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).
summary bool Show only summary properties
limit int32 Return no more than this many results at once (see resume).
scope string If specified as "effective" or not specified, all fields are returned. If specified as "user", only fields with non-default values are shown. If specified as "default", the original values are returned.
dir string The direction of the sort.

Return type

SyncPoliciesExtended

Authorization

basicAuth

HTTP request headers

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

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

ListSyncReportsRotate

SyncReportsRotate ListSyncReportsRotate(ctx, )

Whether the rotation is still running or not.

Required Parameters

This endpoint does not need any parameter.

Return type

SyncReportsRotate

Authorization

basicAuth

HTTP request headers

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

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

ListSyncRules

SyncRulesExtended ListSyncRules(ctx, optional)

List all SyncIQ performance rules.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
sort string The field that will be used for sorting.
type_ string Filter the returned rules to include only those with this rule type.
limit int32 Return no more than this many results at once (see resume).
dir string The direction of the sort.
resume string Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options).

Return type

SyncRulesExtended

Authorization

basicAuth

HTTP request headers

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

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

UpdateSyncJob

UpdateSyncJob(ctx, syncJob, syncJobId)

Perform an action (pause, cancel, etc...) on a single job.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
syncJob SyncJob
syncJobId string Perform an action (pause, cancel, etc...) on a single job.

Return type

(empty response body)

Authorization

basicAuth

HTTP request headers

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

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

UpdateSyncPolicy

UpdateSyncPolicy(ctx, syncPolicy, syncPolicyId)

Modify a single SyncIQ policy.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
syncPolicy SyncPolicy
syncPolicyId string Modify a single SyncIQ policy.

Return type

(empty response body)

Authorization

basicAuth

HTTP request headers

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

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

UpdateSyncRule

UpdateSyncRule(ctx, syncRule, syncRuleId)

Modify a single SyncIQ performance rule.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
syncRule SyncRule
syncRuleId string Modify a single SyncIQ performance rule.

Return type

(empty response body)

Authorization

basicAuth

HTTP request headers

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

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

UpdateSyncSettings

UpdateSyncSettings(ctx, syncSettings)

Modify the global SyncIQ settings. All input fields are optional, but one or more must be supplied.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
syncSettings SyncSettingsExtended

Return type

(empty response body)

Authorization

basicAuth

HTTP request headers

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

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