Usage Plan

Usage Plan作成

URL

POST https://apigateway.apigw.ntruss.com/api/v1/usage-plans

リクエストパラメータ

• なし

リクエストボディ

{
  "monthQuotaRequest" : 1,
  "dayQuotaRequest" : 6,
  "usagePlanDescription" : "usagePlanDescription",
  "rateRps" : 0,
  "quotaCondition" : "quotaCondition",
  "usagePlanName" : "usagePlanName"
}

応答コード

• 201

応答ボディ

{
  "usagePlan" : {
    "domainCode" : "domainCode",
    "usagePlanId" : "usagePlanId",
    "modifier" : "modifier",
    "associatedStagesCount" : 0,
    "dayQuotaRequest" : 6,
    "permission" : "permission",
    "rateRps" : 5,
    "usagePlanName" : "usagePlanName",
    "monthQuotaRequest" : 1,
    "tenantId" : "tenantId",
    "disabled" : true,
    "usagePlanDescription" : "usagePlanDescription",
    "quotaCondition" : "quotaCondition",
    "actionName" : "actionName"
  }
}

Usage Plan削除

URL

DELETE https://apigateway.apigw.ntruss.com/api/v1/usage-plans/{usage-plan-id}

リクエストパラメータ

リクエストボディ

• なし

応答コード

• 204

応答ボディ

• なし

Usage Plan照会

URL

GET https://apigateway.apigw.ntruss.com/api/v1/usage-plans

リクエストパラメータ<

リクエストボディ

• なし

応答コード

• 200

応答ボディ

{
  "total" : 0,
  "usagePlans" : [ {
    "domainCode" : "domainCode",
    "usagePlanId" : "usagePlanId",
    "associatedStagesCount" : 6,
    "disabled" : true,
    "permission" : "permission",
    "usagePlanName" : "usagePlanName",
    "actionName" : "actionName"
  } ]
}

接続されたStage照会

URL

GET https://apigateway.apigw.ntruss.com/api/v1/usage-plans/{usage-plan-id}/stages

リクエストパラメータ

リクエストボディ

• なし

応答コード

• 200

応答ボディ

{
  "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"
  }
}

Usage Plan照会

URL

GET https://apigateway.apigw.ntruss.com/api/v1/usage-plans/{usage-plan-id}

リクエストパラメータ

リクエストボディ

• なし

応答コード

• 200

応答ボディ

{
  "usagePlan" : {
    "domainCode" : "domainCode",
    "usagePlanId" : "usagePlanId",
    "modifier" : "modifier",
    "associatedStagesCount" : 0,
    "dayQuotaRequest" : 6,
    "permission" : "permission",
    "rateRps" : 5,
    "usagePlanName" : "usagePlanName",
    "monthQuotaRequest" : 1,
    "tenantId" : "tenantId",
    "disabled" : true,
    "usagePlanDescription" : "usagePlanDescription",
    "quotaCondition" : "quotaCondition",
    "actionName" : "actionName"
  }
}

Usage Plan照会

URL

POST https://apigateway.apigw.ntruss.com/api/v1/usage-plans/search

リクエストパラメータ

• なし

リクエストボディ

{
  "offset" : 6,
  "limit" : 0,
  "usagePlanName" : "usagePlanName"
}

応答コード

• 200

応答ボディ

{
  "initialCount" : 0,
  "total" : 6,
  "usagePlans" : [ {
    "domainCode" : "domainCode",
    "usagePlanId" : "usagePlanId",
    "modifier" : "modifier",
    "associatedStagesCount" : 0,
    "dayQuotaRequest" : 6,
    "permission" : "permission",
    "rateRps" : 5,
    "usagePlanName" : "usagePlanName",
    "monthQuotaRequest" : 1,
    "tenantId" : "tenantId",
    "disabled" : true,
    "usagePlanDescription" : "usagePlanDescription",
    "quotaCondition" : "quotaCondition",
    "actionName" : "actionName"
  } ]
}

Usage Plan修正

URL

PUT https://apigateway.apigw.ntruss.com/api/v1/usage-plans/{usage-plan-id}

リクエストパラメータ

リクエストボディ

{
  "monthQuotaRequest" : 6,
  "dayQuotaRequest" : 0,
  "usagePlanDescription" : "usagePlanDescription",
  "rateRps" : 1,
  "quotaCondition" : "quotaCondition",
  "usagePlanName" : "usagePlanName"
}

応答コード

• 200

応答ボディ

{
  "usagePlan" : {
    "domainCode" : "domainCode",
    "usagePlanId" : "usagePlanId",
    "modifier" : "modifier",
    "associatedStagesCount" : 0,
    "dayQuotaRequest" : 6,
    "permission" : "permission",
    "rateRps" : 5,
    "usagePlanName" : "usagePlanName",
    "monthQuotaRequest" : 1,
    "tenantId" : "tenantId",
    "disabled" : true,
    "usagePlanDescription" : "usagePlanDescription",
    "quotaCondition" : "quotaCondition",
    "actionName" : "actionName"
  }
}