すべてのプロダクト
Search
ドキュメントセンター

Key Management Service:UpdateSecret

最終更新日:Dec 21, 2025

シークレットのメタデータを更新します。

操作説明

この例では、secret001 という名前のシークレットのメタデータが更新されます。Description パラメーターは datainfo に設定されます。

今すぐお試しください

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

テスト

RAM 認証

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

リクエストパラメーター

パラメーター

必須 / 任意

説明

SecretName

string

必須

シークレットの名前。

secret001

Description

string

任意

シークレットの説明。

datainfo

ExtendedConfig.CustomData

object

任意

シークレットの拡張構成におけるカスタムデータ。

説明
  • このパラメーターを指定すると、シークレットの既存の拡張構成が更新されます。

  • このパラメーターは、汎用シークレットでは利用できません。

{"DBName":"app1","Port":"3306"}

共通リクエストパラメーターの詳細については、「共通パラメーター」をご参照ください。

レスポンスフィールド

フィールド

説明

object

SecretName

string

シークレットの名前。

secret001

RequestId

string

リクエスト ID。問題を特定し、トラブルシューティングするために使用されます。

5b75d8b1-5b6a-4ec0-8e0c-c08befdfad47

成功レスポンス

JSONJSON

{
  "SecretName": "secret001",
  "RequestId": "5b75d8b1-5b6a-4ec0-8e0c-c08befdfad47"
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 InvalidParameter some of the specified parameters "\" is not valid
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
409 Rejected.ResourceInDeleteWindow secret in delete peroid

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

変更履歴

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