API Keyが関連付けられた Productの照会

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

API Keyと関連付けられた Productを照会します。

リクエスト

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

リクエストヘッダ

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

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

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

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

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

リクエスト例

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

curl -X GET 'https://apigateway.apigw.ntruss.com/api/v1/api-keys/{api-key-id}/products' \
--header 'Content-Type: application/json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンス構文

構文は次の通りです。

{
    "apiKeyRelateProductDtos": [
        {
            "productId": "productId",
            "productName": "productName",
            "productDescription": "productDescription",
            "publisherId": "publisherId",
            "status": "status",
            "regTime": "2024-05-07T08:08:51Z",
            "modTime": "2024-05-07T08:08:51Z",
            "isSelfProduct": true
        }
    ],
    "total": 0
}

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

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

レスポンス例

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

{
    "apiKeyRelateProductDtos": [
        {
            "productId": "*****xn0bk",
            "productName": "*****",
            "productDescription": "product Description",
            "publisherId": "*****02f55ae4436913a6e2c65bab47c",
            "status": "ACCEPTED",
            "regTime": "2024-05-07T08:08:51Z",
            "modTime": "2024-05-07T08:08:51Z",
            "isSelfProduct": true
        }
    ],
    "total": 1
}