調用DescribeColumns API查詢資料資產表的列資料-資料資訊安全中心-阿里雲

調用DescribeColumns介面查詢資料資訊安全中心串連授權的MaxCompute、RDS等資料資產表中列的資料。

介面說明

本介面一般用于敏感資料資產資訊表中列資料的查看，便於使用者準確的對敏感性資料進行分析。

注意事項

DescribeColumns 介面已修訂為 DescribeColumnsV2。建議您在開發應用程式時使用較新的版本 DescribeColumnsV2。

QPS 限制

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

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

yundun-sddp:DescribeColumns

get

*全部資源

*

acs:ResourceGroupId

無

請求參數

名稱	類型	必填	描述	樣本值
Lang	string	否	請求和接收訊息的語言類型，預設為zh_cn。取值： zh_cn：中文。 en_us：英文。	zh_cn
Name	string	否	搜尋的關鍵詞，支援模糊比對。例如，輸入 test，會搜尋出搜尋項中包含 test 的全部資料資訊。	test
TableId	integer	否	MaxCompute、RDS 等資產表中的列所屬的資產表唯一標識 ID。說明根據資產表的 ID 查詢資料資訊安全中心串連授權的資料資產表中列的資料，資產表 ID 可調用 DescribeTables 介面擷取。	11132334
RuleId	integer	否	資產表中列資料命中的敏感性資料識別規則的唯一標識 ID。說明根據資產表中列資料命中的敏感性資料識別規則的 ID，查詢資料資訊安全中心串連授權的資料資產表中列的資料，敏感性資料識別規則 ID 可調用 DescribeRules 介面擷取。	11111
ProductCode	string	否	資料資產表中列資料所屬產品名稱。取值：MaxCompute、OSS、ADS、OTS、RDS等。	MaxCompute
InstanceId	integer	否	資料資產表中列資料所屬的資產執行個體 ID。說明根據資料資產表中列資料所屬的資產執行個體的 ID，查詢資料資訊安全中心串連授權的資料資產表中列的資料，資產執行個體 ID 可調用 DescribeInstances 介面擷取。	1
InstanceName	string	否	資料資產表中列資料所屬的資產執行個體名稱。	rm-bp17t1htja573l5i8****
TableName	string	否	資料資產表的名稱。	it_table
RuleName	string	否	資料資產表中列資料命中的敏感性資料識別規則名稱。	name
SensLevelName	string	否	敏感等級名。取值： N/A：未識別到敏感性資料。 S1：1 級敏感性資料。 S2：2 級敏感性資料。 S3：3 級敏感性資料。 S4：4 級敏感性資料。	S2
PageSize	integer	否	列表每頁顯示的資料最大條數。	10
CurrentPage	integer	否	分頁查詢時的頁碼。	1
RiskLevelId	integer	否	敏感性資料識別規則的風險等級 ID。取值： 1：N/A。 2：S1。 3：S2。 4：S3。 5：S4。	2
TemplateRuleId	string	否	命中的模板規則 ID。說明您可以通過調用 DescribeCategoryTemplateRuleList 擷取命中的模板規則 ID。	1542
EngineType	string	否	引擎類型，取值： MySQL 。 MariaDB 。 Oracle 。 PostgreSQL 。 SQLServer 。	MySQL
ProductId	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	5
ModelTagId	string	否	資料標籤。 101：個人敏感資訊 102：個人資訊	101
TemplateId	string	否	行業模板 ID。說明您可以通過調用 DescribeCategoryTemplateList 擷取行業模板標識 ID。	5
ServiceRegionId	string	否		cn-zhangjiakou

返回參數

名稱	類型	描述	樣本值
	object
CurrentPage	integer	結果中顯示的當前頁的頁碼。	1
RequestId	string	結果的請求 ID。	769FB3C1-F4C9-4******
PageSize	integer	結果中每頁顯示資料條數。	10
TotalCount	integer	結果中資料的總條數。	12
Items	array<object>	資料資產表中列的資料。
	array<object>
