全部產品
Search

搜尋本產品

    Quick BI：QueryShareList - 查詢作品的分享記錄

    文件中心

    Quick BI：QueryShareList - 查詢作品的分享記錄

    更新時間：Dec 24, 2025

    查詢作品被分享給哪些對象的列表，只返回仍然在有效期間限內的分享配置。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    quickbi-public:QueryShareList

    list

    *全部資源

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    ReportId

    string

    是

    作品 ID。這裡的作品包括資料門戶、儀表板、試算表、自助取數、即席分析、資料填報、資料大屏。

    6b407e50-e774-406b-9956-da2425c2****

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    Success

    boolean

    是否請求成功。取值範圍：

    • true：請求成功

    • false：請求失敗

    true
    RequestId

    string

    請求 ID。

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

    array<object>

    返回作品被分享給的對象列表。

    object

    AuthPoint

    integer

    分享許可權。取值範圍：

    • 1：僅查看

    • 3：查看和匯出

    3
    ExpireDate

    integer

    授權有效時間的毫秒級時間戳記。

    1640102400000
    ReportId

    string

    作品 ID。

    6b407e50-e774-406b-9956-da2425c2****
    ShareId

    string

    分享配置 ID。

    0ab9659e-29cf-47d7-a364-3a91553b****
    ShareToId

    string

    分享目標的 ID，可能是在 Quick BI 的使用者識別碼，可能是使用者組 ID。

    • 當 ShareToType=2（所有組織內的成員）的時候，ShareToId 為組織 ID。

    95296e95-ca89-4c7d-8af9-dedf0ad0****
    ShareToName

    string

    分享對象的名稱。

    小張
    ShareToType

    integer

    分享類型。取值範圍：

    • 0：使用者

    • 1：使用者組

    • 2：組織

    • 3：空間

    0
    ShareType

    string

    被分享作品的類型。取值範圍：

    • dataProduct：資料門戶

    • dashboard：儀表板

    • report：試算表

    • dashboardOfflineQuery：自助取數

    • ANALYSIS：即席分析

    • DATAFORM：資料填報

    • SCREEN：資料大屏

    dashboard

    樣本

    正常返回樣本

    JSON格式

    {
  "Success": true,
  "RequestId": "DC4E1E63-B337-44F8-8C22-6F00DF67E2C3",
  "Result": [
    {
      "AuthPoint": 3,
      "ExpireDate": 1640102400000,
      "ReportId": "6b407e50-e774-406b-9956-da2425c2****",
      "ShareId": "0ab9659e-29cf-47d7-a364-3a91553b****",
      "ShareToId": "95296e95-ca89-4c7d-8af9-dedf0ad0****",
      "ShareToName": "小張",
      "ShareToType": 0,
      "ShareType": "dashboard"
    }
  ]
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 Report.NotExist.Error This work does not exist. It may have been deleted. Work ID is %s. 作品不存在，可能已經被刪除。作品ID:%s。
    400 Workspace.Not.Exist The group workspace does not exist. 群空間不存在。
    400 Workspace.NotIn.Organization The workspace is not owned by the organization. 空間不在組織內。

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

    變更歷史

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