ステージリストの照会

Prev Next

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

デプロイプロジェクト内のデプロイステージリストを照会します。

リクエスト

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

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

リクエストヘッダ

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

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

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

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

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

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

フィールド タイプ 必須の有無 説明
stageName 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' \
--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.stageList Array - ステージリスト

stageList

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

フィールド タイプ 必須の有無 説明
id Number - デプロイステージ ID
name String - デプロイステージ名

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

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

レスポンス例

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

{
    "result": {
        "project": {
            "id": 2***,
            "name": "deploy3"
        },
        "stageList": [
            {
                "id": 3***,
                "name": "dev-sv"
            },
            {
                "id": 3***,
                "name": "dev-ob"
            },
            {
                "id": 3***,
                "name": "dev-nks"
            },
            {
                "id": 3***,
                "name": "dev-asg"
            }
        ]
    }
}