API Keyの検索
- 印刷する
- PDF
API Keyの検索
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
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 | 照会対象のデータリストからスタートする位置
|
limit | Long | Optional | 一度に照会するデータ数
|
productId | Long | Required | API Keyと関連付けられた Product ID
|
apiKeyName | String | Optional | API Key名でフィルタリング
|
statusSet | Object | Optional | Productと関連付けられた API Keyの状態でフィルタリング
|
リクエスト例
リクエストのサンプルコードは次の通りです。
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
}
この記事は役に立ちましたか?