ステージの照会

Prev Next

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

デプロイステージの詳細情報を照会します。

リクエスト

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

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

リクエストヘッダ

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

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

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

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

リクエスト例

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

curl --location --request GET 'https://vpcsourcedeploy.apigw.ntruss.com/api/v1/project/2***/stage/3***' \
--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.id Number - デプロイステージ ID
result.name String - デプロイステージ名
result.type String - デプロイターゲットタイプ
  • Server | AutoScalingGroup | KubernetesService | ObjectStorage
result.config Object - デプロイターゲットの設定

TEnvServer

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

フィールド タイプ 必須の有無 説明
serverNo Array Required 対象のサーバ番号リスト

TEnvAutoScalingGroup

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

フィールド タイプ 必須の有無 説明
autoScalingGroupNo Number Required 対象の Auto Scalingグループ番号

TEnvKubernetesService

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

フィールド タイプ 必須の有無 説明
clusterNo Number Required 対象のクラスタ番号

TEnvObjectStorage

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

フィールド タイプ 必須の有無 説明
bucketName String Required 対象のバケット名

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

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

レスポンス例

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

{
    "result": {
        "project": {
            "id": 2***,
            "name": "deploy3"
        },
        "id": 3***,
        "name": "dev-sv",
        "type": "Server",
        "config": {
            "serverNo": [
                1011*****
            ],
            "serverName": [
                "svs"
            ]
        }
    }
}