Skip to content

Latest commit

 

History

History
947 lines (570 loc) · 29.9 KB

CloudApi.md

File metadata and controls

947 lines (570 loc) · 29.9 KB
Raw

\CloudApi

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

Method HTTP request Description
CreateCloudAccessItem Post /platform/3/cloud/access
CreateCloudAccount Post /platform/4/cloud/accounts
CreateCloudJob Post /platform/3/cloud/jobs
CreateCloudPool Post /platform/3/cloud/pools
CreateCloudProxy Post /platform/4/cloud/proxies
CreateSettingsEncryptionKeyItem Post /platform/3/cloud/settings/encryption-key
CreateSettingsReportingEulaItem Post /platform/3/cloud/settings/reporting-eula
DeleteCloudAccessGuid Delete /platform/3/cloud/access/{CloudAccessGuid}
DeleteCloudAccount Delete /platform/4/cloud/accounts/{CloudAccountId}
DeleteCloudPool Delete /platform/3/cloud/pools/{CloudPoolId}
DeleteCloudProxy Delete /platform/4/cloud/proxies/{CloudProxyId}
DeleteSettingsReportingEula Delete /platform/3/cloud/settings/reporting-eula
GetCloudAccessGuid Get /platform/3/cloud/access/{CloudAccessGuid}
GetCloudAccount Get /platform/4/cloud/accounts/{CloudAccountId}
GetCloudJob Get /platform/3/cloud/jobs/{CloudJobId}
GetCloudJobsFile Get /platform/3/cloud/jobs-files/{CloudJobsFileId}
GetCloudPool Get /platform/3/cloud/pools/{CloudPoolId}
GetCloudProxy Get /platform/4/cloud/proxies/{CloudProxyId}
GetCloudSettings Get /platform/3/cloud/settings
ListCloudAccess Get /platform/3/cloud/access
ListCloudAccounts Get /platform/4/cloud/accounts
ListCloudJobs Get /platform/3/cloud/jobs
ListCloudPools Get /platform/3/cloud/pools
ListCloudProxies Get /platform/4/cloud/proxies
ListSettingsReportingEula Get /platform/3/cloud/settings/reporting-eula
UpdateCloudAccount Put /platform/4/cloud/accounts/{CloudAccountId}
UpdateCloudJob Put /platform/3/cloud/jobs/{CloudJobId}
UpdateCloudPool Put /platform/3/cloud/pools/{CloudPoolId}
UpdateCloudProxy Put /platform/4/cloud/proxies/{CloudProxyId}
UpdateCloudSettings Put /platform/3/cloud/settings

CreateCloudAccessItem

Empty CreateCloudAccessItem(ctx, cloudAccessItem)

Add a cluster identifier to access list.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
cloudAccessItem CloudAccessItem

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]

CreateCloudAccount

CreateCloudAccountResponse CreateCloudAccount(ctx, cloudAccount)

Create a new account.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
cloudAccount CloudAccountCreateParams

Return type

CreateCloudAccountResponse

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]

CreateCloudJob

CreateCloudJobResponse CreateCloudJob(ctx, cloudJob)

Create a new job.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
cloudJob CloudJobCreateParams

Return type

CreateCloudJobResponse

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]

CreateCloudPool

CreateCloudPoolResponse CreateCloudPool(ctx, cloudPool)

Create a new pool.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
cloudPool CloudPoolCreateParams

Return type

CreateCloudPoolResponse

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]

CreateCloudProxy

CreateCloudProxyResponse CreateCloudProxy(ctx, cloudProxy)

Create a new proxy.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
cloudProxy CloudProxyCreateParams

Return type

CreateCloudProxyResponse

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]

CreateSettingsEncryptionKeyItem

Empty CreateSettingsEncryptionKeyItem(ctx, settingsEncryptionKeyItem)

Regenerate master encryption key.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
settingsEncryptionKeyItem 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]

CreateSettingsReportingEulaItem

SettingsReportingEulaItem CreateSettingsReportingEulaItem(ctx, settingsReportingEulaItem)

Accept telemetry collection EULA.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
settingsReportingEulaItem SettingsReportingEulaItem

Return type

SettingsReportingEulaItem

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]

DeleteCloudAccessGuid

DeleteCloudAccessGuid(ctx, cloudAccessGuid)

Delete cloud access.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
cloudAccessGuid string Delete cloud access.

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]

DeleteCloudAccount

DeleteCloudAccount(ctx, cloudAccountId, optional)

Delete cloud account.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
cloudAccountId string Delete cloud account.
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
cloudAccountId string Delete cloud account.
acknowledgeForceDelete string A value of 1 acknowledges that the user is deleting data.

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]

DeleteCloudPool

DeleteCloudPool(ctx, cloudPoolId, optional)

Delete a cloud pool.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
cloudPoolId string Delete a cloud pool.
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
cloudPoolId string Delete a cloud pool.
acknowledgeForceDelete string A value of 1 acknowledges that the user is deleting data.

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]

