使用DescribeDataObjects查詢資料對象的資料識別結果-資料資訊安全中心-阿里雲 - Data Security Center

呼叫本介面查詢資料表、檔案的資料識別結果。

介面說明

本介面用於查詢資料表、檔案的識別結果，便於從全域視角查詢資產的資料識別結果。

QPS 限制

本介面的單使用者 QPS 限制為 10 次/秒。超過限制，API 呼叫將會被限流，這可能影響您的業務，請合理呼叫。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

yundun-sddp:DescribeDataObjects

get

*全部資源。

*

acs:ResourceGroupId

無

請求參數

名稱	類型	必填	描述	樣本值
Lang	string	否	請求和接收訊息的語言類型，預設為 zh_cn。取值： zh_cn：中文。 en_us：英文。	zh_cn
PageSize	integer	否	分頁查詢時，設定清單中每頁顯示的資料資產執行個體的最大筆數。預設值：10。	10
CurrentPage	integer	否	分頁查詢時的頁碼。預設值：1。	1
ProductIds	string	否	建議填寫，待查詢的產品 ID 清單，多個用逗號分隔。取值： 1：MaxCompute 2：OSS 3：ADB-MYSQL 4：TableStore 5：RDS 6：SELF_DB 7：PolarDB-X 8：PolarDB 9：ADB-PG 10：OceanBase 11：MongoDB 25：Redis 說明 OSS 與其他產品互斥，即如果待查詢中有 OSS，則不能有其他產品清單；預設查詢的為非 OSS 產品。	1,5
ParentCategoryIds	string	否	待查詢範本的父分類清單，多個父分類 ID 用逗號分隔。	234,236,238
QueryName	string	否	待查詢的資料物件關鍵字。	t_sddp_selfmysql_pers0
ServiceRegionId	string	否	資產所在的地域。取值： cn-beijing：華北 2（北京）。 cn-zhangjiakou：華北 3（張家口）。 cn-huhehaote：華北 5（呼和浩特）。 cn-hangzhou：華東 1（杭州）。 cn-shanghai：華東 2（上海）。 cn-shenzhen：華南 1（深圳）。 cn-hongkong：中國香港。	cn-hangzhou
TemplateId	integer	是	行業範本 ID。說明您可以透過呼叫 DescribeCategoryTemplateList 取得行業範本標識 ID。	1
DomainId	integer	否	資料資產所屬的資料域 ID。	2
ModelTagIds	string	否	待查詢的資料標籤，多個用逗號分隔。取值： 101：個人敏感資訊。 102：個人資訊。 107：通用資訊。	101,102
RiskLevels	string	否	指定要查詢的資料資產的風險等級，存在多個時使用英文逗號（,）隔開。 2：S1，弱風險等級。 3：S2，中等風險等級。 4：S3，高風險等級。 5：S4，最高風險等級。	2
InstanceId	string	否	資產執行個體 ID 關鍵字。	8vb54hn2g9j191ddz
ModelIds	string	否	行業範本的模型 ID，多個 ID 透過逗號分隔。說明您可以透過呼叫 DescribeTemplateAllRules 取得行業範本模型標識 ID。	101
FileType	integer	否	支援識別的 OSS 檔案類型。說明您可以透過呼叫 DescribeDocTypes 取得支援識別的 OSS 檔案類型，取回傳值中的 Code 欄位值，本參數僅對 OSS 類型的資產查詢有效。	100001
FileCategoryCode	integer	否	檔案分類編碼。	1
MemberAccount	integer	否	成員帳號 ID。	**********8103
FeatureType	integer	否	此參數已廢棄。	2
APIVersion	integer	否	使用這個來進行灰度判斷。	1
RegionId	string	否	資料目錄展示頁的區域。	cn-zhangjiakou
ProductId	integer	否	資料目錄的產品。	5
RuleIds	string	否	規則篩選。	1,2,3
RiskLevelIdList	string	否	分級篩選。	1,2,3
TableName	string	否	任務名稱篩選。	TableName
DbName	string	否	資料庫名稱篩選。	dataBaseName
TaskId	integer	否	任務 ID 篩選。	1
Bucket	string	否	OSS 的 Bucket 篩選。	bucketName
Project	string	否	SLS 的 Project 篩選。	project
LogStore	string	否	SLS 的 Logstore 篩選。	logstore
LogStoreFlag	integer	否	資料目錄的 SLS 頁面有兩層，需要用這個進行判斷，是查找的 Logstore 維度資料。	1
Path	string	否	檔案路徑篩選。	road
EngineType	string	否
Cursor	string	否	資料目錄關聯過濾的分面維度，取值白名單：rule（分類）/ task（任務）/ instance（執行個體）/ db（庫）。不傳或為空走原清單 + count 查詢（行為不變）；傳合法值時跳過清單查詢，只回傳 content.hitValues；傳非法值回報參數錯誤。	instance
CursorDirection	string	否	是否篩選訂正項。	0
		否
		否

返回參數

名稱	類型	描述	樣本值
	object
