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

     1  # Go API client for swagger
     2  
     3  Search Engine Service(VPC) Open API<br/>https://vpcsearchengine.apigw.ntruss.com/api/v2)
     4  
     5  ## Overview
     6  This API client was generated by the [swagger-codegen](https://github.com/swagger-api/swagger-codegen) project.  By using the [swagger-spec](https://github.com/swagger-api/swagger-spec) from a remote server, you can easily generate an API client.
     7  
     8  - API version: 1.0.0
     9  - Package version: 1.0.0
    10  - Build package: io.swagger.codegen.languages.GoClientCodegen
    11  
    12  ## Installation
    13  Put the package under your project folder and add the following in import:
    14  ```golang
    15  import "./vses2"
    16  ```
    17  
    18  ## Documentation for API Endpoints
    19  
    20  All URIs are relative to *https://vpcsearchengine.apigw.ntruss.com/api/v2*
    21  
    22  Class | Method | HTTP request | Description
    23  ------------ | ------------- | ------------- | -------------
    24  *v2Api* | [**AddNodesInClusterUsingPOST**](docs/v2Api.md#addnodesinclusterusingpost) | **Post** /cluster/addNodesInCluster/{service-group-no} | Add Nodes In Cluster
    25  *v2Api* | [**CreateClusterUsingPOST**](docs/v2Api.md#createclusterusingpost) | **Post** /cluster/createCluster | Create Search Engine Cluster
    26  *v2Api* | [**DeleteClusterUsingDELETE**](docs/v2Api.md#deleteclusterusingdelete) | **Delete** /cluster/deleteCluster/{service-group-no} | Delete Search Engine Cluster
    27  *v2Api* | [**GetAcgInfoListUsingGET**](docs/v2Api.md#getacginfolistusingget) | **Get** /cluster/getAcgInfoList/{service-group-no} | Get Search Engine Cluster ACG Information
    28  *v2Api* | [**GetClusterInfoUsingGET**](docs/v2Api.md#getclusterinfousingget) | **Get** /cluster/getClusterInfo/{service-group-no} | Get Search Engine Cluster
    29  *v2Api* | [**GetClusterNodeListUsingGET**](docs/v2Api.md#getclusternodelistusingget) | **Get** /cluster/getClusterNodeList/{service-group-no} | Get Search Engine Cluster Node List
    30  *v2Api* | [**GetNodeProductListWithGetMethodUsingGET**](docs/v2Api.md#getnodeproductlistwithgetmethodusingget) | **Get** /cluster/getNodeProductList | Get Node Product List
    31  *v2Api* | [**GetOsProductListUsingGET**](docs/v2Api.md#getosproductlistusingget) | **Get** /cluster/getOsProductList | Get Software Product List
    32  *v2Api* | [**GetSearchEngineVersionListUsingGET**](docs/v2Api.md#getsearchengineversionlistusingget) | **Get** /cluster/getSearchEngineVersionList | Get Search Engine Version List
    33  *v2Api* | [**RestartClusterUsingGET**](docs/v2Api.md#restartclusterusingget) | **Get** /cluster/restartCluster/{service-group-no} | Restart Search Engine Cluster
    34  
    35  
    36  ## Documentation For Models
    37  
    38   - [AcgRuleResponseDetailVo](docs/AcgRuleResponseDetailVo.md)
    39   - [AddNodesInClusterRequestVo](docs/AddNodesInClusterRequestVo.md)
    40   - [CreateClusterRequestVo](docs/CreateClusterRequestVo.md)
    41   - [CreateClusterResponseVo](docs/CreateClusterResponseVo.md)
    42   - [DateTimeVo](docs/DateTimeVo.md)
    43   - [GetOpenApiAccessControlGroupRuleListResponseVo](docs/GetOpenApiAccessControlGroupRuleListResponseVo.md)
    44   - [GetOpenApiAcgInfoList](docs/GetOpenApiAcgInfoList.md)
    45   - [GetOpenApiHwProductListResponseVo](docs/GetOpenApiHwProductListResponseVo.md)
    46   - [GetOpenApiOsProductListResponseVo](docs/GetOpenApiOsProductListResponseVo.md)
    47   - [GetOpenApiServiceGroupResponseVo](docs/GetOpenApiServiceGroupResponseVo.md)
    48   - [GetSearchEngineVersionListResponseVo](docs/GetSearchEngineVersionListResponseVo.md)
    49   - [OpenApiGetClusterInfoResponseVo](docs/OpenApiGetClusterInfoResponseVo.md)
    50   - [OpenApiGetComputeInstanceListResponseDetailVo](docs/OpenApiGetComputeInstanceListResponseDetailVo.md)
    51   - [OpenApiHwProductVo](docs/OpenApiHwProductVo.md)
    52   - [OpenApiOsProductVo](docs/OpenApiOsProductVo.md)
    53   - [ResponseVoCreateClusterResponseVo](docs/ResponseVoCreateClusterResponseVo.md)
    54   - [ResponseVoGetOpenApiAcgInfoList](docs/ResponseVoGetOpenApiAcgInfoList.md)
    55   - [ResponseVoGetOpenApiHwProductListResponseVo](docs/ResponseVoGetOpenApiHwProductListResponseVo.md)
    56   - [ResponseVoGetOpenApiOsProductListResponseVo](docs/ResponseVoGetOpenApiOsProductListResponseVo.md)
    57   - [ResponseVoGetOpenApiServiceGroupResponseVo](docs/ResponseVoGetOpenApiServiceGroupResponseVo.md)
    58   - [ResponseVoGetSearchEngineVersionListResponseVo](docs/ResponseVoGetSearchEngineVersionListResponseVo.md)
    59   - [ResponseVoOpenApiGetClusterInfoResponseVo](docs/ResponseVoOpenApiGetClusterInfoResponseVo.md)
    60   - [ResponseVoboolean](docs/ResponseVoboolean.md)
    61   - [SearchEngineVersion](docs/SearchEngineVersion.md)
    62  
    63  
    64  ## Documentation For Authorization
    65  
    66  ## x-ncp-iam
    67  - **Type**: API key
    68  
    69  Example
    70  ```golang
    71  auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{
    72  	Key: "APIKEY",
    73  	Prefix: "Bearer", // Omit if not necessary.
    74  })
    75  r, err := client.Service.Operation(auth, args)
    76  ```
    77  
    78  ## Author
    79  
    80