ModifyInstanceTDE - Tair (Redis® OSS-Compatible) - Alibaba Cloud ドキュメントセンター

操作説明

説明

TDE の概要および TDE が及ぼす影響について詳しくは、「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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

kvstore:ModifyInstanceTDE

update

*DBInstance

acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

kvstore:TDEStatus

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	必須	インスタンスの ID です。インスタンス ID を照会するには、DescribeInstances 操作を呼び出します。	r-bp1zxszhcgatnx****
TDEStatus	string	必須	TDE の有効化設定を指定します。Enabled を指定してください。説明 TDE を有効化した後は、無効化できません。有効化前に、この機能が業務に与える影響を評価してください。詳細については、「TDE の有効化」をご参照ください。	Enabled
EncryptionName	string	任意	暗号化アルゴリズムです。デフォルト値：AES-CTR-256。説明このパラメーターは、TDEStatus パラメーターを Enabled に設定した場合のみ使用可能です。	AES-CTR-256
EncryptionKey	string	任意	カスタムキーの ID です。キー ID を照会するには、DescribeEncryptionKeyList 操作を呼び出します。説明このパラメーターを指定しない場合、Key Management Service (KMS) により自動的にキーが生成されます。カスタムキーを作成するには、KMS API の CreateKey 操作を呼び出します。	ad463061-992d-4195-8a94-ed63********
RoleArn	string	任意	ご利用の Tair（Redis OSS互換）インスタンスにアタッチする Resource Access Management（RAM）ロールの Alibaba Cloud リソース名（ARN）です。ARN は `acs:ram::$accountID:role/$roleName` の形式である必要があります。ロールをアタッチすると、Tair（Redis OSS互換）インスタンスで KMS を利用できるようになります。説明 `$accountID`：Alibaba Cloud アカウントの ID です。アカウント ID を確認するには、Alibaba Cloud コンソールにログインし、ページ右上隅のプロフィール画像にポインターを合わせて、セキュリティ設定をクリックします。 `$roleName`：RAM ロールの名前です。AliyunRdsInstanceEncryptionDefaultRole に置き換えてください。	acs:ram::123456789012****:role/AliyunRdsInstanceEncryptionDefaultRole

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエストの ID です。	5D622714-AEDD-4609-9167-F5DDD3D1****

例

成功レスポンス

JSONJSON

{
  "RequestId": "5D622714-AEDD-4609-9167-F5DDD3D1****"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidInstanceName.Malformed	The Specified parameter InstanceName is not valid.
400	TaskExists	Specified task have existed.

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

変更履歴

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