API Keyの検索

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

リクエストボディに照会条件を入力して当てはまる API Key情報を検索します。

リクエスト

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

メソッド	URI
POST	/api-keys/search

リクエストヘッダ

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

リクエスト構文

リクエスト構文は次の通りです。

{
  "offset" : 0,
  "limit" : 0,
  "productId" : "productId",
  "apiKeyName" : "apiKeyName",
  "statusSet" : [ "statusSet" ]
}

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`offset`	Long	Optional	照会対象のデータリストからスタートする位置 0~9,223,372,036,854,775,807
`limit`	Long	Optional	一度に照会するデータ数 1~9,223,372,036,854,775,807
`productId`	Long	Required	API Keyと関連付けられた Product ID 1~10
`apiKeyName`	String	Optional	API Key名でフィルタリング 0~20
`statusSet`	Object	Optional	Productと関連付けられた API Keyの状態でフィルタリング `ACCEPTED` \| `REJECTED` \| `REQUEST` \| `DENY` \| `BLOCKED_REQUEST` `ACCEPTED`: 承認 `REJECTED`: 拒否 `REQUEST`: リクエスト `DENY`: リクエスト拒否 `BLOCKED_REQUEST`: リクエストブロック

リクエスト例

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

curl -X POST 'https://apigateway.apigw.ntruss.com/api/v1/api-keys/search' \
--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}'
--data '{
  "offset" : 6,
  "productId": "*****xn0bk",
  "limit" : 1,
  "apiKeyName" : "apiKey-***",
  "statusSet" : [ "REQUEST" ]
}'

レスポンス

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

レスポンス構文

構文は次の通りです。

{
    "apiKeys": [
        {
            "apiKeyId": "apiKeyId",
            "apiKeyName": "apiKeyName",
            "apiKeyDescription": "apiKeyDescription",
            "status": "status"
        }
    ],
    "total": 0
}

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

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

レスポンス例

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

{
    "apiKeys": [
        {
            "apiKeyId": "*****vg079",
            "apiKeyName": "apiKey-***",
            "apiKeyDescription": "apiKey-*** Description",
            "status": "ACCEPTED"
        }
    ],
    "total": 1
}