API DsgQueryDefaultTemplates untuk desensitisasi data sensitif - DataWorks - Alibaba Cloud - DataWorks

Mengambil Templat Tipe Data Sensitif yang tersedia dan Aturan Desensitisasi yang didukungnya. Gunakan tanggapan API ini untuk mengonfigurasi Aturan Desensitisasi Anda.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

dataworks:QueryDefaultTemplates

list

*全部资源

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
SceneId	integer	Yes	ID Skenario Desensitisasi Level-2. Panggil API DsgSceneQuerySceneListByName untuk mendapatkan ID ini.	123

Elemen respons

Element	Type	Description	Example
	object	The response data.
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
ErrorCode	string	The error code returned if the request fails.	1029030003
ErrorMessage	string	The error message returned if the request fails.	param error
HttpStatusCode	integer	The HTTP status code returned.	400
Data	array<object>	The data returned.
	array<object>	An object representing a Sensitive Data Type Template.
DataType	string	The Sensitive Data Type.	phone
DesensPlanTemplate	object	A list of supported Desensitization Methods and their parameter descriptions.
	array<object>	The Desensitization Method and its parameters.
	object	The Desensitization Method and its parameters.
Name	string	The name of the data masking method.	hash
SupportWaterMark	boolean	Indicates whether a watermark is added. Valid values: true: allow false: disallow	true
ExtParamTemplate	array	The data masking parameters and their descriptions.
	any	The supported data masking rules and related parameter configurations, which are in the JSON format. The returned results are used to describe the parameters of a data masking rule. You cannot use the results as input parameters to create or modify a data masking rule.	{ "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	The Request ID. You can use this ID to troubleshoot issues.	102400001

Contoh

Respons sukses

JSONformat

{
  "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"
}

Kode kesalahan

HTTP status code	Error code	Error message
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

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.