github.com/NaverCloudPlatform/ncloud-sdk-go-v2@v1.6.13/services/vses2/docs/V2Api.md (about)

     1  # \v2Api
     2  
     3  All URIs are relative to *https://vpcsearchengine.apigw.ntruss.com/api/v2*
     4  
     5  Method | HTTP request                                            | Description
     6  ------------- |---------------------------------------------------------| -------------
     7  [**AddNodesInClusterUsingPOST**](v2Api.md#AddNodesInClusterUsingPOST) | **Post** /cluster/addNodesInCluster/{service-group-no}  | Add Nodes In Cluster
     8  [**CreateClusterUsingPOST**](v2Api.md#CreateClusterUsingPOST) | **Post** /cluster/createCluster                         | Create Search Engine Cluster
     9  [**DeleteClusterUsingDELETE**](v2Api.md#DeleteClusterUsingDELETE) | **Delete** /cluster/deleteCluster/{service-group-no}    | Delete Search Engine Cluster
    10  [**GetAcgInfoListUsingGET**](v2Api.md#GetAcgInfoListUsingGET) | **Get** /cluster/getAcgInfoList/{service-group-no}      | Get Search Engine Cluster ACG Information
    11  [**GetClusterInfoUsingGET**](v2Api.md#GetClusterInfoUsingGET) | **Get** /cluster/getClusterInfo/{service-group-no}      | Get Search Engine Cluster
    12  [**GetClusterNodeListUsingGET**](v2Api.md#GetClusterNodeListUsingGET) | **Get** /cluster/getClusterNodeList/{service-group-no}  | Get Search Engine Cluster Node List
    13  [**GetNodeProductListWithGetMethodUsingGET**](v2Api.md#GetNodeProductListWithGetMethodUsingGET) | **Get** /cluster/getNodeProductList                     | Get Node Product List
    14  [**GetOsProductListUsingGET**](v2Api.md#GetOsProductListUsingGET) | **Get** /cluster/getOsProductList                       | Get Software Product List
    15  [**GetSearchEngineVersionListUsingGET**](v2Api.md#GetSearchEngineVersionListUsingGET) | **Get** /cluster/getSearchEngineVersionList             | Get Search Engine Version List
    16  [**ResetSearchEngineUserPasswordUsingPOST**](v2Api.md#resetadminpassworduUsingPost) | **Post** /cluster/resetSearchEngineUserPassword/{service-group-no} | Reset Search Engine User Password
    17  [**RestartClusterUsingGET**](v2Api.md#RestartClusterUsingGET) | **Get** /cluster/restartCluster/{service-group-no}      | Restart Search Engine Cluster
    18  [**ChangeSpecNodeUsingPOST1**](v2Api.md#RestartClusterUsingGET) | **Get** /cluster/restartCluster/{service-group-no}      | Restart Search Engine Cluster
    19  
    20  
    21  # **AddNodesInClusterUsingPOST**
    22  > ResponseVoboolean AddNodesInClusterUsingPOST(ctx, serviceGroupNo, changeCountOfDataNode)
    23  Add Nodes In Cluster
    24  
    25  ### Required Parameters
    26  
    27  Name | Type | Description  | Notes
    28  ------------- | ------------- | ------------- | -------------
    29   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    30    **serviceGroupNo** | **string**| service-group-no | 
    31    **changeCountOfDataNode** | [**AddNodesInClusterRequestVo**](AddNodesInClusterRequestVo.md)| changeCountOfDataNode | 
    32  
    33  ### Return type
    34  
    35  [**ResponseVoboolean**](ResponseVo«boolean».md)
    36  
    37  ### Authorization
    38  
    39  [x-ncp-iam](../README.md#x-ncp-iam)
    40  
    41  ### HTTP request headers
    42  
    43   - **Content-Type**: application/json
    44   - **Accept**: application/json, */*
    45  
    46  [[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)
    47  
    48  # **CreateClusterUsingPOST**
    49  > ResponseVoCreateClusterResponseVo CreateClusterUsingPOST(ctx, createCluster)
    50  Create Search Engine Cluster
    51  
    52  ### Required Parameters
    53  
    54  Name | Type | Description  | Notes
    55  ------------- | ------------- | ------------- | -------------
    56   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    57    **createCluster** | [**CreateClusterRequestVo**](CreateClusterRequestVo.md)| createCluster | 
    58  
    59  ### Return type
    60  
    61  [**ResponseVoCreateClusterResponseVo**](ResponseVo«CreateClusterResponseVo».md)
    62  
    63  ### Authorization
    64  
    65  [x-ncp-iam](../README.md#x-ncp-iam)
    66  
    67  ### HTTP request headers
    68  
    69   - **Content-Type**: application/json
    70   - **Accept**: application/json, application/json;charset=UTF-8
    71  
    72  [[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)
    73  
    74  # **DeleteClusterUsingDELETE**
    75  > ResponseVoboolean DeleteClusterUsingDELETE(ctx, serviceGroupNo)
    76  Delete Search Engine Cluster
    77  
    78  ### Required Parameters
    79  
    80  Name | Type | Description  | Notes
    81  ------------- | ------------- | ------------- | -------------
    82   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    83    **serviceGroupNo** | **string**| service-group-no | 
    84  
    85  ### Return type
    86  
    87  [**ResponseVoboolean**](ResponseVo«boolean».md)
    88  
    89  ### Authorization
    90  
    91  [x-ncp-iam](../README.md#x-ncp-iam)
    92  
    93  ### HTTP request headers
    94  
    95   - **Content-Type**: application/json
    96   - **Accept**: application/json, */*
    97  
    98  [[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)
    99  
   100  # **GetAcgInfoListUsingGET**
   101  > ResponseVoGetOpenApiAcgInfoList GetAcgInfoListUsingGET(ctx, serviceGroupNo)
   102  Get Search Engine Cluster ACG Information
   103  
   104  ### Required Parameters
   105  
   106  Name | Type | Description  | Notes
   107  ------------- | ------------- | ------------- | -------------
   108   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   109    **serviceGroupNo** | **string**| service-group-no | 
   110  
   111  ### Return type
   112  
   113  [**ResponseVoGetOpenApiAcgInfoList**](ResponseVo«GetOpenApiAcgInfoList».md)
   114  
   115  ### Authorization
   116  
   117  [x-ncp-iam](../README.md#x-ncp-iam)
   118  
   119  ### HTTP request headers
   120  
   121   - **Content-Type**: application/json
   122   - **Accept**: application/json, */*
   123  
   124  [[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)
   125  
   126  # **GetClusterInfoUsingGET**
   127  > ResponseVoOpenApiGetClusterInfoResponseVo GetClusterInfoUsingGET(ctx, serviceGroupNo)
   128  Get Search Engine Cluster
   129  
   130  ### Required Parameters
   131  
   132  Name | Type | Description  | Notes
   133  ------------- | ------------- | ------------- | -------------
   134   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   135    **serviceGroupNo** | **string**| service-group-no | 
   136  
   137  ### Return type
   138  
   139  [**ResponseVoOpenApiGetClusterInfoResponseVo**](ResponseVo«OpenApiGetClusterInfoResponseVo».md)
   140  
   141  ### Authorization
   142  
   143  [x-ncp-iam](../README.md#x-ncp-iam)
   144  
   145  ### HTTP request headers
   146  
   147   - **Content-Type**: application/json
   148   - **Accept**: application/json, */*
   149  
   150  [[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)
   151  
   152  # **GetClusterNodeListUsingGET**
   153  > ResponseVoGetOpenApiServiceGroupResponseVo GetClusterNodeListUsingGET(ctx, serviceGroupNo)
   154  Get Search Engine Cluster Node List
   155  
   156  ### Required Parameters
   157  
   158  Name | Type | Description  | Notes
   159  ------------- | ------------- | ------------- | -------------
   160   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   161    **serviceGroupNo** | **string**| service-group-no | 
   162  
   163  ### Return type
   164  
   165  [**ResponseVoGetOpenApiServiceGroupResponseVo**](ResponseVo«GetOpenApiServiceGroupResponseVo».md)
   166  
   167  ### Authorization
   168  
   169  [x-ncp-iam](../README.md#x-ncp-iam)
   170  
   171  ### HTTP request headers
   172  
   173   - **Content-Type**: application/json
   174   - **Accept**: application/json, */*
   175  
   176  [[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)
   177  
   178  # **GetNodeProductListWithGetMethodUsingGET**
   179  > ResponseVoGetOpenApiHwProductListResponseVo GetNodeProductListWithGetMethodUsingGET(ctx, optional)
   180  Get Node Product List
   181  
   182  ### Required Parameters
   183  
   184  Name | Type | Description  | Notes
   185  ------------- | ------------- | ------------- | -------------
   186   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   187   **optional** | ***v2ApiGetNodeProductListWithGetMethodUsingGETOpts** | optional parameters | nil if no parameters
   188  
   189  ### Optional Parameters
   190  Optional parameters are passed through a pointer to a v2ApiGetNodeProductListWithGetMethodUsingGETOpts struct
   191  
   192  Name | Type | Description  | Notes
   193  ------------- | ------------- | ------------- | -------------
   194   **infraResourceTypeCode** | **optional.String**|  | 
   195   **softwareTypeCode** | **optional.String**|  | 
   196   **softwareProductCode** | **optional.String**|  | 
   197   **memberNo** | **optional.String**|  | 
   198   **regionNo** | **optional.String**|  | 
   199   **zoneNo** | **optional.Int32**|  | 
   200   **subnetNo** | **optional.Int32**|  | 
   201  
   202  ### Return type
   203  
   204  [**ResponseVoGetOpenApiHwProductListResponseVo**](ResponseVo«GetOpenApiHwProductListResponseVo».md)
   205  
   206  ### Authorization
   207  
   208  [x-ncp-iam](../README.md#x-ncp-iam)
   209  
   210  ### HTTP request headers
   211  
   212   - **Content-Type**: application/json
   213   - **Accept**: application/json, */*
   214  
   215  [[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)
   216  
   217  # **GetOsProductListUsingGET**
   218  > ResponseVoGetOpenApiOsProductListResponseVo GetOsProductListUsingGET(ctx, )
   219  Get Software Product List
   220  
   221  ### Required Parameters
   222  This endpoint does not need any parameter.
   223  
   224  ### Return type
   225  
   226  [**ResponseVoGetOpenApiOsProductListResponseVo**](ResponseVo«GetOpenApiOsProductListResponseVo».md)
   227  
   228  ### Authorization
   229  
   230  [x-ncp-iam](../README.md#x-ncp-iam)
   231  
   232  ### HTTP request headers
   233  
   234   - **Content-Type**: application/json
   235   - **Accept**: application/json, */*
   236  
   237  [[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)
   238  
   239  # **GetSearchEngineVersionListUsingGET**
   240  > ResponseVoGetSearchEngineVersionListResponseVo GetSearchEngineVersionListUsingGET(ctx, )
   241  Get Search Engine Version List
   242  
   243  ### Required Parameters
   244  This endpoint does not need any parameter.
   245  
   246  ### Return type
   247  
   248  [**ResponseVoGetSearchEngineVersionListResponseVo**](ResponseVo«GetSearchEngineVersionListResponseVo».md)
   249  
   250  ### Authorization
   251  
   252  [x-ncp-iam](../README.md#x-ncp-iam)
   253  
   254  ### HTTP request headers
   255  
   256   - **Content-Type**: application/json
   257   - **Accept**: application/json, */*
   258  
   259  [[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)
   260  
   261  # **RestartClusterUsingGET**
   262  > ResponseVoboolean RestartClusterUsingGET(ctx, serviceGroupNo)
   263  Restart Search Engine Cluster
   264  
   265  ### Required Parameters
   266  
   267  Name | Type | Description  | Notes
   268  ------------- | ------------- | ------------- | -------------
   269   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   270    **serviceGroupNo** | **string**| service-group-no | 
   271  
   272  ### Return type
   273  
   274  [**ResponseVoboolean**](ResponseVo«boolean».md)
   275  
   276  ### Authorization
   277  
   278  [x-ncp-iam](../README.md#x-ncp-iam)
   279  
   280  ### HTTP request headers
   281  
   282   - **Content-Type**: application/json
   283   - **Accept**: application/json, */*
   284  
   285  [[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)
   286  
   287  # **ChangeSpecNodeUsingPOST1**
   288  > ResponseVoChangeSpecNodeResponseVo ChangeSpecNodeUsingPOST1(ctx, serviceGroupNo, request)
   289  Change Node Spec
   290  
   291  ### Required Parameters
   292  
   293  Name | Type | Description  | Notes
   294  ------------- | ------------- | ------------- | -------------
   295  **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   296  **serviceGroupNo** | **string**| service-group-no |
   297  **request** | [**ChangeSpecNodeRequestVo**](ChangeSpecNodeRequestVo.md)| request |
   298  
   299  
   300  ### Return type
   301  
   302  [**ResponseVoChangeSpecNodeResponseVo**](ResponseVo«ChangeSpecNodeResponseVo».md)
   303  
   304  ### Authorization
   305  
   306  [x-ncp-iam](../README.md#x-ncp-iam)
   307  
   308  ### HTTP request headers
   309  
   310  - **Content-Type**: application/json
   311  - **Accept**: application/json, */*
   312  
   313  [[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)