Classic/VPC環境で利用できます。
シナリオデプロイの承認をリクエストします。
参考
requestDeploy権限を持つサブアカウントから呼び出すことができます。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
メソッド | URI |
---|---|
POST | /api/v1/project/{projectId}/stage/{stageId}/scenario/{scenarioId}/deploy/request |
リクエストヘッダ
SourceDeploy APIで共通して使用されるヘッダの詳細は、SourceDeployのリクエストヘッダをご参照ください。
リクエストパスパラメータ
リクエストパスパラメータの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
projectId |
String | Required | プロジェクト ID
|
stageId |
String | Required | デプロイステージ ID
|
scenarioId |
String | Required | デプロイシナリオ ID
|
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request POST 'https://vpcsourcedeploy.apigw.ntruss.com/api/v1/project/2***/stage/3***/scenario/2***/deploy/request' \
--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.historyId |
Number | - | ジョブ結果 ID |
レスポンスステータスコード
SourceDeploy APIで共通して使用されるレスポンスステータスコードの詳細は、SourceDeployのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"result": {
"historyId": 80***
}
}