CurrentPage	integer	分頁查詢時，設定目前頁面的頁碼。預設值：1。	1
RequestId	string	本次呼叫請求的 ID，是由阿里雲端為該請求產生的唯一識別碼，可用於排查和定位問題。	E6F6460E-4330-549A-BD89-C183FB17571E
PageSize	integer	分頁查詢時，設定清單中每頁顯示的資料資產執行個體的最大筆數。預設值：10。	10
TotalCount	integer	查詢結果總筆數。	21
Items	array<object>	資料物件清單。
	array<object>	資料物件清單。
Name	string	資料物件的名稱。	t_sddp_selfmysql_pers0
Id	string	資料物件的唯一識別 ID。	20000
TemplateId	integer	產業範本 ID。	1
ProductId	integer	資料物件所屬的產品名稱對應的 ID。取值： 1：MaxCompute 2：OSS 3：ADB-MYSQL 4：TableStore 5：RDS 6：SELF_DB 7：PolarDB-X 8：PolarDB 9：ADB-PG 10：OceanBase 11：MongoDB 25：Redis	5
InstanceDescription	string	資料物件的執行個體描述。	instance description
ProductCode	string	資料物件所屬的產品名稱。取值： MaxCompute OSS ADB-MYSQL TableStore RDS SELF_DB PolarDB-X PolarDB ADB-PG OceanBase MongoDB Redis	RDS
SensitiveCount	integer	敏感資料數量。	1
ObjectType	string	資料物件類型。	text type
Path	string	資料物件的路徑。	rm-12.db_*
RegionName	string	地域名稱。	cn-hangzhou
Categories	array	敏感資料所屬的產業分類清單。
	string	敏感資料所屬的產業分類清單，多個分類透過逗號分隔。	general sensitive information
ModelTags	array<object>	資料標籤清單。
	object	資料標籤清單。
Id	integer	資料標籤 ID。取值： 101：個人敏感資訊。 102：個人資訊。 107：通用資訊。	101
Name	string	資料標籤名稱。取值：個人敏感資訊。個人資訊。通用資訊。	Personal sensitive information
RuleList	array<object>	命中的識別模型清單。
	object	命中的識別模型清單。
RuleId	integer	識別模型 ID。	1080
RuleName	string	識別模型名稱。	name
RiskLevelId	integer	敏感資料識別規則的風險等級 ID。取值： 1：N/A：未識別到敏感資料。 2：S1：1 級敏感資料。 3：S2：2 級敏感資料。 4：S3：3 級敏感資料。 5：S4：4 級敏感資料。	2
RiskLevelName	string	資料資產表的風險等級名稱。取值： N/A：未識別到敏感資料。 S1：1 級敏感資料。 S2：2 級敏感資料。 S3：3 級敏感資料。 S4：4 級敏感資料。	S1
RuleCount	integer	命中識別模型數量。	590
RuleCategoryNameList	string	從範本的最高到底部進行規則資訊的描述。	Personal sensitive information-ID card
SampleList	string	範例資料。	["Lucy"，"Tom"]
ObjectFileCategory	string	檔案分類名稱。	text file
MemberAccount	integer	成員帳號 ID。	**********8103
LastModifiedTime	integer	檔案最新更新時間，單位為毫秒。	1687676649830
InstanceId	string	資料資產執行個體 ID。	rm-12*****
LastScanTime	integer	最新掃描的時間戳記，單位為毫秒。	1687676649830
RegionId	string	資料物件所屬的區域 ID。	cn-hangzhou
Comment	string	欄位備註。	comment
DataType	string	資料庫欄位類型。	varchar
EngineType	string	引擎類型。	TABLE
DbName	string	資料庫名稱。	DataBaseName
TableName	string	資料表名稱。	tableName
RiskLevelId	integer	敏感等級。	1
TaskId	integer	任務 ID。	1
TaskNumber	integer	使用者任務編號。	1000
TaskName	string	任務名稱。	test-task
IsRevision	integer	訂正狀態。	-1
MaskStatus	integer	欄位加密狀態。	-1
FileCategoryCode	integer	檔案類型。	1
Size	integer	檔案大小。	1000
RuleCount	integer	命中的規則數。	10
Sx	string	命中敏感等級規則的數量組成的陣列，格式如下「S1,S2,S3,S4,S5,S6,S7,S8,S9,S10」，其中 S1 代表命中敏感等級為 S1 的規則數量。	1,2,3,0,0,0,0,5,0,0
TemplateName	string	範本名稱。	test
Project	string	SLS 的 Project。	project
LogStore	string	SLS 的 LogStore。	logStore
ClusterType	string
HitValues	array	關聯篩選，用於傳回篩選的值。	["linxiu","sddptest"]
	string	根節點命中的第一個值。	linxiu
SyncStatus	string
PreviousCursor	string
NextCursor	string
HasPrevious	boolean
HasNext	boolean
ErrorCode	string
ErrorMessage	string

樣本

正常返回樣本

JSON格式

{
  "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",
      "EngineType": "TABLE",
      "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": ""
    }
  ],
  "HitValues": [
    "linxiu"
  ],
  "SyncStatus": "",
  "PreviousCursor": "",
  "NextCursor": "",
  "HasPrevious": false,
  "HasNext": false,
  "ErrorCode": "",
  "ErrorMessage": ""
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。