使用QueryWorksBloodRelationship查詢資料作品的血緣資訊-智能商務分析 Quick BI-阿里雲

擷取資料作品的血緣關係，包括各組件引用的資料集以及查詢欄位資訊。目前僅支援的資料作品包含儀表板、試算表、自助取數。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

quickbi-public:QueryWorksBloodRelationship

get

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
WorksId	string	是	資料作品的 ID。	abcd****

返回參數

名稱	類型	描述	樣本值
	object	返回結果。
Success	boolean	是否請求成功。取值範圍： true：請求成功 false：請求失敗	true
RequestId	string	請求 ID。	D787E1A3-A93C-424A-B626-C2B05DF8D885
Result	array<object>	作品血緣資訊列表。
	array<object>	作品血緣詳情資訊。
ComponentId	string	組件 ID。	0696083a-ca72-4d89-8e7a-c017910e0***
ComponentName	string	組件名稱。	線圖
ComponentType	integer	組件類型。	3
ComponentTypeName	string	組件類型名稱。	LINE
ComponentTypeCnName	string	組件類型中文名稱。	交叉表
DatasetId	string	資料集 ID。	dc78a4ed-880d-452e-b017-90cfc10c83e5_company_sales_record
QueryParams	array<object>	查詢參數引用列的列表。
	object	欄位資訊。
AreaId	string	所屬位置 ID。	area_column
AreaName	string	所屬位置名稱。	列（度量）
Caption	string	欄位原名。	order_number
DataType	string	欄位類型。取值範圍： string：字串類型 date：僅包含年月日部分的日期類型 datetime：通用日期類型 time：僅包含時分秒部分的日期類型 number：數實值型別 boolean：布爾類型 geographic：地理位置 url：字串類型 imageUrl：圖片連結類型 multivalue：多值列	number
IsMeasure	boolean	是否是度量。取值範圍： true：是 false：否	true
PathId	string	全域唯一的 PathId。	schema7d1944eb-443e-48c6-8123-bf45a99e7e74.dc78a4ed-880d-452e-b017-90cfc10c83e5_company_sales_record.[Ndc78a4_order_level].[Ndc78a4_order_level].[Ndc78a4_order_level]
Uid	string	欄位唯一 ID。	Ndc78a4_order_number
Expression	string	計算欄位運算式。	BI_DATEADD([時間], 100, 'day')

樣本

正常返回樣本

JSON格式

{
  "Success": true,
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": [
    {
      "ComponentId": "0696083a-ca72-4d89-8e7a-c017910e0***",
      "ComponentName": "線圖",
      "ComponentType": 3,
      "ComponentTypeName": "LINE",
      "ComponentTypeCnName": "交叉表",
      "DatasetId": "dc78a4ed-880d-452e-b017-90cfc10c83e5_company_sales_record",
      "QueryParams": [
        {
          "AreaId": "area_column",
          "AreaName": "列（度量）",
          "Caption": "order_number",
          "DataType": "number",
          "IsMeasure": true,
          "PathId": "schema7d1944eb-443e-48c6-8123-bf45a99e7e74.dc78a4ed-880d-452e-b017-90cfc10c83e5_company_sales_record.[Ndc78a4_order_level].[Ndc78a4_order_level].[Ndc78a4_order_level]",
          "Uid": "Ndc78a4_order_number",
          "Expression": "BI_DATEADD([時間], 100, 'day')"
        }
      ]
    }
  ]
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊
400	Invalid.Works.Empty	This work does not exist. It may have been deleted. Work ID is %s.
400	Invalid.WorksId.Not.Publish	Works %s is not published yet.
400	Invalid.Workspace	The workspace is not owned by the organization.

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

變更歷史

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