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

     1  # Go API client for vsourcedeploy
     2  
     3      <br/>https://vpcsourcedeploy.apigw.ntruss.com/api/v1
     4  
     5  ## Overview
     6  
     7  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.
     8  
     9  -   API version: 2022-04-22T07:37:28Z
    10  -   Package version:
    11  -   Build package: io.swagger.codegen.languages.NcpGoForVnksClientCodegen
    12  
    13  ## Installation
    14  
    15  Put the package under your project folder and add the following in import:
    16  
    17  ```
    18  "./vsourcedeploy"
    19  ```
    20  
    21  ## Documentation for API Endpoints
    22  
    23  All URIs are relative to *https://vpcsourcedeploy.apigw.ntruss.com/api/v1*
    24  
    25  | Class   | Method                                                                             | HTTP request                                                                       | Description |
    26  | ------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ----------- |
    27  | _V1Api_ | [**GetAutoscalingGroupTargetGroup**](docs/V1Api.md#GetAutoscalingGroupTargetGroup) | **Get** /autoscaling/{autoscalingName}                                             |
    28  | _V1Api_ | [**GetAutoscalingGroups**](docs/V1Api.md#GetAutoscalingGroups)                     | **Get** /autoscaling                                                               |
    29  | _V1Api_ | [**GetKubernetesClusters**](docs/V1Api.md#GetKubernetesClusters)                   | **Get** /kubernetes/cluster                                                        |
    30  | _V1Api_ | [**GetObjectstorageObjects**](docs/V1Api.md#GetObjectstorageObjects)               | **Get** /objectstorage/bucket/{bucketName}                                         |
    31  | _V1Api_ | [**GetObjectstorageBuckets**](docs/V1Api.md#GetObjectstorageBuckets)               | **Get** /objectstorage/bucket                                                      |
    32  | _V1Api_ | [**GetProjects**](docs/V1Api.md#GetProjects)                                       | **Get** /project                                                                   |
    33  | _V1Api_ | [**CreateProject**](docs/V1Api.md#CreateProject)                                   | **Post** /project                                                                  |
    34  | _V1Api_ | [**DeleteProject**](docs/V1Api.md#DeleteProject)                                   | **Delete** /project/{projectId}                                                    |
    35  | _V1Api_ | [**GetHistories**](docs/V1Api.md#GetHistories)                                     | **Get** /project/{projectId}/history                                               |
    36  | _V1Api_ | [**AcceptDeployApproval**](docs/V1Api.md#AcceptDeployApproval)                     | **Post** /project/{projectId}/history/{historyId}/approval/accept                  |
    37  | _V1Api_ | [**RejectDeployApproval**](docs/V1Api.md#RejectDeployApproval)                     | **Post** /project/{projectId}/history/{historyId}/approval/reject                  |
    38  | _V1Api_ | [**AcceptDeployCanary**](docs/V1Api.md#AcceptDeployCanary)                         | **Post** /project/{projectId}/history/{historyId}/canary/accept                    |
    39  | _V1Api_ | [**RejectDeployCanary**](docs/V1Api.md#RejectDeployCanary)                         | **Post** /project/{projectId}/history/{historyId}/canary/reject                    |
    40  | _V1Api_ | [**CancelDeploy**](docs/V1Api.md#CancelDeploy)                                     | **Post** /project/{projectId}/history/{historyId}/cancel                           |
    41  | _V1Api_ | [**GetHistory**](docs/V1Api.md#GetHistory)                                         | **Get** /project/{projectId}/history/{historyId}                                   |
    42  | _V1Api_ | [**GetCanaryReport**](docs/V1Api.md#GetCanaryReport)                               | **Get** /project/{projectId}/history/{historyId}/report/{endtime}                  |
    43  | _V1Api_ | [**GetCanaryReportEndtime**](docs/V1Api.md#GetCanaryReportEndtime)                 | **Get** /project/{projectId}/history/{historyId}/report                            |
    44  | _V1Api_ | [**GetStages**](docs/V1Api.md#GetStages)                                           | **Get** /project/{projectId}/stage                                                 |
    45  | _V1Api_ | [**CreateStage**](docs/V1Api.md#CreateStage)                                       | **Post** /project/{projectId}/stage                                                |
    46  | _V1Api_ | [**DeleteStage**](docs/V1Api.md#DeleteStage)                                       | **Delete** /project/{projectId}/stage/{stageId}                                    |
    47  | _V1Api_ | [**GetStage**](docs/V1Api.md#GetStage)                                             | **Get** /project/{projectId}/stage/{stageId}                                       |
    48  | _V1Api_ | [**ChangeStage**](docs/V1Api.md#ChangeStage)                                       | **Patch** /project/{projectId}/stage/{stageId}                                     |
    49  | _V1Api_ | [**GetScenarioes**](docs/V1Api.md#GetScenarioes)                                   | **Get** /project/{projectId}/stage/{stageId}/scenario                              |
    50  | _V1Api_ | [**CreateScenario**](docs/V1Api.md#CreateScenario)                                 | **Post** /project/{projectId}/stage/{stageId}/scenario                             |
    51  | _V1Api_ | [**DeleteScenario**](docs/V1Api.md#DeleteScenario)                                 | **Delete** /project/{projectId}/stage/{stageId}/scenario/{scenarioId}              |
    52  | _V1Api_ | [**Deploy**](docs/V1Api.md#Deploy)                                                 | **Post** /project/{projectId}/stage/{stageId}/scenario/{scenarioId}/deploy         |
    53  | _V1Api_ | [**DeployRequest**](docs/V1Api.md#DeployRequest)                                   | **Post** /project/{projectId}/stage/{stageId}/scenario/{scenarioId}/deploy/request |
    54  | _V1Api_ | [**GetScenario**](docs/V1Api.md#GetScenario)                                       | **Get** /project/{projectId}/stage/{stageId}/scenario/{scenarioId}                 |
    55  | _V1Api_ | [**ChangeScenario**](docs/V1Api.md#ChangeScenario)                                 | **Patch** /project/{projectId}/stage/{stageId}/scenario/{scenarioId}               |
    56  | _V1Api_ | [**GetServers**](docs/V1Api.md#GetServers)                                         | **Get** /server                                                                    |
    57  | _V1Api_ | [**GetSourcebuildProjects**](docs/V1Api.md#GetSourcebuildProjects)                 | **Get** /sourcebuild/project                                                       |
    58  | _V1Api_ | [**GetSourcecommitRepositories**](docs/V1Api.md#GetSourcecommitRepositories)       | **Get** /sourcecommit/repository                                                   |
    59  | _V1Api_ | [**GetSourceCommitBranches**](docs/V1Api.md#GetSourceCommitBranches)               | **Get** /sourcecommit/repository/{repositoryName}/branch                           |
    60  
    61  ## Documentation For Models
    62  
    63  -   [ChangeScenario](docs/ChangeScenario.md)
    64  -   [ChangeStage](docs/ChangeStage.md)
    65  -   [CreateProject](docs/CreateProject.md)
    66  -   [CreateScenario](docs/CreateScenario.md)
    67  -   [CreateStage](docs/CreateStage.md)
    68  -   [DeployRequestResponse](docs/DeployRequestResponse.md)
    69  -   [GetAutoScalingGroupListResponse](docs/GetAutoScalingGroupListResponse.md)
    70  -   [GetAutoScalingGroupListResponseAutoscalingList](docs/GetAutoScalingGroupListResponseAutoscalingList.md)
    71  -   [GetCanaryAnalysisReportResponse](docs/GetCanaryAnalysisReportResponse.md)
    72  -   [GetCanaryAnalysisStageListResponse](docs/GetCanaryAnalysisStageListResponse.md)
    73  -   [GetDeployHistoryDetailResponse](docs/GetDeployHistoryDetailResponse.md)
    74  -   [GetDeployHistoryDetailResponseConfig](docs/GetDeployHistoryDetailResponseConfig.md)
    75  -   [GetDeployHistoryDetailResponseFile](docs/GetDeployHistoryDetailResponseFile.md)
    76  -   [GetDeployHistoryDetailResponseServer](docs/GetDeployHistoryDetailResponseServer.md)
    77  -   [GetDeployHistoryDetailResponseStep](docs/GetDeployHistoryDetailResponseStep.md)
    78  -   [GetDeployHistoryDetailResponseTargets](docs/GetDeployHistoryDetailResponseTargets.md)
    79  -   [GetDeployHistoryDetailResponseTime](docs/GetDeployHistoryDetailResponseTime.md)
    80  -   [GetDeployHistoryListResponse](docs/GetDeployHistoryListResponse.md)
    81  -   [GetDeployHistoryListResponseHistoryList](docs/GetDeployHistoryListResponseHistoryList.md)
    82  -   [GetIdNameResponse](docs/GetIdNameResponse.md)
    83  -   [GetKubernetesServiceClusterListResponse](docs/GetKubernetesServiceClusterListResponse.md)
    84  -   [GetObjectStorageBucketListResponse](docs/GetObjectStorageBucketListResponse.md)
    85  -   [GetObjectStorageObjectListResponse](docs/GetObjectStorageObjectListResponse.md)
    86  -   [GetObjectStorageObjectListResponseObjectList](docs/GetObjectStorageObjectListResponseObjectList.md)
    87  -   [GetProjectListResponse](docs/GetProjectListResponse.md)
    88  -   [GetScenarioConfig](docs/GetScenarioConfig.md)
    89  -   [GetScenarioConfigFile](docs/GetScenarioConfigFile.md)
    90  -   [GetScenarioConfigLoadBalancer](docs/GetScenarioConfigLoadBalancer.md)
    91  -   [GetScenarioDetailResponse](docs/GetScenarioDetailResponse.md)
    92  -   [GetScenarioListResponse](docs/GetScenarioListResponse.md)
    93  -   [GetServerListResponse](docs/GetServerListResponse.md)
    94  -   [GetServerListResponseServerList](docs/GetServerListResponseServerList.md)
    95  -   [GetSourceBuildProjectListResponse](docs/GetSourceBuildProjectListResponse.md)
    96  -   [GetSourceCommitBranchListResponse](docs/GetSourceCommitBranchListResponse.md)
    97  -   [GetSourceCommitRepositoryListResponse](docs/GetSourceCommitRepositoryListResponse.md)
    98  -   [GetSourceCommitRepositoryListResponseRepositoryList](docs/GetSourceCommitRepositoryListResponseRepositoryList.md)
    99  -   [GetStageDetailResponse](docs/GetStageDetailResponse.md)
   100  -   [GetStageDetailResponseConfig](docs/GetStageDetailResponseConfig.md)
   101  -   [GetStageListResponse](docs/GetStageListResponse.md)
   102  -   [GetTargetGroupListResponse](docs/GetTargetGroupListResponse.md)
   103  -   [OkResponse](docs/OkResponse.md)
   104  -   [ScenarioConfig](docs/ScenarioConfig.md)
   105  -   [ScenarioConfigCanaryConfig](docs/ScenarioConfigCanaryConfig.md)
   106  -   [ScenarioConfigCanaryConfigAnalysisConfig](docs/ScenarioConfigCanaryConfigAnalysisConfig.md)
   107  -   [ScenarioConfigCanaryConfigEnv](docs/ScenarioConfigCanaryConfigEnv.md)
   108  -   [ScenarioConfigCanaryConfigMetrics](docs/ScenarioConfigCanaryConfigMetrics.md)
   109  -   [ScenarioConfigCmd](docs/ScenarioConfigCmd.md)
   110  -   [ScenarioConfigCmdDeploy](docs/ScenarioConfigCmdDeploy.md)
   111  -   [ScenarioConfigCmdPrePost](docs/ScenarioConfigCmdPrePost.md)
   112  -   [ScenarioConfigFile](docs/ScenarioConfigFile.md)
   113  -   [ScenarioConfigFileObjectStorage](docs/ScenarioConfigFileObjectStorage.md)
   114  -   [ScenarioConfigFileSourceBuild](docs/ScenarioConfigFileSourceBuild.md)
   115  -   [ScenarioConfigLoadBalancer](docs/ScenarioConfigLoadBalancer.md)
   116  -   [ScenarioConfigManifest](docs/ScenarioConfigManifest.md)
   117  -   [StageConfig](docs/StageConfig.md)