Usage Planと関連付けられた Stageの照会
- 印刷する
- PDF
Usage Planと関連付けられた Stageの照会
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
Classic/VPC環境で利用できます。
指定した APIに属する Stageの中で、特定の Usage Planが関連付けられた Stageを照会します。リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
メソッド | URI |
---|---|
POST | /products/{product-id}/apis/{api-id}/stages/search |
リクエストヘッダ
API Gatewayで共通して使用されるヘッダの詳細は、API Gatewayのリクエストヘッダをご参照ください。
リクエストパスパラメータ
パラメータの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
product-id | String | Required | APIが属する Product ID
|
api-id | String | Required | Stage照会対象の API ID
|
リクエスト構文
リクエスト構文は次の通りです。
{
"usagePlanId" : "usagePlanId"
}
リクエストボディ
リクエストボディの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
usagePlanId | String | Required | Stage照会対象の Usage Plan ID
|
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request POST 'https://apigateway.apigw.ntruss.com/api/v1/products/***ksk9***/apis/***51hs***/stages/search' \
--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" : "***833g***"
}'
レスポンス
レスポンス形式を説明します。
レスポンス構文
レスポンス構文は次の通りです。
{
"stages" : [ {
"stageName" : "stageName",
"stageId" : "stageId"
} ]
}
レスポンスステータスコード
API Gatewayで共通して使用されるレスポンスステータスコードの詳細は、API Gatewayのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"stages": [
{
"stageId": "***fh5o***",
"stageName": "stage000"
},
{
"stageId": "***5ei7***",
"stageName": "stage"
}
]
}
この記事は役に立ちましたか?