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

操作説明

説明

この操作を実行する前に、Key Management Service (KMS) を有効化する必要があります。詳細については、「専用 KMS インスタンスの購入」をご参照ください。
TDE (透過的データ暗号化) は、一度有効にすると無効にできません。

今すぐお試しください

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

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

polardb:ModifyDBClusterTDE

update

*DBCluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBClusterId	string	必須	クラスター ID。	pc-************
TDEStatus	string	必須	TDE ステータス。値を Enable に設定します。	Enable
RoleArn	string	任意	ロールの Alibaba Cloud Resource Name (ARN)。このパラメーターを使用してロールを指定できます。詳細については、「RAM ロールの概要」をご参照ください。	acs:ram::1406926*****:role/aliyunrdsinstanceencryptiondefaultrole
EncryptionKey	string	任意	カスタムキーの ID。	749c1df7-**---*******
EncryptNewTables	string	任意	新しく作成されるすべてのテーブルを自動的に暗号化するかどうかを指定します。有効な値： ON OFF 説明このパラメーターは、データベースエンジンが MySQL と互換性がある場合にのみ有効です。	ON
EnableAutomaticRotation	string	任意	KMS キーの新しいバージョンが利用可能になった後、次の O&M ウィンドウ中にインスタンスの TDE キーを自動的にローテーションするかどうかを指定します。このパラメーターはカスタムキーにのみ有効です。 true false 説明このパラメーターは、データベースエンジンが PostgreSQL または Oracle と互換性がある場合にのみサポートされます。	false

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	5F859238-2A36-4A8D-BD0F-732112******

例

成功レスポンス

JSONJSON

{
  "RequestId": "5F859238-2A36-4A8D-BD0F-732112******"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidTDEStatus.AlreadyEnabled	TDE has already enabled in the this cluster.
400	InvalidDBType.Malformed	The Specified DBType is not valid.
400	InvalidTDEEnabledType.Malformed	The specified parameter TDEStatus is not valid.
400	InvalidAutoTableTransparentEncryption.Malformed	The specified AutoTableTransparentEncryption is not valid.
403	UnsupportedKmsService.NotEnabled	KMS service is not enabled.
403	OperationDenied.DBNodeType	The operation is not permitted due to type of node.
403	IncorrectGdnState	db instance %s status is not available:%s.
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.
404	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.

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

変更履歴

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