GetSecret - 擷取密鑰 - API Gateway

介面說明

介面支援建立多個服務。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

apig:GetSecret

none

*Domain

acs:apig:{#regionId}:{#accountId}:secret/{#SecretId}

無

請求文法

GET /v1/secrets/{secretId} HTTP/1.1

路徑參數

名稱	類型	必填	描述	樣本值
secretId	string	否	金鑰識別碼。	sec-d5e6shmm1hkoxxxxxxxx

請求參數

名稱

類型

必填

描述

樣本值

當前API無需請求參數

返回參數

名稱	類型	描述	樣本值
	object	Schema of Response
requestId	string	ID of the request.	CE857A85-251D-5018-8103-A38957D71E20
code	string	響應狀態代碼。	Ok
message	string	響應資訊。	success
data	object	密鑰資訊。
secretId	string	金鑰識別碼。	sec-d5e6shmm1hkoxxxxxxxx
name	string	名稱。	mysecret
secretSource	string	密鑰來源。	KMS
kmsConfig	KMSConfig	KMS 配置資訊。
gatewayType	string	網關類型，分以下兩種： API：表示 API Gateway AI: 表示 AI 網關	API
createTimestamp	integer	建立時間戳記。	1719386834548
updateTimestamp	integer	更新時間戳記。	1725868548440
status	string	密鑰狀態: ENALBE: 已啟用。 DISABLE: 不可用。 DELETED: 已刪除。	ENALBE
referenceCount	integer	引用當前密鑰的資源數。	1

樣本

正常返回樣本

JSON格式

{
  "requestId": "CE857A85-251D-5018-8103-A38957D71E20",
  "code": "Ok",
  "message": "success",
  "data": {
    "secretId": "sec-d5e6shmm1hkoxxxxxxxx",
    "name": "mysecret",
    "secretSource": "KMS",
    "kmsConfig": {
      "kmsInstanceId": "kst-xxxxxxxx",
      "kmsKeyId": "key-xxxxxxxx"
    },
    "gatewayType": "API",
    "createTimestamp": 1719386834548,
    "updateTimestamp": 1725868548440,
    "status": "ENALBE",
    "referenceCount": 1
  }
}

錯誤碼

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

變更歷史

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