MENU
      Deployment History Details

        Deployment History Details


        Article summary

        Overview

        View detailed SourceDeploy history.

        Requests

        API URL

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

        Request parameters

        ItemTypeDescriptionRemarks
        projectIdstringProject IDView projectList
        historyIdstringHistory IDView 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"
        }
        JSON
        ItemTypeDescriptionRemarks
        project.idnumberproject id
        project.namestringProject name
        stage.idnumberstage id
        stage.namestringStage name
        scenario.idnumberScenario ID
        scenario.namestringScenario name
        idnumberhistory id
        statusstringDeployment statussuccess (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)
        executorstringDeployer
        startTimenumberDeployment start time
        endTimenumberDeployment end time
        typeStringStage type"Server" | "AutoScalingGroup" | "Kuberneteservice" |"ObjectStroage"
        configTHistoryServer | THistoryAutoScaling |THisotryKubernetesService | THistoryObjectStorageDeployment settings informationWhen 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"
                    }
                }
            ]
        }]
        JSON
        ItemTypeDescriptionRemarks
        strategystringDeployment strategy"normal"
        file.selectedstringDeployed file
        file.typestringDeployed file type
        targets.server.nonumberServer No
        targets.server.namestringServer name
        targets.statusstringDeployment statuspending (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.prenumberTime before deployment
        targets.time.deploynumberFile deployment time
        targets.time.postnumberTime after deployment
        targets.step.prestringStatus before deployment"success" | "fail" | "inprogress"
        targets.step.deploystringFile deployment status"success" | "fail" | "inprogress"
        targets.step.poststringStatus 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"
                        }
                    }
                ]
        }
        JSON
        ItemTypeDescriptionRemarks
        strategystringDeployment strategy"normal" | "blueGreen"
        autoScalingGroup.nonumberAutoScalingGroup No
        autoScalingGroup.namestringAutoScalingGroup name
        file.selectedstringDeployed file
        file.typestringDeployed file type
        targets.server.nonumberServer No
        targets.server.namestringServer name
        targets.statusstringDeployment statuspending (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.prenumberTime before deployment
        targets.time.deploynumberFile deployment time
        targets.time.postnumberTime after deployment
        targets.step.prestringStatus before deployment"success" | "fail" | "inprogress"
        targets.step.deploystringFile deployment status"success" | "fail" | "inprogress"
        targets.step.poststringStatus 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"
                    }
                }
        }
        JSON
        ItemTypeDescriptionRemarks
        strategystringDeployment strategy"normal" | "blueGreen" | "rolling" | "canary"
        targets.time.prenumberDeployment preparation time
        targets.time.deploynumberDeployment time
        targets.step.prestringDeployment preparation status"success" | "fail" | "inprogress"
        targets.step.deploystringDeployment 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"
        }
        JSON
        ItemTypeDescriptionRemarks
        file.selectedstringDeployed file
        file.typestringDeployed file type
        targets.time.prenumberDeployment preparation time
        targets.time.deploynumberDeployment time
        targets.step.prestringDeployment preparation status"success" | "fail" | "inprogress"
        targets.step.deploystringDeployment status"success" | "fail" | "inprogress"
        backupFilestringBackup file

        Was this article helpful?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.