根據 ApiKey 名稱取得指定 ApiKey 的詳細資訊。
介面說明
請求說明
該 API 用於透過
apiKeyName取得指定 ApiKey 的詳細資訊。回傳的資訊包括 ApiKey 的名稱、金鑰、狀態、描述、允許寫入的儲存列表、建立時間和更新時間。
log:GetApiKey被視為敏感權限,呼叫時需謹慎。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
log:GetApiKey |
get |
*Project
|
無 | 無 |
請求文法
GET /apikeys/{apiKeyName} HTTP/1.1
路徑參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| apiKeyName |
string |
是 |
API Key 名稱。 |
demo-apikey-001 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| project |
string |
否 |
Project 名稱。 |
test |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
回應參數。 |
||
| apiKeyName |
string |
API Key 名稱。 |
demo-apikey-001 |
| apiKey |
string |
ApiKey 明文。 |
|
| status |
string |
狀態。 |
Enabled / Disabled |
| description |
string |
描述。 |
test |
| allowedStores |
array |
允許寫入的 LogStore 列表。 |
|
|
string |
LogStore 名稱。 |
test |
|
| createTime |
integer |
建立時間。 |
1788420000 |
| updateTime |
integer |
更新時間。 |
1788420000 |
樣本
正常返回樣本
JSON格式
{
"apiKeyName": "demo-apikey-001",
"apiKey": "",
"status": "Enabled / Disabled",
"description": "test",
"allowedStores": [
"test"
],
"createTime": 1788420000,
"updateTime": 1788420000
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。