全部產品
Search

搜尋本產品

    Quick BI：QueryDatasetDetailInfo - 查詢資料集詳情

    文件中心

    Quick BI：QueryDatasetDetailInfo - 查詢資料集詳情

    更新時間：Dec 04, 2025

    查詢指定資料集的詳情，包括所屬資料來源、目錄、以及資料集模型。

    介面說明

    其中包括所屬資料來源、目錄、以及資料集模型（包含維度、度量、物理欄位、自訂 SQL 文本、關聯關係等資訊）。

    調試

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

    調試

    授權資訊

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

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    quickbi-public:QueryDatasetDetailInfo

    get

    *全部資源

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    DatasetId

    string

    是

    資料集 ID。

    5820f58c-c734-4d8a-baf1-7979af4f****

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    RequestId

    string

    請求 ID。

    DC4E1E63-B337-44F8-8C22-6F00DF67E2C3
    Result

    string

    返回 JSON 格式的資料集資料： { "cube": { "dimensions": [ { "caption": "客戶名稱", "dataType": "string", "dimensionType": "standard_dimension", "factColumn": "customer_name", "uid": "N5820f5_customer_name" }, { "caption": "訂單編號", "dataType": "string", "dimensionType": "standard_dimension", "factColumn": "order_id", "uid": "N5820f5_order_id" }, ], "measures": [ { "caption": "訂單金額", "dataType": "number", "factColumn": "order_amt", "measureType": "standard_measure", "uid": "N5820f5_order_amt" } ], "table": { "customsql": false, "dsId": "261b252d-c3c3-498a-a0a7-5d1ec6cd****", "tableName": "company_sales_record_copy" } }, "datasetId": "5820f58c-c734-4d8a-baf1-7979af4f****", "datasetName": "company_sales_record_copy12", "datasource": { "dsId": "261b252d-c3c3-498a-a0a7-5d1ec6cd****", "dsName": "立三自用", "dsType": "mysql" }, "directory": { "id": "schemaad8aad00-9c55-4984-a767-b4e0ec60****", "name": "我的資料集", "pathId": "schemaad8aad00-9c55-4984-a767-b4e0ec60****", "pathName": "我的資料集" }, "ownerId": "13651626232****", "ownerName": "張三", "rowLevel": false, "workspaceId": "95296e95-ca89-4c7d-8af9-dedf0ad0****", "workspaceName": "測試工作空間" }

    返回JSON格式的資料集資料，詳見左側說明。
    Success

    boolean

    返回介面執行結果。取值範圍：

    • true：執行成功

    • false：執行失敗

    true

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "DC4E1E63-B337-44F8-8C22-6F00DF67E2C3",
  "Result": "返回JSON格式的資料集資料，詳見左側說明。",
  "Success": true
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 Cube.Not.Exist The Cube does not exist. 資料集不存在。
    400 Not.WorkspaceCube.Error You can only use the %s dataset of the current workspace. 只能使用當前工作空間的資料集。
    400 DatasourceId.IsNull.Error You must select a data source before selecting the table. 必須選擇資料來源之後再選擇表。
    400 Datasource.UserPermission.Error You do not have datasource authorization. 目前使用者沒有資料來源許可權。
    400 CubeDimension.NotExist.Error The dimension does not exist in the dataset. The dimension ID is %s. 資料集包含的維度不存在，維度path id:%s。

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

    變更歷史

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