Classic/VPC環境で利用できます。
作成した APIをデプロイします。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
| メソッド | URI |
|---|---|
| POST | /products/{product-id}/apis/{api-id}/deploy |
リクエストヘッダ
API Gatewayで共通して使用されるヘッダの詳細は、API Gatewayのリクエストヘッダをご参照ください。
リクエストパスパラメータ
パラメータの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
product-id |
String | Required | APIと関連付けられた Product ID |
api-id |
String | Required | Productに作成された API ID |
リクエスト構文
リクエスト構文は次の通りです。
{
"deploymentDescription" : "deploymentDescription",
"stageId" : "stageId"
}
リクエストボディ
リクエストボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
deploymentDescription |
String | Optional | APIデプロイの説明
|
stageId |
String | Required | デプロイ対象の APIに作成された Stage ID
|
リクエスト例
リクエストのサンプルコードは次の通りです。
curl -X POST 'https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/deploy' \
--header 'Content-Type: application/json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
--data '{
"deploymentDescription" : "deployment Description",
"stageId" : "*****7mhdv"
}
レスポンス
レスポンス形式を説明します。
レスポンスステータスコード
API Gatewayで共通して使用されるレスポンスステータスコードの詳細は、API Gatewayのレスポンスステータスコードをご参照ください。