Product Overviewの照会

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

リクエスト

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

リクエストヘッダ

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

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

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

リクエスト例

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

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

レスポンス

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

レスポンス構文

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

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

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

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

レスポンス例

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

{
    "apis": [
        {
            "stages": [
                {
                    "stageId": "***5ei7***",
                    "stageName": "stage",
                    "deployedStageDeploymentNo": 250***,
                    "host": "https://***ksk9***.apigw.ntruss.com"
                }
            ],
            "apiId": "***51hs***",
            "apiName": "api000",
            "methodsCount": 6
        }
    ],
    "apiKeyCountInfo": {
        "accepted": 0,
        "rejected": 0,
        "request": 0,
        "denied": 0,
        "total": 0
    }
}