Create scenario

Available in Classic and VPC

Create a deployment scenario.

Request

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

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:

Request body

You can include the following data in the body of your request:

TScenarioServer

The following describes TScenarioServer.

pre

The following describes pre.

deploy

The following describes deploy.

post

The following describes post.

TScenarioAutoScalingGroup

The following describes TScenarioAutoScalingGroup.

pre

The following describes pre.

deploy

The following describes deploy.

post

The following describes post.

TScenarioKubernetesService

The following describes TScenarioKubernetesService.

metrics

The following describes metrics.

TScenarioObjectStorage

The following describes TScenarioObjectStorage.

path

The following describes path.

Request example

The request example is as follows:

curl --location --request POST 'https://vpcsourcedeploy.apigw.ntruss.com/api/v1/project/2***/stage/3***/scenario' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
    "name": "testScenario2",
    "description": "test Scenario 2",
    "config": {
        "strategy": "normal",
        "sequence": true,
        "file": {
            "type": "ObjectStorage",
            "ObjectStorage": {
                "bucket": "devtool",
                "object": "/result/build-sample.zip"
            }
        },
        "rollback": true,
        "cmd": {
            "pre": [
                {
                    "user": "root",
                    "cmd": "mv logs/app.log logs/app_$(date +%s).log"
                }
            ],
            "deploy": [
                {
                    "sourcePath": "/main.py",
                    "deployPath": "/home/root/"
                }
            ],
            "post": [
                {
                    "user": "root",
                    "cmd": "nohup python3 main.py > logs/app.log 2>&1 &"
                }
            ]
        }
    }
}'

Response

This section describes the response format.

Response body

The response body includes the following data:

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": {
        "id": 2***,
        "name": "testScenario2"
    }
}