SourceDeployシナリオリストの照会

Prev Next

Classic/VPC環境で利用できます。

使用可能な SourceDeployプロジェクトのデプロイシナリオリストを照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
GET /api/v1/sourcedeploy/project/{projectId}/stage/{stageId}/scenario

リクエストヘッダ

SourcePipeline APIで共通して使用されるヘッダの詳細は、SourcePipelineのリクエストヘッダをご参照ください。

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
projectId String Required デプロイプロジェクト ID
stageId String Required デプロイステージ ID

リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
pageNo Number Optional ページ番号
  • 1~N
  • pageSize入力時、必ず入力
pageSize Number Optional ページごとの項目数
  • 1~N
  • pageNo入力時、必ず入力
searchWord String Optional 検索キーワード
  • シナリオ名が完全一致または一部一致する値を絞り込み

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://vpcsourcepipeline.apigw.ntruss.com/api/v1/sourcedeploy/project/2***/stage/3***/scenario?pageNo=1&pageSize=10&searchWord=te' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
result Object - レスポンス結果
result.scenarioList Array - デプロイシナリオリスト

scenarioList

scenarioListの説明は次の通りです。

フィールド タイプ 必須の有無 説明
id Number - デプロイシナリオ ID
name String - デプロイシナリオ名
source Object - デプロイ対象の情報
source.type String - デプロイファイルタイプ
  • SourceBuild | ObjectStorage | KubernetesService
source.target Object - デプロイファイル情報
source.target.projectName String - ビルドプロジェクト名
  • typeがSourceBuildの場合、表示
source.target.file String - Object Storage内のファイルの保存場所
  • typeがObjectStorageの場合、表示
source.target.manifest String - マニフェストファイルの保存場所
  • typeがKubernetesServiceの場合、表示

レスポンスステータスコード

SourcePipeline APIで共通して使用されるレスポンスステータスコードの詳細は、SourcePipelineのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "result": {
        "scenarioList": [
            {
                "id": 2***,
                "name": "testscenario2",
                "source": {
                    "type": "ObjectStorage",
                    "target": {
                        "file": "data2/sample_build_output.zip"
                    }
                }
            },
            {
                "id": 2***,
                "name": "testscenario",
                "source": {
                    "type": "SourceBuild",
                    "target": {
                        "projectName": "build1"
                    }
                }
            }
        ]
    }
}