API Keyの照会
- 印刷する
- PDF
API Keyの照会
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
Classic/VPC環境で利用できます。
API Keyのリストを照会します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
メソッド | URI |
---|---|
GET | /api-keys |
リクエストヘッダ
API Gatewayで共通して使用されるヘッダの詳細は、API Gatewayのリクエストヘッダをご参照ください。
リクエストクエリパラメータ
パラメータの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
offset | Long | Optional | 照会対象のデータリストからスタートする位置
|
limit | Long | Optional | 一度に照会するデータ数
|
apiKeyName | String | Optional | API Key名でフィルタリング
|
リクエスト例
リクエストのサンプルコードは次の通りです。
curl -X GET 'https://apigateway.apigw.ntruss.com/api/v1/api-keys' \
--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}'
レスポンス
レスポンス形式を説明します。
レスポンス構文
構文は次の通りです。
{
"apiKeys": [
{
"apiKeyId": "apiKeyId",
"tenantId": "tenantId",
"apiKeyName": "apiKeyName",
"apiKeyDescription": "apiKeyDescription",
"modifier": "modifier",
"isEnabled": true,
"modTime": "2024-05-07T07:08:12Z",
"domainCode": "domainCode"
}
],
"total": 0,
"initialCount": 0
}
レスポンスステータスコード
API Gatewayで共通して使用されるレスポンスステータスコードの詳細は、API Gatewayのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"apiKeys": [
{
"apiKeyId": "*****vg079",
"tenantId": "*****02f55ae4436913a6e2c65bab47c",
"apiKeyName": "apiKeyName",
"apiKeyDescription": "apiKeyDescription",
"modifier": "d12c9fd0-****-****-****-246e96591a38",
"isEnabled": true,
"modTime": "2024-05-07T07:08:12Z",
"domainCode": "PUB"
}
],
"total": 1,
"initialCount": 1
}
この記事は役に立ちましたか?