機密データマスク向け DsgQueryDefaultTemplates API - DataWorks

利用可能な機密データ型テンプレートおよびそれらがサポートする非識別化ルールを取得します。このAPI の応答を使用して、非識別化ルールを設定します。

今すぐお試しください

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

list

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
SceneId	integer	必須	レベル 2 脱感作シーンの ID。この ID を取得するには、DsgSceneQuerySceneListByName API を呼び出します。	123

レスポンスフィールド

フィールド	型	説明	例
	object	応答データ。
Success	boolean	リクエストが成功したかどうかを示します。有効な値： true：リクエストは成功しました。 false：リクエストは失敗しました。	true
ErrorCode	string	リクエストが失敗した場合に返されるエラーコード。	1029030003
ErrorMessage	string	リクエストが失敗した場合に返されるエラーメッセージ。	param error
HttpStatusCode	integer	返される HTTP ステータスコード。	400
Data	array<object>	返されたデータ。
	array<object>	センシティブデータ型テンプレートを表すオブジェクト。
DataType	string	センシティブデータ型。	phone
DesensPlanTemplate	object	サポートされている脱感作方法とそのパラメーターの説明のリスト。
	array<object>	データ秘匿化手法とそのパラメーター。
	object	秘匿化方式およびそのパラメーター。
Name	string	ディセンシタイゼーション手法の名称です。	hash
SupportWaterMark	boolean	ウォーターマークがサポートされているかどうかを示します。有効な値： true：ウォーターマークはサポートされています。 false：ウォーターマークはサポートされていません。	true
ExtParamTemplate	array	非識別化パラメーターとその説明のリストです。
	any	サポートされている脱感作ルールとそのパラメーター構成を記述する JSON オブジェクト。このオブジェクトは参照用であり、脱感作ルールの作成または変更のための直接の入力として使用することはできません。	{ "key": "algo", "valueEnum": [ "MD5", "SHA256", "SHA512", "SM3" ], "valueType": "string" }, { "key": "salt", "valueEnum": [ 1, 2, 3, 4, 5, 6, 7, 8, 9 ], "valueType": "int" }
RequestId	string	リクエスト ID。この ID を使用して問題をトラブルシューティングできます。	102400001

例

成功レスポンス

JSONJSON

{
  "Success": true,
  "ErrorCode": "1029030003",
  "ErrorMessage": "param error",
  "HttpStatusCode": 400,
  "Data": [
    {
      "DataType": "phone",
      "DesensPlanTemplate": {
        "key": [
          {
            "Name": "hash",
            "SupportWaterMark": true,
            "ExtParamTemplate": [
              "{                     \"key\": \"algo\",                     \"valueEnum\": [                         \"MD5\",                         \"SHA256\",                         \"SHA512\",                         \"SM3\"                     ],                     \"valueType\": \"string\"                 },                 {                     \"key\": \"salt\",                     \"valueEnum\": [                         1,                         2,                         3,                         4,                         5,                         6,                         7,                         8,                         9                     ],                     \"valueType\": \"int\"                 }"
            ]
          }
        ]
      }
    }
  ],
  "RequestId": "102400001"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	DESENSTEMPLATE.SCENE.ERROR	Scene ID does not exist.
400	DESENSTEMPLATE.SCENELEVEL.ERROR	The scene is not a secondary scene.
400	PARAMS.ERROR	param error.
500	UNKNOWN.ERROR	unknown error.
403	PERMISSION.DENIED.ERROR	Permission denied

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

変更履歴

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