DeleteCloudProxy

DeleteCloudProxy(ctx, cloudProxyId)

Delete cloud account.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
cloudProxyId string Delete cloud account.

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]

DeleteSettingsReportingEula

DeleteSettingsReportingEula(ctx, )

Revoke acceptance of telemetry collection EULA.

Required Parameters

This endpoint does not need any parameter.

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]

GetCloudAccessGuid

CloudAccess GetCloudAccessGuid(ctx, cloudAccessGuid)

Retrieve cloud access information.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
cloudAccessGuid string Retrieve cloud access information.

Return type

CloudAccess

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]

GetCloudAccount

CloudAccounts GetCloudAccount(ctx, cloudAccountId)

Retrieve cloud account information.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
cloudAccountId string Retrieve cloud account information.

Return type

CloudAccounts

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]

GetCloudJob

CloudJobs GetCloudJob(ctx, cloudJobId)

Retrieve cloudpool job information.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
cloudJobId string Retrieve cloudpool job information.

Return type

CloudJobs

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]

GetCloudJobsFile

CloudJobsFiles GetCloudJobsFile(ctx, cloudJobsFileId, optional)

Retrieve files associated with a cloudpool job.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
cloudJobsFileId string Retrieve files associated with a cloudpool job.
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
cloudJobsFileId string Retrieve files associated with a cloudpool job.
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).
batch bool If true, only "limit" and "page" arguments are honored. Query will return all results, unsorted, as quickly as possible.
limit int32 Return no more than this many results at once (see resume).
page int32 Works only when "batch" parameter and "limit" parameters are specified. Indicates which the page index of results to be returned
dir string The direction of the sort.

Return type

CloudJobsFiles

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]

GetCloudPool

CloudPools GetCloudPool(ctx, cloudPoolId)

Retrieve cloud pool information

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
cloudPoolId string Retrieve cloud pool information

Return type

CloudPools

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]

GetCloudProxy

CloudProxies GetCloudProxy(ctx, cloudProxyId)

Retrieve cloud account information.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
cloudProxyId string Retrieve cloud account information.

Return type

CloudProxies

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]

GetCloudSettings

CloudSettings GetCloudSettings(ctx, )

List all cloud settings.

Required Parameters

This endpoint does not need any parameter.

Return type

CloudSettings

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]

ListCloudAccess

CloudAccessExtended ListCloudAccess(ctx, optional)

List all accessible cluster identifiers.

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.
limit int32 Return no more than this many results at once (see resume).
dir string The direction of the sort.

Return type

CloudAccessExtended

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]

ListCloudAccounts

CloudAccountsExtended ListCloudAccounts(ctx, optional)

List all accounts.

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.
limit int32 Return no more than this many results at once (see resume).
dir string The direction of the sort.

Return type

CloudAccountsExtended

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]

ListCloudJobs

CloudJobsExtended ListCloudJobs(ctx, optional)

List all cloudpools 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.
limit int32 Return no more than this many results at once (see resume).
dir string The direction of the sort.

Return type

CloudJobsExtended

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]

ListCloudPools

CloudPoolsExtended ListCloudPools(ctx, optional)

List all pools.

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.
limit int32 Return no more than this many results at once (see resume).
dir string The direction of the sort.

Return type

CloudPoolsExtended

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]

ListCloudProxies

CloudProxiesExtended ListCloudProxies(ctx, optional)

List all proxies.

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.
limit int32 Return no more than this many results at once (see resume).
dir string The direction of the sort.

Return type

CloudProxiesExtended

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]

ListSettingsReportingEula

SettingsReportingEulaItem ListSettingsReportingEula(ctx, )

View telemetry collection EULA acceptance and content URI.

Required Parameters

This endpoint does not need any parameter.

Return type

SettingsReportingEulaItem

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]

UpdateCloudAccount

UpdateCloudAccount(ctx, cloudAccount, cloudAccountId)

Modify cloud account. All 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.
cloudAccount CloudAccount
cloudAccountId string Modify cloud account. All fields are optional, but one or more must be supplied.

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]

UpdateCloudJob

UpdateCloudJob(ctx, cloudJob, cloudJobId)

Modify a cloud job or operation.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
cloudJob CloudJob
cloudJobId string Modify a cloud job or operation.

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]

UpdateCloudPool

UpdateCloudPool(ctx, cloudPool, cloudPoolId)

Modify a cloud pool. All 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.
cloudPool CloudPool
cloudPoolId string Modify a cloud pool. All fields are optional, but one or more must be supplied.

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]

UpdateCloudProxy

UpdateCloudProxy(ctx, cloudProxy, cloudProxyId)

Modify cloud account. All 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.
cloudProxy CloudProxy
cloudProxyId string Modify cloud account. All fields are optional, but one or more must be supplied.

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]

UpdateCloudSettings

UpdateCloudSettings(ctx, cloudSettings)

Modify one or more settings.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
cloudSettings CloudSettingsSettings

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]