全部產品
Search
文件中心

Simple Log Service:GetApiKey

更新時間:Sep 17, 2026

根據 ApiKey 名稱取得指定 ApiKey 的詳細資訊。

介面說明

請求說明

  • 該 API 用於透過 apiKeyName 取得指定 ApiKey 的詳細資訊。

  • 回傳的資訊包括 ApiKey 的名稱、金鑰、狀態、描述、允許寫入的儲存列表、建立時間和更新時間。

  • log:GetApiKey 被視為敏感權限,呼叫時需謹慎。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊,可以在RAM權限原則語句的Action元素中使用,用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下:

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

log:GetApiKey

get

*Project

acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/apikey/{#ApiKeyName}

無 無

請求文法

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
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情。