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

     1  # Go API client for swagger
     2  
     3  Search Engine Service(VPC) Open API<br/>https://vpcsearchengine.apigw.ntruss.com/api/v1
     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: 2022-04-21T09:07:51Z
     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 "./vses"
    16  ```
    17  
    18  ## Documentation for API Endpoints
    19  
    20  All URIs are relative to *https://vpcsearchengine.apigw.ntruss.com/api/v1*
    21  
    22  Class | Method | HTTP request | Description
    23  ------------ | ------------- | ------------- | -------------
    24  *V1Api* | [**ClusterChangeCountOfDataNodeServiceGroupInstanceNoPost**](docs/V1Api.md#clusterchangecountofdatanodeservicegroupinstancenopost) | **Post** /cluster/changeCountOfDataNode/{serviceGroupInstanceNo} | 
    25  *V1Api* | [**ClusterCreateElasticsearchClusterPost**](docs/V1Api.md#clustercreateelasticsearchclusterpost) | **Post** /cluster/createElasticsearchCluster | 
    26  *V1Api* | [**ClusterDeleteElasticsearchClusterServiceGroupInstanceNoDelete**](docs/V1Api.md#clusterdeleteelasticsearchclusterservicegroupinstancenodelete) | **Delete** /cluster/deleteElasticsearchCluster/{serviceGroupInstanceNo} | 
    27  *V1Api* | [**ClusterGetAcgInfoListServiceGroupInstanceNoGet**](docs/V1Api.md#clustergetacginfolistservicegroupinstancenoget) | **Get** /cluster/getAcgInfoList/{serviceGroupInstanceNo} | 
    28  *V1Api* | [**ClusterGetClusterDataNodeListServiceGroupInstanceNoGet**](docs/V1Api.md#clustergetclusterdatanodelistservicegroupinstancenoget) | **Get** /cluster/getClusterDataNodeList/{serviceGroupInstanceNo} | 
    29  *V1Api* | [**ClusterGetClusterInfoListPost**](docs/V1Api.md#clustergetclusterinfolistpost) | **Post** /cluster/getClusterInfoList | 
    30  *V1Api* | [**ClusterGetElasticsearchVersionListGet**](docs/V1Api.md#clustergetelasticsearchversionlistget) | **Get** /cluster/getElasticsearchVersionList | 
    31  *V1Api* | [**ClusterGetLoginKeyListGet**](docs/V1Api.md#clustergetloginkeylistget) | **Get** /cluster/getLoginKeyList | 
    32  *V1Api* | [**ClusterGetNodeProductListPost**](docs/V1Api.md#clustergetnodeproductlistpost) | **Post** /cluster/getNodeProductList | 
    33  *V1Api* | [**ClusterGetOsProductListGet**](docs/V1Api.md#clustergetosproductlistget) | **Get** /cluster/getOsProductList | 
    34  *V1Api* | [**ClusterGetSubnetListPost**](docs/V1Api.md#clustergetsubnetlistpost) | **Post** /cluster/getSubnetList | 
    35  *V1Api* | [**ClusterGetVpcListGet**](docs/V1Api.md#clustergetvpclistget) | **Get** /cluster/getVpcList | 
    36  *V1Api* | [**ClusterResetKibanaPasswordServiceGroupInstanceNoPost**](docs/V1Api.md#clusterresetkibanapasswordservicegroupinstancenopost) | **Post** /cluster/resetKibanaPassword/{serviceGroupInstanceNo} | 
    37  *V1Api* | [**ClusterRestartElasticsearchClusterServiceGroupInstanceNoGet**](docs/V1Api.md#clusterrestartelasticsearchclusterservicegroupinstancenoget) | **Get** /cluster/restartElasticsearchCluster/{serviceGroupInstanceNo} | 
    38  *V1Api* | [**DashboardGetDashboardInformationServiceGroupInstanceNoGet**](docs/V1Api.md#dashboardgetdashboardinformationservicegroupinstancenoget) | **Get** /dashboard/getDashboardInformation/{serviceGroupInstanceNo} | 
    39  *V1Api* | [**ImportCreateDataImportJobServiceGroupInstanceNoPost**](docs/V1Api.md#importcreatedataimportjobservicegroupinstancenopost) | **Post** /import/createDataImportJob/{serviceGroupInstanceNo} | 
    40  *V1Api* | [**ImportGetBucketListServiceGroupInstanceNoGet**](docs/V1Api.md#importgetbucketlistservicegroupinstancenoget) | **Get** /import/getBucketList/{serviceGroupInstanceNo} | 
    41  *V1Api* | [**ImportGetDataImportHistoryServiceGroupInstanceNoGet**](docs/V1Api.md#importgetdataimporthistoryservicegroupinstancenoget) | **Get** /import/getDataImportHistory/{serviceGroupInstanceNo} | 
    42  *V1Api* | [**ImportStopDataImportJobServiceGroupInstanceNoGet**](docs/V1Api.md#importstopdataimportjobservicegroupinstancenoget) | **Get** /import/stopDataImportJob/{serviceGroupInstanceNo} | 
    43  *V1Api* | [**MonitoringGetElasticsearchMonitoringDataServiceGroupInstanceNoPost**](docs/V1Api.md#monitoringgetelasticsearchmonitoringdataservicegroupinstancenopost) | **Post** /monitoring/getElasticsearchMonitoringData/{serviceGroupInstanceNo} | 
    44  *V1Api* | [**MonitoringGetOsMonitoringDataServiceGroupInstanceNoPost**](docs/V1Api.md#monitoringgetosmonitoringdataservicegroupinstancenopost) | **Post** /monitoring/getOsMonitoringData/{serviceGroupInstanceNo} | 
    45  *V1Api* | [**SnapshotCreateSnapshotServiceGroupInstanceNoPost**](docs/V1Api.md#snapshotcreatesnapshotservicegroupinstancenopost) | **Post** /snapshot/createSnapshot/{serviceGroupInstanceNo} | 
    46  *V1Api* | [**SnapshotGetBucketListServiceGroupInstanceNoGet**](docs/V1Api.md#snapshotgetbucketlistservicegroupinstancenoget) | **Get** /snapshot/getBucketList/{serviceGroupInstanceNo} | 
    47  *V1Api* | [**SnapshotGetSnapshotHistoryServiceGroupInstanceNoGet**](docs/V1Api.md#snapshotgetsnapshothistoryservicegroupinstancenoget) | **Get** /snapshot/getSnapshotHistory/{serviceGroupInstanceNo} | 
    48  *V1Api* | [**SnapshotGetSnapshotSchedulingHistoryServiceGroupInstanceNoPost**](docs/V1Api.md#snapshotgetsnapshotschedulinghistoryservicegroupinstancenopost) | **Post** /snapshot/getSnapshotSchedulingHistory/{serviceGroupInstanceNo} | 
    49  *V1Api* | [**SnapshotReleaseSnapshotSchedulingServiceGroupInstanceNoGet**](docs/V1Api.md#snapshotreleasesnapshotschedulingservicegroupinstancenoget) | **Get** /snapshot/releaseSnapshotScheduling/{serviceGroupInstanceNo} | 
    50  *V1Api* | [**SnapshotSetSnapshotSchedulingServiceGroupInstanceNoPost**](docs/V1Api.md#snapshotsetsnapshotschedulingservicegroupinstancenopost) | **Post** /snapshot/setSnapshotScheduling/{serviceGroupInstanceNo} | 
    51  *V1Api* | [**SnapshotUpdateAPIAuthenticationKeyServiceGroupInstanceNoPost**](docs/V1Api.md#snapshotupdateapiauthenticationkeyservicegroupinstancenopost) | **Post** /snapshot/updateAPIAuthenticationKey/{serviceGroupInstanceNo} | 
    52  
    53  
    54  ## Documentation For Models
    55  
    56   - [AcgRuleResponseDetailVo](docs/AcgRuleResponseDetailVo.md)
    57   - [AddNodesInCluster](docs/AddNodesInCluster.md)
    58   - [AllowedClusterInfo](docs/AllowedClusterInfo.md)
    59   - [BucketInfo](docs/BucketInfo.md)
    60   - [CatIndice](docs/CatIndice.md)
    61   - [CreateCluster](docs/CreateCluster.md)
    62   - [CreateClusterResponseVo](docs/CreateClusterResponseVo.md)
    63   - [CreateImportJob](docs/CreateImportJob.md)
    64   - [CreateSnapshot](docs/CreateSnapshot.md)
    65   - [DateTimeVo](docs/DateTimeVo.md)
    66   - [DimensionsVo](docs/DimensionsVo.md)
    67   - [DisallowedClusterInfo](docs/DisallowedClusterInfo.md)
    68   - [ElasticSearchVersion](docs/ElasticSearchVersion.md)
    69   - [GetClusterIndicesStatusResponseVo](docs/GetClusterIndicesStatusResponseVo.md)
    70   - [GetClusterRequest](docs/GetClusterRequest.md)
    71   - [GetClusterStatusResponseVo](docs/GetClusterStatusResponseVo.md)
    72   - [GetElasticSearchVersionListResponseVo](docs/GetElasticSearchVersionListResponseVo.md)
    73   - [GetElasticsearchMonitoringData](docs/GetElasticsearchMonitoringData.md)
    74   - [GetImportHistoryListResponseVo](docs/GetImportHistoryListResponseVo.md)
    75   - [GetObjectStorageBucketListResponseVo](docs/GetObjectStorageBucketListResponseVo.md)
    76   - [GetOpenApiAccessControlGroupRuleListResponseVo](docs/GetOpenApiAccessControlGroupRuleListResponseVo.md)
    77   - [GetOpenApiAcgInfoList](docs/GetOpenApiAcgInfoList.md)
    78   - [GetOpenApiDashboardInformationResponseVo](docs/GetOpenApiDashboardInformationResponseVo.md)
    79   - [GetOpenApiHwProductListResponseVo](docs/GetOpenApiHwProductListResponseVo.md)
    80   - [GetOpenApiLoginKeyListResponseVo](docs/GetOpenApiLoginKeyListResponseVo.md)
    81   - [GetOpenApiOsProductListResponseVo](docs/GetOpenApiOsProductListResponseVo.md)
    82   - [GetOpenApiServiceGroupResponseVo](docs/GetOpenApiServiceGroupResponseVo.md)
    83   - [GetOsMonitoringData](docs/GetOsMonitoringData.md)
    84   - [GetSnapshotSchedulingHistory](docs/GetSnapshotSchedulingHistory.md)
    85   - [GetSnapshotSchedulingHistoryResponseVo](docs/GetSnapshotSchedulingHistoryResponseVo.md)
    86   - [GetSubnetList](docs/GetSubnetList.md)
    87   - [GetVpcConfigListResponseDetailVo](docs/GetVpcConfigListResponseDetailVo.md)
    88   - [GetVpcConfigListResponseVo](docs/GetVpcConfigListResponseVo.md)
    89   - [GetVpcSubnetListResponseVo](docs/GetVpcSubnetListResponseVo.md)
    90   - [ImportHistoryVo](docs/ImportHistoryVo.md)
    91   - [MetricInfoResponseVo](docs/MetricInfoResponseVo.md)
    92   - [NodeProduct](docs/NodeProduct.md)
    93   - [OpenApiGetClusterInfoListResponseVo](docs/OpenApiGetClusterInfoListResponseVo.md)
    94   - [OpenApiGetComputeInstanceListResponseDetailVo](docs/OpenApiGetComputeInstanceListResponseDetailVo.md)
    95   - [OpenApiHwProductVo](docs/OpenApiHwProductVo.md)
    96   - [OpenApiLoginKeyVo](docs/OpenApiLoginKeyVo.md)
    97   - [OpenApiOsProductVo](docs/OpenApiOsProductVo.md)
    98   - [QueryMultipleDataResponseVo](docs/QueryMultipleDataResponseVo.md)
    99   - [ResetKibanaPassword](docs/ResetKibanaPassword.md)
   100   - [ResponseVoBoolean](docs/ResponseVoBoolean.md)
   101   - [ResponseVoCreateClusterResponseVo](docs/ResponseVoCreateClusterResponseVo.md)
   102   - [ResponseVoGetElasticSearchVersionListResponseVo](docs/ResponseVoGetElasticSearchVersionListResponseVo.md)
   103   - [ResponseVoGetImportHistoryListResponseVo](docs/ResponseVoGetImportHistoryListResponseVo.md)
   104   - [ResponseVoGetObjectStorageBucketListResponseVo](docs/ResponseVoGetObjectStorageBucketListResponseVo.md)
   105   - [ResponseVoGetOpenApiAcgInfoList](docs/ResponseVoGetOpenApiAcgInfoList.md)
   106   - [ResponseVoGetOpenApiDashboardInformationResponseVo](docs/ResponseVoGetOpenApiDashboardInformationResponseVo.md)
   107   - [ResponseVoGetOpenApiHwProductListResponseVo](docs/ResponseVoGetOpenApiHwProductListResponseVo.md)
   108   - [ResponseVoGetOpenApiLoginKeyListResponseVo](docs/ResponseVoGetOpenApiLoginKeyListResponseVo.md)
   109   - [ResponseVoGetOpenApiOsProductListResponseVo](docs/ResponseVoGetOpenApiOsProductListResponseVo.md)
   110   - [ResponseVoGetOpenApiServiceGroupResponseVo](docs/ResponseVoGetOpenApiServiceGroupResponseVo.md)
   111   - [ResponseVoGetSnapshotSchedulingHistoryResponseVo](docs/ResponseVoGetSnapshotSchedulingHistoryResponseVo.md)
   112   - [ResponseVoGetVpcConfigListResponseVo](docs/ResponseVoGetVpcConfigListResponseVo.md)
   113   - [ResponseVoGetVpcSubnetListResponseVo](docs/ResponseVoGetVpcSubnetListResponseVo.md)
   114   - [ResponseVoOpenApiGetClusterInfoListResponseVo](docs/ResponseVoOpenApiGetClusterInfoListResponseVo.md)
   115   - [ResponseVoQueryMultipleDataResponseVo](docs/ResponseVoQueryMultipleDataResponseVo.md)
   116   - [ResponseVoSnapshotHistoryListResponseVo](docs/ResponseVoSnapshotHistoryListResponseVo.md)
   117   - [SetSnapshotScheduling](docs/SetSnapshotScheduling.md)
   118   - [SnapshotHistoryListResponseVo](docs/SnapshotHistoryListResponseVo.md)
   119   - [SnapshotHistoryResponseVo](docs/SnapshotHistoryResponseVo.md)
   120   - [SnapshotSchedulingHistoryResponseVo](docs/SnapshotSchedulingHistoryResponseVo.md)
   121   - [UpdateApiAuthenticationKey](docs/UpdateApiAuthenticationKey.md)
   122   - [VpcSubnetListResponseDetailVo](docs/VpcSubnetListResponseDetailVo.md)
   123  
   124  
   125  ## Documentation For Authorization
   126  
   127  ## x-ncp-iam
   128  - **Type**: API key 
   129  
   130  Example
   131  ```golang
   132  auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{
   133  	Key: "APIKEY",
   134  	Prefix: "Bearer", // Omit if not necessary.
   135  })
   136  r, err := client.Service.Operation(auth, args)
   137  ```
   138  
   139  ## Author
   140  
   141  
   142