PutSecretValue - - Alibaba Cloud ドキュメントセンター

操作説明

RAM ユーザーまたは RAM ロールがこの OpenAPI 操作を呼び出すために必要なアクセスポリシーについては、「Resource Access Management」をご参照ください。
この操作は汎用シークレットのみをサポートしています。各汎用シークレットは最大 10 個のバージョンを持つことができます。バージョンの数が制限を超えると、KMS は最も古いバージョンを削除します。
デフォルトでは、新しいシークレット値は ACSCurrent でマークされ、ACSCurrent でマークされていた以前のバージョンは ACSPrevious でマークされます。 VersionStage パラメーターを指定して、このデフォルトの動作を上書きできます。
この操作は、新しいバージョンのシークレット値を保存します。既存のバージョンのシークレット値を変更するために使用することはできません。新しいバージョンを保存するときは、バージョン番号を指定する必要があります。 KMS は次のルールに基づいてリクエストを処理します。
- シークレットにバージョン番号が存在しない場合、KMS は新しいバージョンを作成し、シークレット値を保存します。
- シークレットにバージョン番号がすでに存在する場合、KMS はリクエスト内のシークレット値を保存されている値と比較します。値が同じ場合、リクエストは無視され、成功メッセージが返されます。これにより、操作は冪等になります。値が異なる場合、リクエストは拒否されます。

このトピックでは、secret001 という名前のシークレットの新しいバージョンのシークレット値を保存する例を示します。新しいバージョン番号 (VersionId) は v3 で、シークレット値 (SecretData) は importantdata です。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエストパラメーター

パラメーター	タイプ	必須 / 任意	説明	例
VersionId	string	必須	シークレットのバージョン番号。値はシークレット内で一意である必要があります。	00000000000000000000000000000000203
SecretName	string	必須	シークレットの名前または Alibaba Cloud リソースネーム (ARN)。説明別の Alibaba Cloud アカウントのシークレットにアクセスする場合は、シークレットの 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	シークレットのバージョン番号。	00000000000000000000000000000000203
RequestId	string	リクエスト ID。Alibaba Cloud によって生成される一意の識別子です。この ID を使用して問題のトラブルシューティングを行うことができます。	f94ec9d3-2d10-4922-9a5c-5dcd5ebcb5e8
VersionStages	object
VersionStage	array	シークレットバージョンのステージラベル。
	string	シークレットバージョンのステージラベル。	{ "VersionStage": [ "ACSCurrent", "ACSNext" ] }

例

成功レスポンス

JSONJSON

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

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
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

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。