Classic/VPC環境で利用できます。
指定した Stageに特定の Usage Planを関連付けます。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
| メソッド | URI |
|---|---|
| POST | /products/{product-id}/apis/{api-id}/stages/{stage-id}/associate-usage-plan |
リクエストヘッダ
API Gatewayで共通して使用されるヘッダの詳細は、API Gatewayの共通ヘッダをご参照ください。
リクエストパスパラメータ
パラメータの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
product-id |
String | Required | Stageが属する Product ID
|
api-id |
String | Required | Stageが属する API ID
|
stage-id |
String | Required | Usage Planを関連付ける対象の Stage ID
|
リクエスト構文
リクエスト構文は次の通りです。
{
"usagePlanId" : "usagePlanId"
}
リクエストボディ
リクエストボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
usagePlanId |
String | Required | 関連付け対象の Usage Plan ID
|
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request POST 'https://apigateway.apigw.ntruss.com/api/v1/products/***ksk9***/apis/***51hs***/stages/***fh5o***/associate-usage-plan' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
"usagePlanId" : "***xogj***"
}'
レスポンス
レスポンス形式を説明します。
レスポンスステータスコード
API Gatewayで共通して使用されるレスポンスステータスコードの詳細は、API Gatewayのレスポンスステータスコードをご参照ください。