Usage Planと関連付けられた Stageの照会

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

リクエスト

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

リクエストヘッダ

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

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

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

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

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

リクエスト例

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

curl --location --request GET 'https://apigateway.apigw.ntruss.com/api/v1/usage-plans/***9rpm***/stages' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンス構文

レスポンス構文は次の通りです。

{
    "total" : 0,
    "stages" : [ {
        "apiName" : "apiName",
        "stageName" : "stageName",
        "productId" : "productId",
        "apiId" : "apiId",
        "productName" : "productName",
        "stageId" : "stageId"
    } ],
    "usagePlan" : {
        "domainCode" : "domainCode",
        "monthQuotaRequest" : 1,
        "dayQuotaRequest" : 6,
        "rateRps" : 5,
        "quotaCondition" : "quotaCondition"
  }
}

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

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

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "stages": [
        {
            "productName": "product",
            "apiName": "api000",
            "stageName": "stage",
            "stageId": "***5ei7***",
            "productId": "***ksk9***",
            "apiId": "***51hs***"
        }
    ],
    "total": 1,
    "usagePlan": {
        "domainCode": "PUB"
    }
}