Skip to content

Latest commit

 

History

History
340 lines (212 loc) · 12.3 KB

ClusterControllerApi.md

File metadata and controls

340 lines (212 loc) · 12.3 KB
Raw

\ClusterControllerApi

All URIs are relative to https://localhost

Method HTTP request Description
GetClusterLoadBalancersUsingGET Get /applications/{application}/clusters/{account}/{clusterName}/{type}/loadBalancers Retrieve a cluster's loadbalancers
GetClustersUsingGET Get /applications/{application}/clusters/{account}/{clusterName} Retrieve a cluster's details
GetClustersUsingGET1 Get /applications/{application}/clusters/{account} Retrieve a list of clusters for an account
GetClustersUsingGET2 Get /applications/{application}/clusters Retrieve a list of cluster names for an application, grouped by account
GetScalingActivitiesUsingGET Get /applications/{application}/clusters/{account}/{clusterName}/serverGroups/{serverGroupName}/scalingActivities Retrieve a list of scaling activities for a server group
GetServerGroupsUsingGET Get /applications/{application}/clusters/{account}/{clusterName}/serverGroups/{serverGroupName} Retrieve a server group's details
GetServerGroupsUsingGET1 Get /applications/{application}/clusters/{account}/{clusterName}/serverGroups Retrieve a list of server groups for a cluster
GetTargetServerGroupUsingGET Get /applications/{application}/clusters/{account}/{clusterName}/{cloudProvider}/{scope}/serverGroups/target/{target} Retrieve a server group that matches a target coordinate (e.g., newest, ancestor) relative to a cluster

GetClusterLoadBalancersUsingGET

[]interface{} GetClusterLoadBalancersUsingGET(ctx, account, applicationName, clusterName, type_, optional) Retrieve a cluster's loadbalancers

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
account string account
applicationName string applicationName
clusterName string clusterName
type_ string type
optional *GetClusterLoadBalancersUsingGETOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetClusterLoadBalancersUsingGETOpts struct

Name Type Description Notes

xRateLimitApp | optional.String| X-RateLimit-App |

Return type

[]interface{}

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

GetClustersUsingGET

map[string]interface{} GetClustersUsingGET(ctx, account, application, clusterName, optional) Retrieve a cluster's details

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
account string account
application string application
clusterName string clusterName
optional *GetClustersUsingGETOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetClustersUsingGETOpts struct

Name Type Description Notes

xRateLimitApp | optional.String| X-RateLimit-App |

Return type

map[string]interface{}

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

GetClustersUsingGET1

[]interface{} GetClustersUsingGET1(ctx, account, application, optional) Retrieve a list of clusters for an account

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a GetClustersUsingGET1Opts struct

Name Type Description Notes

xRateLimitApp | optional.String| X-RateLimit-App |

Return type

[]interface{}

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

GetClustersUsingGET2

map[string]interface{} GetClustersUsingGET2(ctx, application, optional) Retrieve a list of cluster names for an application, grouped by account

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a GetClustersUsingGET2Opts struct

Name Type Description Notes

xRateLimitApp | optional.String| X-RateLimit-App |

Return type

map[string]interface{}

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

GetScalingActivitiesUsingGET

[]interface{} GetScalingActivitiesUsingGET(ctx, account, application, clusterName, serverGroupName, optional) Retrieve a list of scaling activities for a server group

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
account string account
application string application
clusterName string clusterName
serverGroupName string serverGroupName
optional *GetScalingActivitiesUsingGETOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetScalingActivitiesUsingGETOpts struct

Name Type Description Notes

xRateLimitApp | optional.String| X-RateLimit-App | provider | optional.String| provider | [default to aws] region | optional.String| region |

Return type

[]interface{}

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

GetServerGroupsUsingGET

[]interface{} GetServerGroupsUsingGET(ctx, account, application, clusterName, serverGroupName, optional) Retrieve a server group's details

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
account string account
application string application
clusterName string clusterName
serverGroupName string serverGroupName
optional *GetServerGroupsUsingGETOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetServerGroupsUsingGETOpts struct

Name Type Description Notes

xRateLimitApp | optional.String| X-RateLimit-App |

Return type

[]interface{}

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

GetServerGroupsUsingGET1

[]interface{} GetServerGroupsUsingGET1(ctx, account, application, clusterName, optional) Retrieve a list of server groups for a cluster

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
account string account
application string application
clusterName string clusterName
optional *GetServerGroupsUsingGET1Opts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetServerGroupsUsingGET1Opts struct

Name Type Description Notes

xRateLimitApp | optional.String| X-RateLimit-App |

Return type

[]interface{}

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

GetTargetServerGroupUsingGET

map[string]interface{} GetTargetServerGroupUsingGET(ctx, account, application, cloudProvider, clusterName, scope, target, optional) Retrieve a server group that matches a target coordinate (e.g., newest, ancestor) relative to a cluster

scope is either a zone or a region

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
account string account
application string application
cloudProvider string cloudProvider
clusterName string clusterName
scope string scope
target string target
optional *GetTargetServerGroupUsingGETOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetTargetServerGroupUsingGETOpts struct

Name Type Description Notes

xRateLimitApp | optional.String| X-RateLimit-App | onlyEnabled | optional.Bool| onlyEnabled | validateOldest | optional.Bool| validateOldest |

Return type

map[string]interface{}

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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