API Keyの詳細照会

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

API Keyの詳細情報を照会します。

リクエスト

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

リクエストヘッダ

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

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

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

リクエスト例

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

curl -X GET 'https://apigateway.apigw.ntruss.com/api/v1/api-keys/{api-key-id}' \
--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}'

レスポンス

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

レスポンス構文

構文は次の通りです。

{
    "apiKeyId": "apiKeyId",
    "tenantId": "tenantId",
    "apiKeyName": "apiKeyName",
    "apiKeyDescription": "apiKeyDescription",
    "primaryKey": "primaryKey",
    "secondaryKey": "secondaryKey",
    "modifier": "modifier",
    "isEnabled": true,
    "modTime": "2024-05-07T07:08:12Z",
    "domainCode": "domainCode"
}

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

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

レスポンス例

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

{
    "apiKeyId": "*****vg079",
    "tenantId": "*****02f55ae4436913a6e2c65bab47c",
    "apiKeyName": "apiKeyName",
    "apiKeyDescription": "apiKeyDescription",
    "primaryKey": "*****Vk37ZE39kJcZScH50cYsJiYf1EJUQ7haPj",
    "secondaryKey": "*****WKmt1IVMAlXtg0yJ5jelwwiltuJBFKBDW9",
    "modifier": "d12c9fd0-****-****-****-246e96591a38",
    "isEnabled": true,
    "modTime": "2024-05-07T07:08:12Z",
    "domainCode": "PUB"
}