APIの公開

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

APIを公開、または公開解除します。

リクエスト

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

メソッド	URI
POST	/products/{product-id}/apis/{api-id}/publish

リクエストヘッダ

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

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

パラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`product-id`	String	Required	APIと関連付けられた Product ID
`api-id`	String	Required	Productに作成された API ID

リクエスト構文

リクエスト構文は次の通りです。

{
  "stages" : [ {
    "isPublished" : true,
    "stageId" : "stageId"
  } ]
}

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`stages[].isPublished`	Boolean	Required	公開するかどうか選択 `true` \| `false` `true`: 公開 `false`: 公開解除
`stages[].stageId`	String	Required	APIを公開または解除する対象の Stage ID

リクエスト例

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

curl -X POST 'https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/publish' \
--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 '{
  "stages" : [ {
    "isPublished" : true,
    "stageId" : "*****7mhdv"
  } ]
}'

レスポンス

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

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

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