Get stage

Available in Classic and VPC

Get details of a deployment stage.

Request

This section describes the request format. The method and URI are as follows:

Method	URI
GET	/api/v1/project/{projectId}/stage/{stageId}

Request headers

For information about the headers common to all SourceDeploy APIs, see SourceDeploy request headers.

Request path parameters

You can use the following path parameters with your request:

Field	Type	Required	Description
`projectId`	String	Required	Project ID See Get project list.
`stageId`	String	Required	Deployment stage ID See Get stage list.

Request example

The request example is as follows:

curl --location --request GET 'https://vpcsourcedeploy.apigw.ntruss.com/api/v1/project/2***/stage/3***' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field	Type	Required	Description
`result`	Object	-	Response result
`result.project`	Object	-	Project information
`result.project.id`	Number	-	Project ID
`result.project.name`	String	-	Project name
`result.id`	Number	-	Deployment stage ID
`result.name`	String	-	Deployment stage name
`result.type`	String	-	Deployment target type `Server` \| `AutoScalingGroup` \| `KubernetesService` \| `ObjectStorage`
`result.config`	Object	-	Deployment target settings Server: See TEnvServer. AutoScalingGroup: See TEnvAutoScalingGroup. KubernetesService: See TEnvKubernetesService. ObjectStorage: See TEnvObjectStorage.

TEnvServer

The following describes TEnvServer.

Field	Type	Required	Description
`serverNo`	Array	Required	Target server number list See Get server list.

TEnvAutoScalingGroup

The following describes TEnvAutoScalingGroup.

Field	Type	Required	Description
`autoScalingGroupNo`	Number	Required	Target Auto Scaling group number See Get Auto Scaling group list.

TEnvKubernetesService

The following describes TEnvKubernetesService.

Field	Type	Required	Description
`clusterNo`	Number	Required	Target cluster number See Get Kubernetes cluster list.

TEnvObjectStorage

The following describes TEnvObjectStorage.

Field	Type	Required	Description
`bucketName`	String	Required	Target bucket name See Get Object Storage bucket list.

Response status codes

For information about the HTTP status codes common to all SourceDeploy APIs, see SourceDeploy response status codes.

Response example

The response example is as follows:

{
    "result": {
        "project": {
            "id": 2***,
            "name": "deploy3"
        },
        "id": 3***,
        "name": "dev-sv",
        "type": "Server",
        "config": {
            "serverNo": [
                1011*****
            ],
            "serverName": [
                "svs"
            ]
        }
    }
}