Product
    • PDF

    Product

    • PDF

    Article Summary

    Usage Plan修正

    URL

    PUT https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/api-keys/{api-key-id}/stages/{stage-id}
    

    リクエストパラメータ

    名前位置必須かどうかタイプ説明
    productIdpathYStringProduct Id
    長さ(最大/最小):0 / 10
    apiKeyIdpathYStringApi Key Id
    長さ(最大/最小):0 / 10
    stageIdpathYStringStage Id
    長さ(最大/最小):0 / 10

    リクエストボディ

    {
      "usagePlanId" : "usagePlanId"
    }
    

    応答コード

    • 204

    応答ボディ

    • なし

    Product生成

    URL

    POST https://apigateway.apigw.ntruss.com/api/v1/products
    

    リクエストパラメータ

    • なし

    リクエストボディ

    {
      "subscriptionCode" : "PROTECTED",
      "description" : "description",
      "productName" : "productName"
    }
    

    応答コード

    • 201

    応答ボディ

    {
      "product" : {
        "invokeId" : "invokeId",
        "domainCode" : "domainCode",
        "productId" : "productId",
        "isPublished" : true,
        "modifier" : "modifier",
        "permission" : "permission",
        "productName" : "productName",
        "subscriptionCode" : "PROTECTED",
        "isDeleted" : true,
        "modTime" : "2000-01-23T04:56:07.000+00:00",
        "tenantId" : "tenantId",
        "disabled" : true,
        "productDescription" : "productDescription",
        "actionName" : "actionName"
      }
    }
    

    Product削除

    URL

    DELETE https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}
    

    リクエストパラメータ

    名前位置必須かどうかタイプ説明
    productIdpathYStringProduct Id
    長さ(最大/最小):0 / 10

    リクエストボディ

    • なし

    応答コード

    • 204

    応答ボディ

    • なし

    Product検索

    URL

    GET https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}
    

    リクエストパラメータ

    名前位置必須かどうかタイプ説明
    productIdpathYStringProduct Id
    長さ(最大/最小):0 / 10

    リクエストボディ

    • なし

    応答コード

    • 200

    応答ボディ

    {
      "product" : {
        "invokeId" : "invokeId",
        "domainCode" : "domainCode",
        "productId" : "productId",
        "isPublished" : true,
        "modifier" : "modifier",
        "permission" : "permission",
        "productName" : "productName",
        "subscriptionCode" : "PROTECTED",
        "isDeleted" : true,
        "modTime" : "2000-01-23T04:56:07.000+00:00",
        "tenantId" : "tenantId",
        "disabled" : true,
        "productDescription" : "productDescription",
        "actionName" : "actionName"
      }
    }
    

    Product照会

    URL

    GET https://apigateway.apigw.ntruss.com/api/v1/products
    

    リクエストパラメータ

    名前位置必須かどうかタイプ説明
    offsetquery stringNLongOffset
    最小:0
    最大:9,223,372,036,854,775,807
    limitquery stringNLongLimit
    最小:1
    最大:9,223,372,036,854,775,807
    productNamequery stringNStringProduct Name
    長さ(最大/最小):0 / 100
    isPublishedquery stringNBooleanIs Published
    subscriptionCodequery stringNStringSubscription Code
    許容値:PROTECTED, PUBLIC
    hasDeployedStagequery stringNBooleanHas Deployed Stage
    hasStageNotAssociatedWithUsagePlanIdquery stringNStringHas Stage Not Associated With Usage Plan Id

    リクエストボディ

    • なし

    応答コード

    • 200

    応答ボディ

    {
      "initialCount" : 0,
      "productPage" : {
        "total" : 6,
        "content" : [ {
          "invokeId" : "invokeId",
          "domainCode" : "domainCode",
          "productId" : "productId",
          "isPublished" : true,
          "modifier" : "modifier",
          "permission" : "permission",
          "productName" : "productName",
          "hasDeployedStage" : true,
          "subscriptionCode" : "PROTECTED",
          "isDeleted" : true,
          "modTime" : "2000-01-23T04:56:07.000+00:00",
          "tenantId" : "tenantId",
          "disabled" : true,
          "productDescription" : "productDescription",
          "actionName" : "actionName"
        } ]
      }
    }
    

    Product修正

    URL

    PATCH https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}
    

    リクエストパラメータ

    名前位置必須かどうかタイプ説明
    productIdpathYStringProduct Id
    長さ(最大/最小):0 / 10

    リクエストボディ

    {
      "subscriptionCode" : "PROTECTED",
      "description" : "description",
      "productName" : "productName"
    }
    

    応答コード

    • 204

    応答ボディ

    • なし

    API Keyリスト検索

    URL

    POST https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/api-keys/search
    

    リクエストパラメータ

    名前位置必須かどうかタイプ説明
    productIdpathYStringProduct Id
    長さ(最大/最小):0 / 10

    リクエストボディ

    {
      "apiKeyValue" : "apiKeyValue",
      "offset" : 6,
      "limit" : 0,
      "apiKeyId" : "apiKeyId",
      "statusSet" : [ "REQUEST" ]
    }
    

    応答コード

    • 200

    応答ボディ

    {
      "apiKeyPage" : {
        "total" : 0,
        "content" : [ {
          "domainCode" : "domainCode",
          "regTime" : "2000-01-23T04:56:07.000+00:00",
          "secondaryKey" : "secondaryKey",
          "modTime" : "2000-01-23T04:56:07.000+00:00",
          "apiKeyId" : "apiKeyId",
          "apiKeyName" : "apiKeyName",
          "primaryKey" : "primaryKey",
          "status" : "REQUEST"
        } ]
      }
    }
    

    Product文書検索

    URL

    GET https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/document
    

    リクエストパラメータ

    名前位置必須かどうかタイプ説明
    productIdpathYStringProduct Id
    長さ(最大/最小):0 / 10
    offsetquery stringNLongOffset
    最小:0
    最大:9,223,372,036,854,775,807
    limitquery stringNLongLimit
    最小:1
    最大:9,223,372,036,854,775,807
    apiNamequery stringNStringApi Name
    長さ(最大/最小):0 / 20

    リクエストボディ

    • なし

    応答コード

    • 200

    応答ボディ

    {
      "apiPage" : {
        "total" : 6,
        "content" : [ {
          "apiName" : "apiName",
          "domainCode" : "domainCode",
          "stages" : [ {
            "deployedStageDeploymentNo" : 0,
            "stageName" : "stageName",
            "host" : "host",
            "stageId" : "stageId"
          } ],
          "apiDescription" : "apiDescription",
          "apiId" : "apiId"
        } ]
      }
    }
    

    Product Overview検索

    URL

    GET https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/overview
    

    リクエストパラメータ

    名前位置必須かどうかタイプ説明
    productIdpathYStringProduct Id
    長さ(最大/最小):0 / 10

    リクエストボディ

    • なし

    応答コード

    • 200

    応答ボディ

    {
      "apis" : [ {
        "apiName" : "apiName",
        "domainCode" : "domainCode",
        "methodsCount" : 2,
        "stages" : [ {
          "deployedStageDeploymentNo" : 0,
          "stageName" : "stageName",
          "host" : "host",
          "stageId" : "stageId"
        } ],
        "apiId" : "apiId"
      } ],
      "apiKeyCountInfo" : {
        "request" : 5,
        "total" : 5,
        "rejected" : 1,
        "accepted" : 0,
        "denied" : 6
      }
    }
    

    Product購読照会

    URL

    GET https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/subscription-detail
    

    リクエストパラメータ

    名前位置必須かどうかタイプ説明
    productIdpathYStringProduct Id
    長さ(最大/最小):0 / 10
    offsetquery stringNLongOffset
    最小:0
    最大:9,223,372,036,854,775,807
    limitquery stringNLongLimit
    最小:1
    最大:9,223,372,036,854,775,807
    apiIdquery stringNStringApi Id
    長さ(最大/最小):0 / 10
    stageIdquery stringNStringStage Id
    長さ(最大/最小):0 / 10
    apiKeyIdquery stringYStringApi Key Id
    長さ(最大/最小):0 / 10

    リクエストボディ

    • なし

    応答コード

    • 200

    応答ボディ

    {
      "apiKeyRelations" : {
        "total" : 5,
        "content" : [ {
          "apiName" : "apiName",
          "domainCode" : "domainCode",
          "monthlyUsage" : 5,
          "usagePlanId" : "usagePlanId",
          "monthCallCount" : 1,
          "apiKeyId" : "apiKeyId",
          "apiKeyName" : "apiKeyName",
          "usagePlanName" : "usagePlanName",
          "dailyUsage" : 0,
          "regTime" : "2000-01-23T04:56:07.000+00:00",
          "stageName" : "stageName",
          "modTime" : "2000-01-23T04:56:07.000+00:00",
          "dayCallCount" : 6,
          "apiId" : "apiId",
          "stageId" : "stageId"
        } ]
      }
    }
    

    サブスクリプションの状態を変更

    URL

    PATCH https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/api-keys/{api-key-id}
    

    リクエストパラメータ

    名前位置必須かどうかタイプ説明
    productIdpathYStringProduct Id
    長さ(最大/最小):0 / 10
    apiKeyIdpathYStringApi Key Id
    長さ(最大/最小):0 / 10

    リクエストボディ

    {
      "status" : "ACCEPTED"
    }
    

    応答コード

    • 204

    応答ボディ

    • なし

    この記事は役に立ちましたか?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.