Skip to content

Latest commit

 

History

History
928 lines (539 loc) · 28 KB

ClusterApi.md

File metadata and controls

928 lines (539 loc) · 28 KB
Raw

\ClusterApi

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

Method HTTP request Description
CreateClusterAddNodeItem Post /platform/3/cluster/add-node
CreateDiagnosticsGatherStartItem Post /platform/3/cluster/diagnostics/gather/start
CreateDiagnosticsGatherStopItem Post /platform/3/cluster/diagnostics/gather/stop
CreateDiagnosticsNetloggerStartItem Post /platform/3/cluster/diagnostics/netlogger/start
CreateDiagnosticsNetloggerStopItem Post /platform/3/cluster/diagnostics/netlogger/stop
GetClusterConfig Get /platform/3/cluster/config
GetClusterEmail Get /platform/1/cluster/email
GetClusterExternalIps Get /platform/2/cluster/external-ips
GetClusterIdentity Get /platform/5/cluster/identity
GetClusterNode Get /platform/5/cluster/nodes/{ClusterNodeId}
GetClusterNodes Get /platform/5/cluster/nodes
GetClusterNodesAvailable Get /platform/3/cluster/nodes-available
GetClusterOwner Get /platform/1/cluster/owner
GetClusterStatfs Get /platform/1/cluster/statfs
GetClusterTime Get /platform/3/cluster/time
GetClusterTimezone Get /platform/3/cluster/timezone
GetClusterVersion Get /platform/3/cluster/version
GetDiagnosticsGather Get /platform/3/cluster/diagnostics/gather
GetDiagnosticsGatherSettings Get /platform/3/cluster/diagnostics/gather/settings
GetDiagnosticsGatherStatus Get /platform/3/cluster/diagnostics/gather/status
GetDiagnosticsNetlogger Get /platform/3/cluster/diagnostics/netlogger
GetDiagnosticsNetloggerSettings Get /platform/3/cluster/diagnostics/netlogger/settings
GetDiagnosticsNetloggerStatus Get /platform/3/cluster/diagnostics/netlogger/status
GetTimezoneRegion Get /platform/3/cluster/timezone/regions/{TimezoneRegionId}
GetTimezoneSettings Get /platform/3/cluster/timezone/settings
UpdateClusterEmail Put /platform/1/cluster/email
UpdateClusterNode Put /platform/5/cluster/nodes/{ClusterNodeId}
UpdateClusterOwner Put /platform/1/cluster/owner
UpdateClusterTime Put /platform/3/cluster/time
UpdateClusterTimezone Put /platform/3/cluster/timezone
UpdateDiagnosticsGatherSettings Put /platform/3/cluster/diagnostics/gather/settings
UpdateDiagnosticsNetloggerSettings Put /platform/3/cluster/diagnostics/netlogger/settings
UpdateTimezoneSettings Put /platform/3/cluster/timezone/settings

CreateClusterAddNodeItem

Empty CreateClusterAddNodeItem(ctx, clusterAddNodeItem)

Serial number and arguments of node to add.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
clusterAddNodeItem ClusterAddNodeItem

Return type

Empty

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]

CreateDiagnosticsGatherStartItem

Empty CreateDiagnosticsGatherStartItem(ctx, diagnosticsGatherStartItem)

Start a new gather

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
diagnosticsGatherStartItem DiagnosticsGatherSettingsExtended

Return type

Empty

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]

CreateDiagnosticsGatherStopItem

Empty CreateDiagnosticsGatherStopItem(ctx, diagnosticsGatherStopItem)

Stop a running gather

Required Parameters

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

Return type

Empty

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]

CreateDiagnosticsNetloggerStartItem

Empty CreateDiagnosticsNetloggerStartItem(ctx, diagnosticsNetloggerStartItem)

Start a new packet caputre

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
diagnosticsNetloggerStartItem DiagnosticsNetloggerSettings

Return type

Empty

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]

CreateDiagnosticsNetloggerStopItem

Empty CreateDiagnosticsNetloggerStopItem(ctx, diagnosticsNetloggerStopItem)

Stop a running packet capture

Required Parameters

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

Return type

Empty

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]

GetClusterConfig

ClusterConfig GetClusterConfig(ctx, )

Retrieve the cluster information.

Required Parameters

This endpoint does not need any parameter.

Return type

ClusterConfig

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]

GetClusterEmail

ClusterEmail GetClusterEmail(ctx, )

Get the cluster email notification settings.

Required Parameters

This endpoint does not need any parameter.

Return type

ClusterEmail

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]

GetClusterExternalIps

[]string GetClusterExternalIps(ctx, )

Retrieve the cluster IP addresses including IPV4 and IPV6.

Required Parameters

This endpoint does not need any parameter.

Return type

[]string

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]

GetClusterIdentity

ClusterIdentity GetClusterIdentity(ctx, )

Retrieve the login information.

Required Parameters

This endpoint does not need any parameter.

Return type

ClusterIdentity

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]

GetClusterNode

ClusterNodesExtendedExtended GetClusterNode(ctx, clusterNodeId, optional)

Retrieve node information.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
clusterNodeId int32 Retrieve node information.
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
clusterNodeId int32 Retrieve node information.
timeout float32 Request timeout

Return type

ClusterNodesExtendedExtended

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]

GetClusterNodes

ClusterNodesExtendedExtendedExtended GetClusterNodes(ctx, optional)

