DescribeMaskingRules - - 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:DescribeMaskingRules

get

*DBCluster

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBClusterId	string	必須	クラスターの ID です。説明 DescribeDBClusters 操作を呼び出すことで、ご利用の Alibaba Cloud アカウントに属するクラスターの詳細 (クラスター ID など) を照会できます。	pc-*****************
RuleNameList	string	任意	マスキングルールの名前です。	testrule
InterfaceVersion	string	任意	データマスキングルールまたはデータ暗号化ルールを照会します。有効な値： v1：データマスキングルールを照会します。v2：データ暗号化ルールを照会します。	v1

レスポンスフィールド

フィールド	型	説明	例
	object	応答のスキーマ
RequestId	string	リクエスト ID です。	2F83D131-1C18-4599-889D-729A9D******
Message	string	リクエストに対して返されるメッセージです。説明リクエストが成功した場合、`Successful` が返されます。リクエストが失敗した場合、エラーコードなどのエラーメッセージが返されます。	Successful
Success	boolean	リクエストが成功したかどうかを示します。有効な値： true false	true
Data	object	返される結果データです。
RuleList	array	マスキングルールの詳細です。
	string	マスキングルールの詳細な設定です。説明詳細については、「ModifyMaskingRules」操作の `RuleConfig` パラメーターをご参照ください。	"{\"testrule\":{\"auto\":{\"databases\":[],\"tables\":[\"t1\"],\"columns\":[\"c1\"]},\"applies_to\":[],\"description\":\"This rule will be applied to the columns c1 in table t1\",\"enabled\":\"true\"}}"
RuleVersion	string	マスキングルールのバージョンです。有効な値は v1 と v2 です。デフォルト値：v1	v1
DBClusterId	string	クラスターの ID です。	pc-bp1s826a1up******

例

成功レスポンス

JSONJSON

{
  "RequestId": "2F83D131-1C18-4599-889D-729A9D******",
  "Message": "Successful",
  "Success": true,
  "Data": {
    "RuleList": [
      "\"{\\\"testrule\\\":{\\\"auto\\\":{\\\"databases\\\":[],\\\"tables\\\":[\\\"t1\\\"],\\\"columns\\\":[\\\"c1\\\"]},\\\"applies_to\\\":[],\\\"description\\\":\\\"This rule will be applied to the columns c1 in table t1\\\",\\\"enabled\\\":\\\"true\\\"}}\""
    ],
    "RuleVersion": "v1"
  },
  "DBClusterId": "pc-bp1s826a1up******"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	Abs.InvalidAccount.NotFound	account is not found.
404	InvalidDBClusterId.NotFound	The DBClusterId provided does not exist in our records.
404	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.

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

変更履歴

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