Productサブスクリプションの照会

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

リクエスト

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

リクエストヘッダ

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

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

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

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

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

リクエスト例

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

curl --location --request GET 'https://apigateway.apigw.ntruss.com/api/v1/products/***ksk9***/subscription-detail?apiKeyId=***fmy2***&apiId=***51hs***&stageId=***5ei7***' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンス構文

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

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

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

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

レスポンス例

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

{
    "apiKeyRelations": {
        "content": [
            {
                "apiId": "***51hs***",
                "apiName": "api000",
                "stageId": "***5ei7***",
                "stageName": "stage",
                "apiKeyId": "***fmy2***",
                "apiKeyName": "apikey000",
                "regTime": "2024-05-07T04:22:05Z",
                "modTime": "2024-05-07T04:22:05Z",
                "dayCallCount": 0,
                "monthCallCount": 0,
                "domainCode": "PUB"
            }
        ],
        "total": 1
    }
}