展開履歴の詳細

印刷する
共有
PDF

記事の要約

この要約は役に立ちましたか?

ご意見ありがとうございます

概要

SourceDeploy履歴の詳細を照会します。

リクエスト

API URL

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

リクエスト Parameter

項目	タイプ	説明	備考
projectId	string	プロジェクト ID	projectList照会
historyId	string	ヒストリー ID	historyList照会

リクエスト Query

なし

リクエスト Body

なし

レスポンス

レスポンス Body

{
    "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"
}

項目	タイプ	説明	備考
project.id	number	project id
project.name	string	project名
stage.id	number	stage id
stage.name	string	stage名
scenario.id	number	シナリオ id
scenario.name	string	シナリオ名
id	number	history id
status	string	リリース状態	success(成功) fail(失敗) inprogress(リリース中) pending(承認待ち) reject(承認拒否) canceling(リリースキャンセル中) canceled(リリースキャンセル) waiting(リリース待ち) error(Error) canary_pending(canaryリリース待ち) canary_reject(canaryリリースキャンセル) canary_analyzing(canary解析中) canary_waiting_timeout(canary解析時間超過) canary_rejecting(canaryリリースキャンセル中)
executor	string	リリース実行者
startTime	number	リリース開始時刻
endTime	number	リリース終了時刻
type	String	stageタイプ	"Server" \| "AutoScalingGroup" \| "Kuberneteservice" \|"ObjectStroage"
config	THistoryServer \| THistoryAutoScaling \|THisotryKubernetesService \| THistoryObjectStorage	リリース設定情報	type="Server"の場合、THistoryServer type="AutoScalingGroup"の場合、THistoryAutoScaling type="Kuberneteservice"の場合、THisotryKubernetesService 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"
            }
        }
    ]
}]

項目	タイプ	説明	備考
strategy	string	リリース戦略	"normal"
file.selected	string	リリースファイル
file.type	string	リリースファイルのタイプ
targets.server.no	number	Server No
targets.server.name	string	サーバ名
targets.status	string	リリース状態	pending(エージェントレスポンス待ち) standby(エージェント接続済み) pre\|deploy\|post(各段階のリリース進行中) success(リリース成功) fail(リリース失敗) no progress(リリース進行せず)
targets.time.pre	number	リリース前の時刻
targets.time.deploy	number	ファイルリリース時刻
targets.time.post	number	リリース後の時刻
targets.step.pre	string	リリース前の状態	"success" \| "fail" \| "inprogress"
targets.step.deploy	string	ファイルリリースの状態	"success" \| "fail" \| "inprogress"
targets.step.post	string	リリース後の状態	"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"
                }
            }
        ]
}

項目	タイプ	説明	備考
strategy	string	リリース戦略	"normal" \| "blueGreen"
autoScalingGroup.no	number	AutoScalingGroup No
autoScalingGroup.name	string	AutoScalingGroup名
file.selected	string	リリースファイル
file.type	string	リリースファイルのタイプ
targets.server.no	number	Server No
targets.server.name	string	サーバ名
targets.status	string	リリース状態	pending(エージェントレスポンス待ち) standby(エージェント接続済み) pre\|deploy\|post(各段階のリリース進行中) success(リリース成功) fail(リリース失敗) no progress(リリース進行せず)
targets.time.pre	number	リリース前の時刻
targets.time.deploy	number	ファイルリリース時刻
targets.time.post	number	リリース後の時刻
targets.step.pre	string	リリース前の状態	"success" \| "fail" \| "inprogress"
targets.step.deploy	string	ファイルリリースの状態	"success" \| "fail" \| "inprogress"
targets.step.post	string	リリース後の状態	"success" \| "fail" \| "inprogress"

THisotryKubernetesService

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

項目	タイプ	説明	備考
strategy	string	リリース戦略	"normal" \| "blueGreen" \| "rolling" \| "canary"
targets.time.pre	number	リリース準備時刻
targets.time.deploy	number	リリース時刻
targets.step.pre	string	リリース準備状態	"success" \| "fail" \| "inprogress"
targets.step.deploy	string	リリース状態	"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"
}

項目	タイプ	説明	備考
file.selected	string	リリースファイル
file.type	string	リリースファイルのタイプ
targets.time.pre	number	リリース準備時刻
targets.time.deploy	number	リリース時刻
targets.step.pre	string	リリース準備状態	"success" \| "fail" \| "inprogress"
targets.step.deploy	string	リリース状態	"success" \| "fail" \| "inprogress"
backupFile	string	バックアップファイル

この記事は役に立ちましたか?

What's Next

カナリアへのクエリー

概要
リクエスト
レスポンス

タグ

SourceDeploy