Skip to content

Latest commit

 

History

History
299 lines (182 loc) · 9.55 KB

CloudInstanceApi.md

File metadata and controls

299 lines (182 loc) · 9.55 KB
Raw

\CloudInstanceApi

All URIs are relative to https://teamcity.jetbrains.com

Method HTTP request Description
GetAllCloudImages Get /app/rest/cloud/images Get all cloud images.
GetAllCloudInstances Get /app/rest/cloud/instances Get all cloud instances.
GetAllCloudProfiles Get /app/rest/cloud/profiles Get all cloud profiles.
GetCloudImage Get /app/rest/cloud/images/{imageLocator} Get cloud image matching the locator.
GetCloudInstance Get /app/rest/cloud/instances/{instanceLocator} Get cloud instance matching the locator.
GetCloudProfile Get /app/rest/cloud/profiles/{profileLocator} Get cloud profile matching the locator.
StartInstance Post /app/rest/cloud/instances Start a new cloud instance.
StopInstance Delete /app/rest/cloud/instances/{instanceLocator} Stop cloud instance matching the locator.

GetAllCloudImages

CloudImages GetAllCloudImages(ctx, optional) Get all cloud images.

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a GetAllCloudImagesOpts struct

Name Type Description Notes
locator optional.String
fields optional.String

Return type

CloudImages

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/xml, application/json

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

GetAllCloudInstances

CloudInstances GetAllCloudInstances(ctx, optional) Get all cloud instances.

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a GetAllCloudInstancesOpts struct

Name Type Description Notes
locator optional.String
fields optional.String

Return type

CloudInstances

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/xml, application/json

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

GetAllCloudProfiles

CloudProfiles GetAllCloudProfiles(ctx, optional) Get all cloud profiles.

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a GetAllCloudProfilesOpts struct

Name Type Description Notes
locator optional.String
fields optional.String

Return type

CloudProfiles

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/xml, application/json

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

GetCloudImage

CloudImage GetCloudImage(ctx, imageLocator, optional) Get cloud image matching the locator.

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a GetCloudImageOpts struct

Name Type Description Notes

fields | optional.String| |

Return type

CloudImage

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/xml, application/json

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

GetCloudInstance

CloudInstance GetCloudInstance(ctx, instanceLocator, optional) Get cloud instance matching the locator.

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a GetCloudInstanceOpts struct

Name Type Description Notes

fields | optional.String| |

Return type

CloudInstance

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/xml, application/json

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

GetCloudProfile

CloudProfile GetCloudProfile(ctx, profileLocator, optional) Get cloud profile matching the locator.

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a GetCloudProfileOpts struct

Name Type Description Notes

fields | optional.String| |

Return type

CloudProfile

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/xml, application/json

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

StartInstance

StartInstance(ctx, optional) Start a new cloud instance.

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a StartInstanceOpts struct

Name Type Description Notes
body optional.Interface of CloudInstance
fields optional.String

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

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

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

StopInstance

StopInstance(ctx, instanceLocator) Stop cloud instance matching the locator.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
instanceLocator string

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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