DsgDesensPlanQueryList で DSG データマスキングルールクエリを自動化 - DataWorks

DsgDesensPlanQueryList API を呼び出して、Data Security Guard (DSG) のデータマスキングルールをクエリします。

今すぐお試しください

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

list

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
PageNumber	integer	必須	ページ番号。	1
PageSize	integer	必須	各ページに返すエントリ数。最大値は 100 です。	10
SceneId	integer	必須	レベル 2 データマスキングシーンの ID。この ID を取得するには、DsgSceneQuerySceneListByName 操作を呼び出します。	123
RuleName	string	任意	マスキングルールの名前。	phone
Owner	string	任意	マスキングルールのオーナー。	user1
Status	integer	任意	マスキングルールのステータス。有効な値： 0：無効 1：有効	1

レスポンスフィールド

フィールド	型	説明	例
	object	OpenApiResultModel<PagingResultModel>
Success	boolean	リクエストが成功したかどうかを示します。有効な値： true：リクエストは成功しました。 false：リクエストは失敗しました。	true
ErrorCode	string	エラーコード。	1029030003
ErrorMessage	string	エラーメッセージ。	param error
HttpStatusCode	integer	HTTP ステータスコード。	400
PageData	object	ページ分割されたデータ。
PageNumber	integer	ページ番号。	1
PageSize	integer	ページあたりのエントリ数。最大値：100。	10
TotalCount	integer	一致するマスキングルールの総数。	100
Data	array<object>	マスキングルールの詳細。
	array<object>	単一のマスキングルールオブジェクト。
Id	integer	マスキングルールの ID。	123
DataType	string	機密データの型。	phone
RuleName	string	マスキングルールの名前。	phone_hash
DesensPlan	object	マスキングプランの詳細。
DesensPlanType	string	マスキングプランのタイプ。	hash
ExtParam	object	マスキングルールのパラメーター。詳細については、「DsgDesensPlanAddOrUpdate」をご参照ください。
	any	マスキングルールパラメーターの詳細。	"extParam": { "algo":"MD5", "salt":"5" }
Owner	string	マスキングルールのオーナー。	user1
GmtCreate	string	ルールが作成された時間。	2024-05-09 15:46:20
GmtModified	string	ルールが最後に変更された時間。	2024-05-09 15:46:20
Status	integer	ルールのステータス。有効な値： 0：無効。 1：有効。	1
DesensWay	string	マスキングメソッド。	HASH
DesenMode	string	マスキングメソッド。	HASH
DesensRule	string	マスキングルール。	HASH
SceneCode	string	レベル 1 マスキングシーンコード。有効な値：データ開発およびデータマップでの表示のためのマスキング：dataworks_display_desense_code MaxCompute エンジンレイヤーでのマスキング：maxcompute_desense_code MaxCompute エンジンレイヤーでのマスキング (新規)：maxcompute_new_desense_code Hologres エンジンレイヤーでのマスキング：hologres_display_desense_code データ統合での静的マスキング：dataworks_data_integration_desense_code データ分析での表示のためのマスキング：dataworks_analysis_desense_code	dataworks_display_desense_code
CheckWatermark	boolean	ウォーターマークを追加するかどうかを示します。有効な値： true：ウォーターマークが追加されます。 false：ウォーターマークは追加されません。	true
SceneName	string	レベル 2 マスキングシーンの名前。	test_scene
emptyNotDesesn	boolean
columns	array<object>
	object
dbType	string
project	string
table	string
column	string
RequestId	string	リクエスト ID。この ID を使用して、ログの特定や問題のトラブルシューティングを行うことができます。	102400001

例

成功レスポンス

JSONJSON

{
  "Success": true,
  "ErrorCode": "1029030003",
  "ErrorMessage": "param error",
  "HttpStatusCode": 400,
  "PageData": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 100,
    "Data": [
      {
        "Id": 123,
        "DataType": "phone",
        "RuleName": "phone_hash",
        "DesensPlan": {
          "DesensPlanType": "hash",
          "ExtParam": {
            "key": "\"extParam\": {             \"algo\":\"MD5\",             \"salt\":\"5\"           }"
          }
        },
        "Owner": "user1",
        "GmtCreate": "2024-05-09 15:46:20",
        "GmtModified": "2024-05-09 15:46:20",
        "Status": 1,
        "DesensWay": "HASH",
        "DesenMode": "HASH",
        "DesensRule": "HASH",
        "SceneCode": "dataworks_display_desense_code",
        "CheckWatermark": true,
        "SceneName": "test_scene",
        "emptyNotDesesn": false,
        "columns": [
          {
            "dbType": "",
            "project": "",
            "table": "",
            "column": ""
          }
        ]
      }
    ]
  },
  "RequestId": "102400001"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	DESENSPLAN.DATATYPE.ERROR	Sensitive type already has a desensitization rule.
400	DESENSPLAN.DATATYPENOTEXIST.ERROR	Sensitive type not exist.
400	DESENSPLAN.ID.ERROR	Desensitization rule ID does not exist.
400	DESENSPLAN.PAGESIZE.ERROR	Page size is too large, maximum of 100.
400	DESENSPLAN.PARAM.ERROR	Desensitization rule parameter error.
400	DESENSPLAN.SCENECODE.ERROR	Scene code does not exist.
400	DESENSPLAN.SCENEID.ERROR	Scene ID does not exist.
400	DESENSPLAN.SCENEIDLEVEL.ERROR	The scene is not a secondary scene.
400	DESENSPLAN.SIZE.ERROR	The number of desens plan exceeds the limit.
400	PARAMS.ERROR	param error.
500	UNKNOWN.ERROR	unknown error.
403	PERMISSION.DENIED.ERROR	Permission denied

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

変更履歴

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