ListDataQualityTemplates - DataWorks - Alibaba Cloud Documentation Center

Mengkueri daftar template aturan kualitas data dalam sebuah proyek.

Deskripsi operasi

DataWorks Basic Edition atau edisi yang lebih tinggi diperlukan.

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

list

*All Resource

*

None

Sintaks permintaan

POST  HTTP/1.1

Parameter permintaan

Parameter	Type	Required	Description	Example
Catalog	string	No	Jalur direktori tempat template kualitas data berada.	/timeliness/ods_layer
ProjectId	integer	No	ID proyek.	10000
Name	string	No	Pencocokan fuzzy untuk nama aturan template.	table_rows
PageNumber	integer	No	Jumlah catatan per halaman. Nilai default: 10.	1
PageSize	integer	No	Nomor halaman hasil. Nilai default: 1.	10

Elemen respons

Element	Type	Description	Example
	object	Skema Respons
RequestId	string	ID permintaan API, yang dihasilkan sebagai UUID.	0bc14115***159376359
PageInfo	object	Hasil kueri berhalaman dari template aturan kualitas data.
TotalCount	integer	Jumlah total catatan.	10
PageSize	integer	Jumlah halaman.	20
PageNumber	integer	Nomor halaman.	1
DataQualityTemplates	array<object>	Daftar template aturan.
	object	Template aturan.
ModifyTime	integer	The time when the data quality rule template was updated.	1729816478147
Owner	string	The owner of the data quality rule template.	205250754596036836
ModifyUser	string	The last updater of the data quality rule template.	205250754596036836
CreateTime	integer	The time when the data quality rule template was created.	1729816478147
ProjectId	integer	The project ID.	7635
CreateUser	string	The creator of the data quality rule template.	7892346529452
Id	string	The ID of the data quality rule template.	819cf1f8-29be-4f94-a9d0-c5c06c0c3d2a
Spec	string	Specific configurations of the data quality rule template. For more information, see Data quality Spec configuration description.	{ "assertion": "anomaly detection fro id_not_null_cnt", "id_not_null_cnt": { "query": "SELECT COUNT(*) AS cnt FROM ${tableName} WHERE dt = '$[yyyymmdd-1]';" }, "identity": "819cf1f8-29be-4f94-a9d0-c5c06c0c3d2a" }

Contoh

Respons sukses

JSONformat

{
  "RequestId": "0bc14115***159376359",
  "PageInfo": {
    "TotalCount": 10,
    "PageSize": 20,
    "PageNumber": 1,
    "DataQualityTemplates": [
      {
        "ModifyTime": 1729816478147,
        "Owner": "205250754596036836",
        "ModifyUser": "205250754596036836",
        "CreateTime": 1729816478147,
        "ProjectId": 7635,
        "CreateUser": "7892346529452",
        "Id": "819cf1f8-29be-4f94-a9d0-c5c06c0c3d2a",
        "Spec": "{\n    \"assertion\": \"anomaly detection fro id_not_null_cnt\",\n    \"id_not_null_cnt\": {\n        \"query\": \"SELECT COUNT(*) AS cnt FROM ${tableName} WHERE dt = '$[yyyymmdd-1]';\"\n    },\n    \"identity\": \"819cf1f8-29be-4f94-a9d0-c5c06c0c3d2a\"\n}"
      }
    ]
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.