Gunakan DescribeDataObjects untuk mengkueri hasil deteksi data untuk aset data - Data Security Center - Alibaba Cloud - Data Security Center

Mengkueri hasil deteksi data untuk tabel dan file.

Deskripsi operasi

This operation queries data detection results for tables and files, to provide a comprehensive view across all your assets.

QPS limit

The per-user QPS limit for this operation is 10 requests per second. If you exceed this limit, the system throttles your API calls. To prevent business disruptions, call this operation only when necessary.

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

yundun-sddp:DescribeDataObjects

get

*全部资源

*

acs:ResourceGroupId

None

Parameter permintaan

Parameter	Type	Required	Description	Example
Lang	string	No	Bahasa konten dalam permintaan dan tanggapan. Nilai default: zh_cn. Nilai valid: zh_cn: Bahasa Mandarin. en_us: Bahasa Inggris.	zh_cn
PageSize	integer	No	Jumlah aset data yang dikembalikan pada setiap halaman. Nilai default: 10.	10
CurrentPage	integer	No	Nomor halaman yang dikembalikan. Nilai default: 1.	1
ProductIds	string	No	ID produk tempat aset data yang akan dikueri berada. Anda dapat menentukan beberapa ID produk. Pisahkan dengan koma (,). Disarankan untuk menentukan parameter ini. Nilai valid: 1: MaxCompute 2: OSS 3: ADB-MYSQL 4: TableStore 5: RDS 6: SELF_DB 7: PolarDB-X 8: PolarDB Basis Data Relasional Cloud-Native 9: ADB-PG 10: OceanBase 11: MongoDB 25: Redis Catatan Jika Anda ingin mengkueri aset data milik OSS, Anda tidak dapat mengkueri aset data produk lain. Secara default, aset data produk selain OSS yang dikueri.	1,5
ParentCategoryIds	string	No	ID kategori aset induk yang akan dikueri. Anda dapat menentukan beberapa ID. Pisahkan dengan koma (,).	234,236,238
QueryName	string	No	Kata kunci aset data yang akan dikueri.	t_sddp_selfmysql_pers0
ServiceRegionId	string	No	Wilayah tempat aset data berada. Nilai valid: cn-beijing: Tiongkok (Beijing) cn-zhangjiakou: Tiongkok (Zhangjiakou) cn-huhehaote: Tiongkok (Hohhot) cn-hangzhou: Tiongkok (Hangzhou) cn-shanghai: Tiongkok (Shanghai) cn-shenzhen: Tiongkok (Shenzhen) cn-hongkong: Tiongkok (Hong Kong).	cn-hangzhou
TemplateId	integer	Yes	ID template aturan spesifik industri. Catatan Anda dapat memanggil operasi DescribeCategoryTemplateList untuk mendapatkan ID template aturan spesifik industri.	1
DomainId	integer	No	ID domain data tempat aset data berada.	2
ModelTagIds	string	No	Label data yang akan dikueri. Anda dapat menentukan beberapa label data. Pisahkan dengan koma (,). Nilai valid dalam format berikut: 101: informasi sensitif pribadi 102: informasi pribadi 107: informasi umum.	101,102
RiskLevels	string	No	Tingkat sensitivitas aset data. Anda dapat menentukan beberapa tingkat sensitivitas. Pisahkan dengan koma (,). 2: S1, tingkat sensitivitas rendah 3: S2, tingkat sensitivitas menengah 4: S3, tingkat sensitivitas tinggi 5: S4, tingkat sensitivitas tertinggi.	2
InstanceId	string	No	Kata kunci ID instans.	8vb54hn2g9j191ddz
ModelIds	string	No	ID model template aturan spesifik industri. Anda dapat menentukan beberapa ID. Pisahkan dengan koma (,). Catatan Anda dapat memanggil operasi DescribeTemplateAllRules untuk mendapatkan ID model template aturan spesifik industri.	101
FileType	integer	No	Tipe file OSS. Catatan Parameter ini hanya valid untuk mengkueri aset data tipe OSS. Anda dapat memanggil operasi DescribeDocTypes untuk mendapatkan tipe file OSS yang didukung. Gunakan nilai parameter `Code` di tanggapan.	100001
FileCategoryCode	integer	No	Kode kategori file.	1
MemberAccount	integer	No	ID anggota.	**********8103
FeatureType	integer	No	Parameter ini sudah tidak digunakan lagi.	2
APIVersion	integer	No	Versi API.	1
RegionId	string	No	Wilayah tempat katalog aset data berada.	cn-zhangjiakou
ProductId	integer	No	ID produk.	5
RuleIds	string	No	ID aturan. Anda dapat menentukan beberapa ID aturan. Pisahkan dengan koma (,).	1,2,3
RiskLevelIdList	string	No	ID tingkat sensitivitas. Anda dapat menentukan beberapa ID tingkat sensitivitas. Pisahkan dengan koma (,).	1,2,3
TableName	string	No	Nama tabel.	TableName
DbName	string	No	Nama database.	dataBaseName
TaskId	integer	No	ID tugas.	1
Bucket	string	No	Nama bucket OSS.	bucketName
Project	string	No	Nama proyek Simple Log Service.	project
LogStore	string	No	Nama penyimpanan log.	logstore
LogStoreFlag	integer	No	Apakah akan mengkueri data pada level penyimpanan log. Katalog data Simple Log Service memiliki dua lapisan. Atur parameter ini ke 1 untuk mengkueri data pada level penyimpanan log.	1
Path	string	No	Path file.	road

