シナリオリストの照会

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

デプロイプロジェクト内のデプロイシナリオリストを照会します。

リクエスト

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

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

リクエストヘッダ

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

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

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

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

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

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

フィールド	タイプ	必須の有無	説明
`scenarioName`	String	Optional	検索キーワードシナリオ名が完全一致または一部一致する値を絞り込み
`pageNo`	Number	Optional	ページ番号 1~N (デフォルト: 1)
`pageSize`	Number	Optional	ページごとの項目数 1~100 (デフォルト: 100)

リクエスト例

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

curl --location --request GET '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}'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`result`	Object	-	レスポンス結果
`result.project`	Object	-	プロジェクト情報
`result.project.id`	Number	-	プロジェクト ID
`result.project.name`	String	-	プロジェクト名
`result.stage`	Object	-	デプロイステージ情報
`result.stage.id`	Number	-	デプロイステージ ID
`result.stage.name`	String	-	デプロイステージ名
`result.scenarioList`	Array	-	デプロイシナリオリスト

`scenarioList`

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

フィールド	タイプ	必須の有無	説明
`id`	Number	-	デプロイシナリオ ID
`name`	String	-	デプロイシナリオ名

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

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

レスポンス例

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

{
    "result": {
        "project": {
            "id": 2***,
            "name": "deploy3"
        },
        "stage": {
            "id": 3***,
            "name": "dev-nks"
        },
        "scenarioList": [
            {
                "id": 2***,
                "name": "testscenario"
            }
        ]
    }
}