CreationTime	integer	資料資產表中列資料的建立時間毫秒數。	1536751124000
TableName	string	訂正目標列所屬的表名。	it_table
DataType	string	資料資產表中列資料的資料類型。	String
OdpsRiskLevelValue	integer	資產的風險等級編碼。取值： 1：N/A。 2：S1。 3：S2。 4：S3。 5：S4。	3
InstanceId	integer	資料資產表中列資料所屬的資產執行個體 ID。	1
RiskLevelId	integer	資料資產表中列資料的風險等級 ID。取值： 1：N/A。 2：S1。 3：S2。 4：S3。 5：S4。	2
RuleName	string	資料資產表中列資料命中的敏感性資料識別規則名稱。	name
RuleId	integer	資料資產表中列資料命中的敏感性資料識別規則 ID。	1
Sensitive	boolean	資料資產表中列資料是否包含敏感性資料。取值： true：資料資產表中列資料包含敏感性資料。 false：資料資產表中列資料不包含敏感性資料。	false
SensLevelName	string	敏感等級名。取值： N/A：未識別到敏感性資料。 S1：1 級敏感性資料。 S2：2 級敏感性資料。 S3：3 級敏感性資料。 S4：4 級敏感性資料。	S2
InstanceName	string	資料資產表中列資料所屬的資產執行個體名稱。	rm-bp17t1htja573l5i8****
RiskLevelName	string	資料資產表中列資料的風險等級名稱。取值： N/A：未識別到敏感性資料。 S1：1 級敏感性資料。 S2：2 級敏感性資料。 S3：3 級敏感性資料。 S4：4 級敏感性資料。	S2
OdpsRiskLevelName	string	資產的風險等級名稱。取值： N/A：未識別到敏感性資料。 S1：1 級敏感性資料。 S2：2 級敏感性資料。 S3：3 級敏感性資料。 S4：4 級敏感性資料。	S3
Name	string	資料資產表中列的名稱。	gxdata
TableId	integer	資料資產表中列資料所屬的資產表 ID。	123
Id	string	資料資產表中列的唯一標識 ID。	268
ProductCode	string	資料資產表中列資料所屬產品名稱。取值：MaxCompute、OSS、ADS、OTS、RDS等。	MaxCompute
RevisionStatus	integer	訂正狀態。取值： 1：已訂正。 0：未訂正。	1
RevisionId	integer	訂正記錄 ID。	12
ModelTags	array<object>	命中識別模型的資料標籤列表。
	object	命中識別模型的資料標籤對象。
Id	integer	識別模型的資料標籤 ID。 101：個人敏感資訊。 102：個人資訊。 103：重要資料。	101
Name	string	識別模型的資料標籤名稱。個人敏感資訊。個人資訊。重要資料。	personal sensitive data
RegionId	string	資產所在的地區。	cn-***
EngineType	string	資料庫引擎類型。	MySQL
MaskingStatus	integer	列加密狀態。取值： -1：未加密 1：加密成功 2：加密失敗	-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

樣本

正常返回樣本

JSON格式

{
  "CurrentPage": 1,
  "RequestId": "769FB3C1-F4C9-4******",
  "PageSize": 10,
  "TotalCount": 12,
  "Items": [
    {
      "CreationTime": 1536751124000,
      "TableName": "it_table",
      "DataType": "String",
      "OdpsRiskLevelValue": 3,
      "InstanceId": 1,
      "RiskLevelId": 2,
      "RuleName": "name",
      "RuleId": 1,
      "Sensitive": false,
      "SensLevelName": "S2",
      "InstanceName": "rm-bp17t1htja573l5i8****",
      "RiskLevelName": "S2",
      "OdpsRiskLevelName": "S3",
      "Name": "gxdata",
      "TableId": 123,
      "Id": "268",
      "ProductCode": "MaxCompute",
      "RevisionStatus": 1,
      "RevisionId": 12,
      "ModelTags": [
        {
          "Id": 101,
          "Name": "personal sensitive data"
        }
      ],
      "RegionId": "cn-***",
      "EngineType": "MySQL",
      "MaskingStatus": -1,
      "ProductId": 5
    }
  ]
}

錯誤碼

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

變更歷史

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