PolarDB マスキングルール更新による機密データの保護 - PolarDB - Alibaba Cloud - PolarDB

データマスキングルールの作成または変更を行います。

今すぐお試しください

この 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:ModifyMaskingRules

update

*DBCluster

acs:polardb:{#regionId}:{#accountId}:{#resource-type}/{#resource-id}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBClusterId	string	必須	クラスター ID です。説明ご利用のアカウントに存在するすべてのクラスターの詳細（クラスター ID を含む）を照会するには、DescribeDBClusters 操作を呼び出してください。	pc-*****************
RuleName	string	任意	データマスキングルールの名前です。一度に指定できるルール名は 1 つだけです。説明対象クラスター内のすべてのデータマスキングルールの詳細（ルール名を含む）を照会するには、DescribeMaskingRules 操作を呼び出してください。指定された名前のルールが存在しない場合、システムは指定された `RuleConfig` に基づいて新しいルールを作成します。	testrule
RuleConfig	string	任意	ルール構成を指定する JSON 文字列です。例：`{"auto": {"databases": ["db1"], "tables": ["tb1"], "columns": ["c1,c2"] }, "description": "This rule will be applied to the columns c1 and c2 in table t1", "enabled": true, "applies_to": ["user"]}`。この JSON 文字列には以下のフィールドが含まれます。 `"auto"`：必須。動的データマスキングアルゴリズムの構成を含むオブジェクトです。 `"databases"`：任意。ルールを適用するデータベースです。複数のデータベース名をカンマ (,) で区切ります。このパラメーターを省略した場合、クラスター内のすべてのデータベースにルールが適用されます。 `"tables"`：任意。ルールを適用するテーブルです。複数のテーブル名をカンマ (,) で区切ります。このパラメーターを省略した場合、クラスター内のすべてのテーブルにルールが適用されます。 `"columns"`：必須。ルールを適用するカラムです。複数のカラム名をカンマ (,) で区切ります。 `"description"`：任意。ルールの説明です。最大 64 文字まで指定できます。 `"enabled"`：必須。データマスキングルールを有効にするかどうかを指定します。有効値：true（有効）、false（無効）。 `"applies_to"`：ルールを適用するデータベースアカウントです。複数のアカウント名をカンマ (,) で区切ります。 `"exempted"`：ルールの適用を除外するデータベースアカウントです。複数のアカウント名をカンマ (,) で区切ります。説明 `RuleName` パラメーターを指定する場合は、`RuleConfig` パラメーターも指定する必要があります。 `"applies_to"` または `"exempted"` のいずれか一方を指定する必要があります。	{"auto": {"databases": ["db1"], "tables": ["tb1"], "columns": ["c1,c2"] }, "description": "This rule will be applied to the columns c1 and c2 in table t1", "enabled": true, "applies_to": ["user"]}
RuleNameList	string	任意	データマスキングルール名のカンマ区切りリストです。説明 `RuleName` または `RuleNameList` パラメーターのいずれか一方を指定する必要があります。	testrule
Enable	string	任意	指定されたデータマスキングルールを有効または無効にします。有効値： true：指定されたルールを有効にします。 false：指定されたルールを無効にします。説明このパラメーターは、`RuleNameList` パラメーターが指定されている場合にのみ適用されます。	true
RuleVersion	string	任意	データマスキングルールのバージョンです。有効値： v1（デフォルト） v2	v2
InterfaceVersion	string	任意	変更するルールのタイプです。有効値： v1：データマスキングルールを変更します。 v2：暗号化ルールを変更します。	v1
MaskingAlgo	string	任意	マスキングアルゴリズムです。1 つ以上のアルゴリズムとそのパラメーターを指定します。形式：`[{ "name": "algorithm_name", "params": {"key": "value"} }]`	[{ "name": "aes-128-gcm" }]
DefaultAlgo	string	任意	デフォルトアルゴリズムです。説明 MaskingAlgo または DefaultAlgo のいずれか一方を指定する必要があります。	aes-128-gcm

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID です。	99B355CE-526C-478B-B730-AD9D7C******
Message	string	応答メッセージです。説明リクエストが成功した場合は `Successful` が返されます。リクエストが失敗した場合は、エラーメッセージが返されます。	Message
Success	boolean	リクエストが成功したかどうかを示します。有効値： true false	true

例

成功レスポンス

JSONJSON

{
  "RequestId": "99B355CE-526C-478B-B730-AD9D7C******",
  "Message": "Message",
  "Success": true
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
404	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.

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

変更履歴

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