Elemen respons

Element	Type	Description	Example
	object
CurrentPage	integer	The number of the page to return. Default value: 1.	1
RequestId	string	The unique ID of the request. Alibaba Cloud generates this ID to help you troubleshoot issues.	E6F6460E-4330-549A-BD89-C183FB17571E
PageSize	integer	The number of data asset instances to return on each page. Default value: 10.	10
TotalCount	integer	The total number of entries that match the query.	21
Items	array<object>	A list of data objects.
	array<object>	A data object.
Name	string	The name of the data object.	t_sddp_selfmysql_pers0
Id	string	The unique ID of the data object.	20000
TemplateId	integer	The ID of the industry template.	1
ProductId	integer	The ID of the product to which the data object belongs. Valid values: 1: MaxCompute 2: OSS 3: ADB-MYSQL 4: Table Store 5: RDS 6: SELF_DB 7: PolarDB-X 8: PolarDB 9: ADB-PG 10: OceanBase 11: MongoDB 25: Redis	5
InstanceDescription	string	The description of the data asset instance.	instance description
ProductCode	string	The name of the product to which the data object belongs. Valid values: MaxCompute OSS ADB-MYSQL Table Store RDS SELF_DB PolarDB-X PolarDB ADB-PG OceanBase MongoDB Redis	RDS
SensitiveCount	integer	The number of sensitive data fields.	1
ObjectType	string	The type of the data object.	text type
Path	string	The path of the data object.	rm-12.db_*
RegionName	string	The name of the region.	cn-hangzhou
Categories	array	An array of industry categories to which the sensitive data belongs.
	string	The industry classification of the sensitive data.	general sensitive information
ModelTags	array<object>	A list of data tags.
	object	A data tag.
Id	integer	The data tag ID. Valid values: 101: Personal sensitive information. 102: Personal information. 107: General information.	101
Name	string	The data tag name. Valid values: Personal sensitive information. Personal information. General information.	Personal sensitive information
RuleList	array<object>	A list of matched detection models.
	object	A matched detection model.