List the nodes on this cluster.

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
timeout float32 Request timeout

Return type

ClusterNodesExtendedExtendedExtended

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]

GetClusterNodesAvailable

ClusterNodesAvailable GetClusterNodesAvailable(ctx, )

List all nodes that are available to add to this cluster.

Required Parameters

This endpoint does not need any parameter.

Return type

ClusterNodesAvailable

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]

GetClusterOwner

ClusterOwner GetClusterOwner(ctx, )

Get the cluster contact info settings

Required Parameters

This endpoint does not need any parameter.

Return type

ClusterOwner

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]

GetClusterStatfs

ClusterStatfs GetClusterStatfs(ctx, )

Retrieve the filesystem statistics.

Required Parameters

This endpoint does not need any parameter.

Return type

ClusterStatfs

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]

GetClusterTime

ClusterTime GetClusterTime(ctx, )

Retrieve the current time as reported by each node.

Required Parameters

This endpoint does not need any parameter.

Return type

ClusterTime

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]

GetClusterTimezone

ClusterTimezone GetClusterTimezone(ctx, )

Get the cluster timezone.

Required Parameters

This endpoint does not need any parameter.

Return type

ClusterTimezone

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]

GetClusterVersion

ClusterVersion GetClusterVersion(ctx, )

Retrieve the OneFS version as reported by each node.

Required Parameters

This endpoint does not need any parameter.

Return type

ClusterVersion

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]

GetDiagnosticsGather

DiagnosticsGatherStatus GetDiagnosticsGather(ctx, )

Get the status of isi_gather_info.

Required Parameters

This endpoint does not need any parameter.

Return type

DiagnosticsGatherStatus

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]

GetDiagnosticsGatherSettings

DiagnosticsGatherSettings GetDiagnosticsGatherSettings(ctx, )

Get the default options for isi_gather_info.

Required Parameters

This endpoint does not need any parameter.

Return type

DiagnosticsGatherSettings

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]

GetDiagnosticsGatherStatus

DiagnosticsGatherStatus GetDiagnosticsGatherStatus(ctx, )

Get the status of isi_gather_info.

Required Parameters

This endpoint does not need any parameter.

Return type

DiagnosticsGatherStatus

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]

GetDiagnosticsNetlogger

DiagnosticsNetloggerStatus GetDiagnosticsNetlogger(ctx, )

Get the status of isi_netlogger.

Required Parameters

This endpoint does not need any parameter.

Return type

DiagnosticsNetloggerStatus

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]

GetDiagnosticsNetloggerSettings

DiagnosticsNetloggerSettings GetDiagnosticsNetloggerSettings(ctx, )

Get the default options for isi_netlogger.

Required Parameters

This endpoint does not need any parameter.

Return type

DiagnosticsNetloggerSettings

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]

GetDiagnosticsNetloggerStatus

DiagnosticsNetloggerStatus GetDiagnosticsNetloggerStatus(ctx, )

Get the status of isi_netlogger.

Required Parameters

This endpoint does not need any parameter.

Return type

DiagnosticsNetloggerStatus

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]

GetTimezoneRegion

TimezoneRegions GetTimezoneRegion(ctx, timezoneRegionId, optional)

List timezone regions.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
timezoneRegionId string List timezone regions.
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
timezoneRegionId string List timezone regions.
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).
showAll bool Show all timezones within the region specified in the URI.
dstReset bool This query arg is not needed in normal use cases.
limit int32 Return no more than this many results at once (see resume).
dir string The direction of the sort.

Return type

TimezoneRegions

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]

GetTimezoneSettings

TimezoneSettings GetTimezoneSettings(ctx, )

Retrieve the cluster timezone.

Required Parameters

This endpoint does not need any parameter.

Return type

TimezoneSettings

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]

UpdateClusterEmail

UpdateClusterEmail(ctx, clusterEmail)

Modify the cluster email notification 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.
clusterEmail ClusterEmailExtended

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]

UpdateClusterNode

UpdateClusterNode(ctx, clusterNode, clusterNodeId)

Modify one or more node settings.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
clusterNode ClusterNode
clusterNodeId int32 Modify one or more node settings.

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]

UpdateClusterOwner

UpdateClusterOwner(ctx, clusterOwner)

Modify the cluster contact info 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.
clusterOwner ClusterOwner

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]

UpdateClusterTime

UpdateClusterTime(ctx, clusterTime)

Set cluster time. Time will mostly be synchronized across nodes, but there may be slight drift.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
clusterTime ClusterTimeExtended

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]

UpdateClusterTimezone

UpdateClusterTimezone(ctx, clusterTimezone)

Set a new timezone for the cluster.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
clusterTimezone ClusterTimezoneExtended

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]

UpdateDiagnosticsGatherSettings

UpdateDiagnosticsGatherSettings(ctx, diagnosticsGatherSettings)

Set the default options for isi_gather_info.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
diagnosticsGatherSettings DiagnosticsGatherSettingsExtended

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]

UpdateDiagnosticsNetloggerSettings

UpdateDiagnosticsNetloggerSettings(ctx, diagnosticsNetloggerSettings)

Set the default options for isi_netlogger.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
diagnosticsNetloggerSettings DiagnosticsNetloggerSettings

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]

UpdateTimezoneSettings

UpdateTimezoneSettings(ctx, timezoneSettings)

Modify the cluster timezone.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
timezoneSettings TimezoneRegionTimezone

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]