Deployment History Details

Article summary

Did you find this summary helpful?

Thank you for your feedback

Overview

View detailed SourceDeploy history.

Requests

API URL

GET 	{SOURCEDEPLOY_API_URL}/project/{projectId}/history/{historyId}

Request parameters

Item	Type	Description	Remarks
projectId	string	Project ID	View projectList
historyId	string	History ID	View historyList

Request queries

None

Request bodies

None

Responses

Response bodies

{
    "project":{
        "id":"number",
        "name": "string"
    },
    "stage": {
        "id": "number",
        "name": "string"
    },
    "scenario": {
        "id": "number",
        "name": "string"
    },
    "id": "number",
    "status": "string",
    "executor": "string",
    "startTime": "number",
    "endTime": "number",
    "type": "string",
    "config": "THistoryServer" |"THistoryAutoScaling" | "THisotryKubernetesService" | "THistoryObjectStorage"
}

Item	Type	Description	Remarks
project.id	number	project id
project.name	string	Project name
stage.id	number	stage id
stage.name	string	Stage name
scenario.id	number	Scenario ID
scenario.name	string	Scenario name
id	number	history id
status	string	Deployment status	success (Success) fail (Failure) inprogress (Deploying) pending (Waiting for approval) reject (Reject approval) canceling (Canceling deployment) canceled (Deployment canceled) waiting (Waiting for deployment) error(Error) canary_pending (Waiting for canary deployment) canary_reject (Cancel canary deployment) canary_analyzing (Analyzing canary) canary_waiting_timeout (Canary analysis timeout) canary_rejecting (Canceling canary deployment)
executor	string	Deployer
startTime	number	Deployment start time
endTime	number	Deployment end time
type	String	Stage type	"Server" \| "AutoScalingGroup" \| "Kuberneteservice" \|"ObjectStroage"
config	THistoryServer \| THistoryAutoScaling \|THisotryKubernetesService \| THistoryObjectStorage	Deployment settings information	When type="Server," THistoryServer When type="AutoScalingGroup," THistoryAutoScaling When type="Kuberneteservice," THistoryKubernetesService When type="ObjectStorage," THistoryObjectStorage

THistoryServer

[{
    "strategy": "string",
    "file": {
        "selected": "string",
        "type": "string"
    },
    "targets": [
        {
            "server": {
                "no": "number",
                "name": "string"
            },
            "status": "pending/standby/pre/deploy/post/success/fail/no progress",
            "time": {
                "pre": "timestamp",
                "deploy": "timestamp",
                "post": "timestamp"
            },
            "step": {
                "pre": "success/fail/inprogress",
                "deploy": "success/fail/inprogress",
                "post": "succss/fail/inprogress"
            }
        }
    ]
}]

Item	Type	Description	Remarks
strategy	string	Deployment strategy	"normal"
file.selected	string	Deployed file
file.type	string	Deployed file type
targets.server.no	number	Server No
targets.server.name	string	Server name
targets.status	string	Deployment status	pending (Waiting for agent response) standby (Agent connected) pre\| deploy\| post (Deployment in progress by stage) success (Deployment successful) fail (Deployment failed) no progress (Deployment not progressed)
targets.time.pre	number	Time before deployment
targets.time.deploy	number	File deployment time
targets.time.post	number	Time after deployment
targets.step.pre	string	Status before deployment	"success" \| "fail" \| "inprogress"
targets.step.deploy	string	File deployment status	"success" \| "fail" \| "inprogress"
targets.step.post	string	Status after deployment	"success" \| "fail" \| "inprogress"

THistoryAutoScaling

{
        "strategy": "normal/blueGreen",
        "autoScalingGroup": {
            "no": "number",
            "name": "string"
        },
        "file": {
            "selected": "string",
            "type": "string"
        },
        "targets": [
            {
                "server": {
                    "no": "number",
                    "name": "string"
                },
                "status": "pending/standby/pre/deploy/post/success/fail/no progress",
                "time": {
                    "pre": "timestamp",
                    "deploy": "timestamp",
                    "post": "timestamp"
                },
                "step": {
                    "pre": "success/fail/inprogress",
                    "deploy": "success/fail/inprogress",
                    "post": "succss/fail/inprogress"
                }
            }
        ]
}

Item	Type	Description	Remarks
strategy	string	Deployment strategy	"normal" \| "blueGreen"
autoScalingGroup.no	number	AutoScalingGroup No
autoScalingGroup.name	string	AutoScalingGroup name
file.selected	string	Deployed file
file.type	string	Deployed file type
targets.server.no	number	Server No
targets.server.name	string	Server name
targets.status	string	Deployment status	pending (Waiting for agent response) standby (Agent connected) pre\| deploy\| post (Deployment in progress by stage) success (Deployment successful) fail (Deployment failed) no progress (Deployment not progressed)
targets.time.pre	number	Time before deployment
targets.time.deploy	number	File deployment time
targets.time.post	number	Time after deployment
targets.step.pre	string	Status before deployment	"success" \| "fail" \| "inprogress"
targets.step.deploy	string	File deployment status	"success" \| "fail" \| "inprogress"
targets.step.post	string	Status after deployment	"success" \| "fail" \| "inprogress"

THisotryKubernetesService

{
        "strategy": "normal/blueGreen/rolling/canary",
        "targets": {
            "time": {
                "pre": "timestamp",
                "deploy": "timestamp"
            },
            "step": {
                "pre": "success/fail/inprogress",
                "deploy": "success/fail/inprogress"
            }
        }
}

Item	Type	Description	Remarks
strategy	string	Deployment strategy	"normal" \| "blueGreen" \| "rolling" \| "canary"
targets.time.pre	number	Deployment preparation time
targets.time.deploy	number	Deployment time
targets.step.pre	string	Deployment preparation status	"success" \| "fail" \| "inprogress"
targets.step.deploy	string	Deployment status	"success" \| "fail" \| "inprogress"

THistoryObjectStorage

{
        "file": {
            "selected": "string",
            "type": "string"
        },
        "targets": {
            "time": {
                "pre": "timestamp",
                "deploy": "timestamp"
            },
            "step": {
                "pre": "success/fail/inprogress",
                "deploy": "success/fail/inprogress"
            }
        },
        "backupFile": "string"
}

Item	Type	Description	Remarks
file.selected	string	Deployed file
file.type	string	Deployed file type
targets.time.pre	number	Deployment preparation time
targets.time.deploy	number	Deployment time
targets.step.pre	string	Deployment preparation status	"success" \| "fail" \| "inprogress"
targets.step.deploy	string	Deployment status	"success" \| "fail" \| "inprogress"
backupFile	string	Backup file

Was this article helpful?

What's Next

Querying the Canary

Table of contents

Overview
Requests
Responses