github.com/spinnaker/spin@v1.30.0/gateapi/docs/LoadBalancerControllerApi.md (about)

     1  # \LoadBalancerControllerApi
     2  
     3  All URIs are relative to *https://localhost*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**GetAllUsingGET**](LoadBalancerControllerApi.md#GetAllUsingGET) | **Get** /loadBalancers | Retrieve a list of load balancers for a given cloud provider
     8  [**GetApplicationLoadBalancersUsingGET**](LoadBalancerControllerApi.md#GetApplicationLoadBalancersUsingGET) | **Get** /applications/{application}/loadBalancers | Retrieve a list of load balancers for a given application
     9  [**GetLoadBalancerDetailsUsingGET**](LoadBalancerControllerApi.md#GetLoadBalancerDetailsUsingGET) | **Get** /loadBalancers/{account}/{region}/{name} | Retrieve a load balancer's details as a single element list for a given account, region, cloud provider and load balancer name
    10  [**GetLoadBalancerUsingGET**](LoadBalancerControllerApi.md#GetLoadBalancerUsingGET) | **Get** /loadBalancers/{name} | Retrieve a load balancer for a given cloud provider
    11  
    12  
    13  # **GetAllUsingGET**
    14  > []interface{} GetAllUsingGET(ctx, optional)
    15  Retrieve a list of load balancers for a given cloud provider
    16  
    17  ### Required Parameters
    18  
    19  Name | Type | Description  | Notes
    20  ------------- | ------------- | ------------- | -------------
    21   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    22   **optional** | ***LoadBalancerControllerApiGetAllUsingGETOpts** | optional parameters | nil if no parameters
    23  
    24  ### Optional Parameters
    25  Optional parameters are passed through a pointer to a LoadBalancerControllerApiGetAllUsingGETOpts struct
    26  
    27  Name | Type | Description  | Notes
    28  ------------- | ------------- | ------------- | -------------
    29   **xRateLimitApp** | **optional.String**| X-RateLimit-App | 
    30   **provider** | **optional.String**| provider | [default to aws]
    31  
    32  ### Return type
    33  
    34  [**[]interface{}**](interface{}.md)
    35  
    36  ### Authorization
    37  
    38  No authorization required
    39  
    40  ### HTTP request headers
    41  
    42   - **Content-Type**: Not defined
    43   - **Accept**: */*
    44  
    45  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
    46  
    47  # **GetApplicationLoadBalancersUsingGET**
    48  > []interface{} GetApplicationLoadBalancersUsingGET(ctx, application, optional)
    49  Retrieve a list of load balancers for a given application
    50  
    51  ### Required Parameters
    52  
    53  Name | Type | Description  | Notes
    54  ------------- | ------------- | ------------- | -------------
    55   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    56    **application** | **string**| application | 
    57   **optional** | ***LoadBalancerControllerApiGetApplicationLoadBalancersUsingGETOpts** | optional parameters | nil if no parameters
    58  
    59  ### Optional Parameters
    60  Optional parameters are passed through a pointer to a LoadBalancerControllerApiGetApplicationLoadBalancersUsingGETOpts struct
    61  
    62  Name | Type | Description  | Notes
    63  ------------- | ------------- | ------------- | -------------
    64  
    65   **xRateLimitApp** | **optional.String**| X-RateLimit-App | 
    66  
    67  ### Return type
    68  
    69  [**[]interface{}**](interface{}.md)
    70  
    71  ### Authorization
    72  
    73  No authorization required
    74  
    75  ### HTTP request headers
    76  
    77   - **Content-Type**: Not defined
    78   - **Accept**: */*
    79  
    80  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
    81  
    82  # **GetLoadBalancerDetailsUsingGET**
    83  > []interface{} GetLoadBalancerDetailsUsingGET(ctx, account, name, region, optional)
    84  Retrieve a load balancer's details as a single element list for a given account, region, cloud provider and load balancer name
    85  
    86  ### Required Parameters
    87  
    88  Name | Type | Description  | Notes
    89  ------------- | ------------- | ------------- | -------------
    90   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    91    **account** | **string**| account | 
    92    **name** | **string**| name | 
    93    **region** | **string**| region | 
    94   **optional** | ***LoadBalancerControllerApiGetLoadBalancerDetailsUsingGETOpts** | optional parameters | nil if no parameters
    95  
    96  ### Optional Parameters
    97  Optional parameters are passed through a pointer to a LoadBalancerControllerApiGetLoadBalancerDetailsUsingGETOpts struct
    98  
    99  Name | Type | Description  | Notes
   100  ------------- | ------------- | ------------- | -------------
   101  
   102  
   103  
   104   **xRateLimitApp** | **optional.String**| X-RateLimit-App | 
   105   **provider** | **optional.String**| provider | [default to aws]
   106  
   107  ### Return type
   108  
   109  [**[]interface{}**](interface{}.md)
   110  
   111  ### Authorization
   112  
   113  No authorization required
   114  
   115  ### HTTP request headers
   116  
   117   - **Content-Type**: Not defined
   118   - **Accept**: */*
   119  
   120  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   121  
   122  # **GetLoadBalancerUsingGET**
   123  > map[string]interface{} GetLoadBalancerUsingGET(ctx, name, optional)
   124  Retrieve a load balancer for a given cloud provider
   125  
   126  ### Required Parameters
   127  
   128  Name | Type | Description  | Notes
   129  ------------- | ------------- | ------------- | -------------
   130   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   131    **name** | **string**| name | 
   132   **optional** | ***LoadBalancerControllerApiGetLoadBalancerUsingGETOpts** | optional parameters | nil if no parameters
   133  
   134  ### Optional Parameters
   135  Optional parameters are passed through a pointer to a LoadBalancerControllerApiGetLoadBalancerUsingGETOpts struct
   136  
   137  Name | Type | Description  | Notes
   138  ------------- | ------------- | ------------- | -------------
   139  
   140   **xRateLimitApp** | **optional.String**| X-RateLimit-App | 
   141   **provider** | **optional.String**| provider | [default to aws]
   142  
   143  ### Return type
   144  
   145  [**map[string]interface{}**](interface{}.md)
   146  
   147  ### Authorization
   148  
   149  No authorization required
   150  
   151  ### HTTP request headers
   152  
   153   - **Content-Type**: Not defined
   154   - **Accept**: */*
   155  
   156  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   157