ListSecrets - 列出密鑰 - API Gateway

列出密鑰。

介面說明

介面支援建立多個服務。

調試

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

調試

授權資訊

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

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

apig:ListSecrets

list

*全部資源

*

無

請求文法

GET /v1/secrets HTTP/1.1

請求參數

名稱	類型	必填	描述	樣本值
nameLike	string	否	密鑰名稱，模糊搜尋。	my_secret
pageNumber	integer	否	分頁頁碼。	1
pageSize	integer	否	分頁大小，有效範圍[1, 100]，不填預設 10。	10
gatewayType	string	否	網關類型過濾，目前支援 AI、API 兩種網關類型。	AI

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
requestId	string	Id of the request	3A3D1392-0F71-5A10-9AE8-89C434696966
code	string	響應狀態代碼。	Ok
message	string	響應訊息，	success
data	object	密鑰資訊列表。
totalSize	integer	總數量。	10
pageNumber	integer	分頁頁碼。	1
pageSize	integer	分頁大小。	10
items	array<object>	密鑰詳情列表。
	object	密鑰詳情。
secretId	string	金鑰識別碼。	sec-d5e6shmm1hkoxxxxxxxx
name	string	密鑰名稱。	my_secret
secretSource	string	密鑰來源。	KMS
createTimestamp	integer	建立時間戳記。	1725617840096
updateTimestamp	integer	更新時間戳記。單位: 毫秒。	1721116090326
kmsConfig	KMSConfig	KMS 配置資訊。
gatewayType	string	網關類型。	API
status	string	密鑰狀態： ENABLE：已啟用； DISABLE：不可用； DELETED：已刪除。	ENABLE
referenceCount	integer	引用當前密鑰的資源數量。	3

樣本

正常返回樣本

JSON格式

{
  "requestId": "3A3D1392-0F71-5A10-9AE8-89C434696966",
  "code": "Ok",
  "message": "success",
  "data": {
    "totalSize": 10,
    "pageNumber": 1,
    "pageSize": 10,
    "items": [
      {
        "secretId": "sec-d5e6shmm1hkoxxxxxxxx",
        "name": "my_secret",
        "secretSource": "KMS",
        "createTimestamp": 1725617840096,
        "updateTimestamp": 1721116090326,
        "kmsConfig": {
          "kmsInstanceId": "kst-xxxxxxxx",
          "kmsKeyId": "key-xxxxxxxx"
        },
        "gatewayType": "API",
        "status": "ENABLE",
        "referenceCount": 3
      }
    ]
  }
}

錯誤碼

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

變更歷史

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