全部產品
Search
文件中心

Quick BI:QueryWorksByOrganization - 查詢組織下的所有作品

更新時間:Dec 24, 2025

查詢整個組織下的所有作品,可指定作品類型。

調試

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

調試

授權資訊

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

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

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

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

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

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

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

quickbi-public:QueryWorksByOrganization

list

*全部資源

*

請求參數

名稱

類型

必填

描述

樣本值

WorksType

string

查詢作品的類型,填空為查詢所有類型。取值範圍:

  • DATAPRODUCT:資料門戶

  • PAGE:儀表板

  • REPORT:試算表

  • dashboardOfflineQuery:自助取數

PAGE

Status

integer

查詢作品的狀態。取值範圍:

  • 0:未發布

  • 1:發行

  • 2:已修改未發布

  • 3:已下線

0

ThirdPartAuthFlag

integer

第三方嵌入狀態。取值範圍:

  • 0:暫未開通嵌入

  • 1:已開通嵌入

1

PageNum

integer

頁碼。

  • 預設值 1。

1

PageSize

integer

每頁行數。

  • 預設值 10。

10

返回參數

名稱

類型

描述

樣本值

object

Success

boolean

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

  • true:請求成功

  • false:請求失敗

true

RequestId

string

請求 ID。

D787E1A3-A93C-424A-B626-C2B05DF8D885

Result

object

返回組織下所有符合請求條件的作品列表。

Data

array<object>

作品列表詳情。

array<object>

Auth3rdFlag

integer

第三方嵌入狀態。取值範圍:

  • 0:暫未開通嵌入

  • 1:已開通嵌入

1

Description

string

作品備忘。

備忘

Directory

object

作品所屬目錄。

Id

string

所屬目錄 ID。

83d37ba6-d909-48a2-a517-f4d05c3a****

Name

string

所屬目錄名稱。

測試目錄

PathId

string

所屬目錄 ID 的層級結構,以『/』分隔。

83d37ba6-d909-48a2-a517-f4d05c3a****

PathName

string

所屬目錄名稱的層級結構,以『/』分隔。

測試目錄

GmtCreate

string

作品建立的毫秒級時間戳記。

1496651577000

GmtModify

string

作品修改的毫秒級時間戳記。

1572334870000

ModifyName

string

作品修改者的阿里雲賬戶名。

張三

OwnerId

string

作品所有者在 Quick BI 的 UserID。

作品所屬工作空間名稱。

OwnerName

string

作品所有者的阿里雲賬戶名。

李四

PublicFlag

boolean

是否公開

true

PublicInvalidTime

integer

報表公開的到期日

1721366354000

SecurityLevel

string

作品協同授權的安全性原則。取值:

  • 0:私密

  • 12:授權指定成員

  • 1 或 11:授權所有空間成員

說明
  • 若您使用舊著作權限,則傳回值為 1。

  • 若您使用新著作權限,則傳回值為 11。

1

Status

integer

報表狀態。取值範圍:

  • 0:未發布

  • 1:發行

  • 2:已修改未發布

  • 3:已下線

1

WorkName

string

作品名稱。

測試報表

WorkType

string

作品類型。取值範圍:

  • DATAPRODUCT:資料門戶

  • PAGE:儀表板

  • REPORT:試算表

  • dashboardOfflineQuery:自助取數

PAGE

WorksId

string

作品 ID。

897ce25e-****-****-af84-d13c5610****

WorkspaceId

string

作品所屬工作空間的 ID。

作品修改者的阿里雲賬戶名。

WorkspaceName

string

作品所屬工作空間名稱。

測試工作空間

PageNum

integer

頁碼。

1

PageSize

integer

請求介面時設定的每頁行數。

10

TotalNum

integer

總行數。

1

TotalPages

integer

總頁數。

1

樣本

正常返回樣本

JSON格式

{
  "Success": true,
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": {
    "Data": [
      {
        "Auth3rdFlag": 1,
        "Description": "備忘",
        "Directory": {
          "Id": "83d37ba6-d909-48a2-a517-f4d05c3a****",
          "Name": "測試目錄",
          "PathId": "83d37ba6-d909-48a2-a517-f4d05c3a****",
          "PathName": "測試目錄"
        },
        "GmtCreate": "1496651577000",
        "GmtModify": "1572334870000",
        "ModifyName": "張三",
        "OwnerId": "作品所屬工作空間名稱。",
        "OwnerName": "李四",
        "PublicFlag": true,
        "PublicInvalidTime": 1721366354000,
        "SecurityLevel": "1",
        "Status": 1,
        "WorkName": "測試報表",
        "WorkType": "PAGE",
        "WorksId": "897ce25e-****-****-af84-d13c5610****",
        "WorkspaceId": "作品修改者的阿里雲賬戶名。",
        "WorkspaceName": "測試工作空間"
      }
    ],
    "PageNum": 1,
    "PageSize": 10,
    "TotalNum": 1,
    "TotalPages": 1
  }
}

錯誤碼

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

變更歷史

更多資訊,參考變更詳情