指定されたプロジェクト内のすべての API キーとその詳細を照会します。
操作説明
リクエストの説明
allowedStore パラメーターを使用して、返される API キーをフィルターします。指定された Logstore または Metricstore への書き込みが許可されている API キーのみが返されます。
allowedStore パラメーターを指定しない場合、プロジェクト内のすべての API キーが返されます。
log:ListApiKeys 権限は機密性の高い権限と見なされるため、付与には注意してください。
今すぐお試しください
テスト
RAM 認証
リクエスト構文
GET /apikeys HTTP/1.1リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| allowedStore |
string |
任意 |
API キーの書き込みが許可されている Logstore。 |
test |
| size |
integer |
任意 |
ページサイズ。 |
10 |
| offset |
integer |
任意 |
ページ番号。 |
1 |
| project |
string |
任意 |
プロジェクト名。 |
test |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
応答データ。 |
||
| apiKeys |
array<object> |
API キーのリスト。 |
|
|
object |
API キー情報。 |
||
| apiKeyName |
string |
API キー名。 |
demo-apikey-001 |
| apiKey |
string |
API キーのプレーンテキスト。 |
|
| status |
string |
API キーのステータス。 |
Enabled |
| description |
string |
API キーの説明。 |
test |
| allowedStores |
array |
API キーの書き込みが許可されている Logstore のリスト。 |
|
|
string |
Logstore 名。 |
test |
|
| createTime |
integer |
API キーの作成時間。 |
1788420000 |
| updateTime |
integer |
API キーの最終更新時間。 |
1788420000 |
| count |
integer |
現在のページの API キー数。 |
10 |
| total |
integer |
API キーの総数。 |
20 |
例
成功レスポンス
JSONJSON
{
"apiKeys": [
{
"apiKeyName": "demo-apikey-001",
"apiKey": "",
"status": "Enabled",
"description": "test",
"allowedStores": [
"test"
],
"createTime": 1788420000,
"updateTime": 1788420000
}
],
"count": 10,
"total": 20
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。