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

:ModifyMaskingRules

最終更新日:Dec 15, 2025

データマスキングルールの構成を変更するか、新しいルールを作成します。

今すぐお試しください

この 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 です。

説明

DescribeDBClusters 操作を呼び出して、アカウントに属するすべてのクラスターの詳細 (クラスター ID を含む) を照会できます。

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"]}。パラメーターは次のとおりです:

  • "auto":必須。動的データマスキングアルゴリズムの設定です。

  • "databases":任意。ルールが適用されるデータベースです。複数のデータベース名を指定できます。名前はコンマ (,) で区切ります。このパラメーターを空のままにすると、ルールはクラスター内のすべてのデータベースに適用されます。

  • "tables":任意。ルールが適用されるテーブルです。複数のテーブル名を指定できます。名前はコンマ (,) で区切ります。このパラメーターを空のままにすると、ルールはクラスター内のすべてのテーブルに適用されます。

  • "columns":必須。ルールが適用されるフィールドです。複数のフィールド名を指定できます。名前はコンマ (,) で区切ります。

  • "description":任意。データマスキングルールの説明です。説明は最大 64 文字です。

  • "enabled":必須。データマスキングルールを有効にするかどうかを指定します。有効な値:true (有効) および false (無効)。

  • "applies_to":ルールが適用されるデータベースアカウントです。複数のデータベースアカウント名を指定できます。名前はコンマ (,) で区切ります。

  • "exempted":ルールから免除されるデータベースアカウントです。複数のデータベースアカウント名を指定できます。名前はコンマ (,) で区切ります。

説明
  • RuleName パラメーターを指定する場合、このパラメーターは必須です。

  • "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

任意

データマスキングルール名のリストです。1 つ以上のルール名をコンマ (,) で区切って指定できます。

説明

RuleName または RuleNameList パラメーターのいずれかを指定する必要があります。

testrule

Enable

string

任意

データマスキングルールを有効にするかどうかを指定します。有効な値:

  • true:ルールを有効にします。

  • false:ルールを無効にします。

説明

このパラメーターは、RuleNameList パラメーターを指定した場合にのみ有効です。

true

RuleVersion

string

任意

データマスキングルールのバージョンです。有効な値:

  • v1 (デフォルト)

  • v2

v2

InterfaceVersion

string

任意

変更するルールのタイプです。有効な値:

v1:データマスキングルール。v2:暗号化ルール。

v1

MaskingAlgo

string

任意

DefaultAlgo

string

任意

レスポンスフィールド

フィールド

説明

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.

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

変更履歴

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