RuleId	integer	The detection model ID.	1080
RuleName	string	The detection model name.	name
RiskLevelId	integer	The risk level ID of the sensitive data detection rule. Valid values: 1: N/A: No sensitive data detected. 2: S1: Level 1 sensitive data. 3: S2: Level 2 sensitive data. 4: S3: Level 3 sensitive data. 5: S4: Level 4 sensitive data.	2
RiskLevelName	string	The risk level name of the data asset table. Valid values: N/A: No sensitive data detected. S1: Level 1 sensitive data. S2: Level 2 sensitive data. S3: Level 3 sensitive data. S4: Level 4 sensitive data.	S1
RuleCount	integer	The number of hit detection models.	590
RuleCategoryNameList	string		Personal sensitive information-ID card
SampleList	string		["Lucy"，"Tom"]
ObjectFileCategory	string	The name of the file category.	text file
MemberAccount	integer	The ID of the member account.	**********8103
LastModifiedTime	integer	The last modification time of the file, in milliseconds.	1687676649830
InstanceId	string	The ID of the data asset instance.	rm-12*****
LastScanTime	integer	The timestamp of the last scan, in milliseconds.	1687676649830
RegionId	string	The ID of the region where the data object is located.	cn-hangzhou
Comment	string	The comment on the column.	comment
DataType	string	The data type of the database column.	varchar
DbName	string	The name of the database.	DataBaseName
TableName	string	The name of the table.	tableName
RiskLevelId	integer	The risk level.	1
TaskId	integer	The ID of the task.	1
TaskNumber	integer	The task number.	1000
TaskName	string	The name of the task.	test-task
IsRevision	integer	The revision status.	-1
MaskStatus	integer	The column encryption status.	-1
FileCategoryCode	integer	The code for the file category.	1
Size	integer	The size of the file in bytes.	1000
RuleCount	integer	The number of matched rules.	10
Sx	string	A comma-separated string that specifies the count of matched rules for each risk level. The string follows the format `S1,S2...S10`, where the value at each position represents the count for the corresponding risk level.	1,2,3,0,0,0,0,5,0,0
TemplateName	string	The name of the template.	test
Project	string	The name of the Simple Log Service (SLS) project.	project
LogStore	string	The name of the Logstore in SLS.	logStore
ClusterType	string

Contoh

Respons sukses

JSONformat

{
  "CurrentPage": 1,
  "RequestId": "E6F6460E-4330-549A-BD89-C183FB17571E",
  "PageSize": 10,
  "TotalCount": 21,
  "Items": [
    {
      "Name": "t_sddp_selfmysql_pers0",
      "Id": "20000",
      "TemplateId": 1,
      "ProductId": 5,
      "InstanceDescription": "instance description",
      "ProductCode": "RDS",
      "SensitiveCount": 1,
      "ObjectType": "text type",
      "Path": "rm-12**.db_***",
      "RegionName": "cn-hangzhou",
      "Categories": [
        "general sensitive information"
      ],
      "ModelTags": [
        {
          "Id": 101,
          "Name": "Personal sensitive information"
        }
      ],
      "RuleList": [
        {
          "RuleId": 1080,
          "RuleName": "name",
          "RiskLevelId": 2,
          "RiskLevelName": "S1",
          "RuleCount": 590,
          "RuleCategoryNameList": "Personal sensitive information-ID card",
          "SampleList": "[\"Lucy\"，\"Tom\"]"
        }
      ],
      "ObjectFileCategory": "text file",
      "MemberAccount": 0,
      "LastModifiedTime": 1687676649830,
      "InstanceId": "rm-12*****",
      "LastScanTime": 1687676649830,
      "RegionId": "cn-hangzhou",
      "Comment": "comment",
      "DataType": "varchar",
      "DbName": "DataBaseName",
      "TableName": "tableName",
      "RiskLevelId": 1,
      "TaskId": 1,
      "TaskNumber": 1000,
      "TaskName": "test-task",
      "IsRevision": -1,
      "MaskStatus": -1,
      "FileCategoryCode": 1,
      "Size": 1000,
      "RuleCount": 10,
      "Sx": "1,2,3,0,0,0,0,5,0,0",
      "TemplateName": "test",
      "Project": "project",
      "LogStore": "logStore",
      "ClusterType": ""
    }
  ]
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.