PutSecretValue - 為憑據存入一個新版本的憑據值 -

介面說明

RAM 使用者或 RAM 角色調用該 OpenAPI 需要被授與權限策略詳情，請參見存取控制。
僅通用憑據支援本介面，每個通用憑據最多儲存 10 個憑據版本，超出時 KMS 會滾動刪除最早的憑據版本。
預設情況下，新存入的憑據值被標記為 ACSCurrent，而 ACSCurrent 標記的前一個版本被標記為 ACSPrevious。您可以通過指定 VersionStage 參數來覆蓋該預設行為。
此介面用於存入新版本的憑據值，而不能用於修改已有版本的憑據值。存入新版本時需指定版本號碼，KMS 按照如下規則進行操作：
- 版本號碼在憑據內不存在：建立新版本並存入憑據值。
- 版本號碼在憑據記憶體在：如果入參中的憑據值和憑據內該版本號碼對應的憑據值相同，則請求會被忽略，並且返回成功（請求是等冪的），不相同時則請求會被拒絕，且返回失敗。

本文將提供一個樣本，為憑據名稱是secret001的憑據存入一個新版本的憑據值，新憑據版本號碼VersionId為v3、憑據值SecretData為importantdata。

調試

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

調試

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱	類型	必填	描述	樣本值
VersionId	string	是	憑據的版本號碼，在該憑據內唯一。	v3
SecretName	string	是	憑據名稱或憑據資源名稱（ARN）。說明訪問其他阿里雲帳號下的憑據時，必須輸入憑據 ARN。憑據 ARN 的格式為`acs:kms:${region}:${account}:secret/${secret-name}`。	secret001
SecretData	string	是	憑據值。加密後存入指定的新版本中。	importantdata
SecretDataType	string	否	憑據實值型別。取值： text（預設值） binary	text
VersionStages	string	否	憑據版本在存入時需要被同時標記的版本狀態。如果您不指定此參數，KMS 預設為新版本戳記 ACSCurrent。	["ACSCurrent","ACSNext"]

關於公用請求參數的詳情，請參見公用參數。

返回參數

名稱	類型	描述	樣本值
	object
SecretName	string	憑據名稱。	secret001
VersionId	string	憑據的版本號碼。	v3
RequestId	string	本次調用請求的 ID，是由阿里雲為該請求產生的唯一識別碼，可用於排查和定位問題。	f94ec9d3-2d10-4922-9a5c-5dcd5ebcb5e8
VersionStages	object
VersionStage	array	憑據的版本狀態。
	string	憑據的版本狀態。	{ "VersionStage": [ "ACSCurrent", "ACSNext" ] }

樣本

正常返回樣本

JSON格式

{
  "SecretName": "secret001",
  "VersionId": "v3",
  "RequestId": "f94ec9d3-2d10-4922-9a5c-5dcd5ebcb5e8",
  "VersionStages": {
    "VersionStage": [
      "{ \"VersionStage\": [ \"ACSCurrent\", \"ACSNext\" ] }"
    ]
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊
400	InvalidParameter	some of the specified parameters "\" is not valid
400	Rejected.LimitExceeded	exceed secret limits error
500	InternalFailure	Internal Failure
403	Forbidden.NoPermission	This operation is forbidden by permission system
404	Forbidden.ResourceNotFound	Resource not found
409	Rejected.ResourceExist	The request was rejected becasue key already exsit

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

變更歷史

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