API でデータマスキングホワイトリストを管理 - DataWorks

データマスキングホワイトリストを追加または更新します。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

dataworks:DsgWhiteListAddOrUpdate

list

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
WhiteLists	array<object>	必須	ホワイトリストのコレクションです。
	object	任意
RuleId	integer	必須	データマスキングルールの ID です。この ID を照会するには、DsgDesensPlanQueryList 操作を呼び出します。	123
Id	integer	任意	データマスキングホワイトリストの ID です。このパラメーターを設定しない場合、現在の操作はホワイトリストの追加となります。このパラメーターを設定した場合、現在の操作はホワイトリストの更新となります。ホワイトリスト ID を照会するには、DsgWhiteListQueryList 操作を呼び出します。	123
StartTime	string	必須	照会対象の時間範囲の開始時刻です。	2024-04-10 00:00:00
EndTime	string	任意	照会対象の時間範囲の終了時刻です。null を指定した場合、ホワイトリストは永久に有効になります。	null
UserGroupIds	array	必須	ユーザーグループ ID のコレクションです。
	integer	任意	ユーザーグループ ID です。この ID を照会するには、DsgUserGroupQueryList 操作を呼び出します。	123

レスポンスフィールド

フィールド	型	説明	例
	object	応答結果です。
Success	boolean	リクエストが成功したかどうかを示します。有効な値は以下のとおりです。 true false	true
ErrorCode	string	エラーコードです。	1029030003
ErrorMessage	string	エラーメッセージです。	param error
HttpStatusCode	integer	HTTP ステータスコードです。	400
Data	boolean	操作の結果です。有効な値は以下のとおりです。 true：操作が成功しました。 false：操作が失敗しました。	true
RequestId	string	リクエスト ID です。この ID を使用してログを特定し、問題のトラブルシューティングを行います。	102400001

例

成功レスポンス

JSONJSON

{
  "Success": true,
  "ErrorCode": "1029030003",
  "ErrorMessage": "param error",
  "HttpStatusCode": 400,
  "Data": true,
  "RequestId": "102400001"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	WHITELIST.DESENSID.ERROR	The desensitization rule ID does not match or does not exist with the tenant.
400	WHITELIST.ENDTIME.ERROR	end time cannot be earlier than start time.
400	WHITELIST.ID.ERROR	The whitelist ID does not match or does not exist with the tenant.
400	WHITELIST.MCPROJECT.ERROR	The projectName on the bottom layer desensitization whitelist of MC cannot be empty.
400	WHITELIST.PAGESIZE.ERROR	Page size is too large, maximum of 100.
400	WHITELIST.SIZE.ERROR	The number of white list exceeds the limit.
400	WHITELIST.STARTTIME.ERROR	start time cannot be earlier than today.
400	WHITELIST.TIMEFORMAT.ERROR	The time format is incorrect, please use yyyy MM dd HH: mm: ss format.
400	WHITELIST.USERGROUP.ERROR	The user group ID does not match or does not exist with the tenant.
400	WHITELIST.USERGROUPEMPTY.ERROR	User group ID cannot be empty.
400	WHITELIST.USERGROUPLISTSIZE.ERROR	The number of user group exceeds the limit.
400	PARAMS.ERROR	param error.
500	UNKNOWN.ERROR	unknown error.
403	PERMISSION.DENIED.ERROR	Permission denied

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

変更履歴

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