全部產品
Search

搜尋本產品

    Quick BI：QueryOrganizationWorkspaceList

    文件中心

    Quick BI：QueryOrganizationWorkspaceList

    更新時間：Sep 02, 2026

    取得目前組織下的工作空間清單資訊。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    quickbi-public:QueryOrganizationWorkspaceList

    list

    *全部資源。

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    Keyword

    string

    否

    空間名稱的關鍵字。

    程式
    PageNum

    integer

    否

    工作空間清單的目前頁碼：

    • 起始值：1

    • 預設值：1

    1
    PageSize

    integer

    否

    分頁查詢時的每頁列數：

    • 預設值：10

    • 最大值：1000

    10
    UserId

    string

    否

    使用者在 Quick BI 的 ID。

    fe67f61a35a94b7da1a34ba174a7****

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    Success

    boolean

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

    • true：請求成功

    • false：請求失敗

    true
    RequestId

    string

    請求 ID。

    D787E1A3-A93C-424A-B626-C2B05DF8D885
    Result

    object

    傳回工作空間清單的分頁結果，工作空間的詳細資訊清單存放在傳回參數 Data 中。

    Data

    array<object>

    工作空間清單。

    array<object>

    空間資訊。

    AllowPublishOperation

    boolean

    作品是否可公開。取值範圍：

    • true：公開

    • false：不公開

    true
    AllowShareOperation

    boolean

    作品是否可授權分享。取值範圍：

    • true：授權

    • false：不授權

    true
    CreateTime

    string

    工作空間建立時間。

    2020-11-10 17:51:07
    CreateUser

    string

    建立者的 Quick BI 使用者 ID。

    de4bc5f9429141cc8091cdd1c15b****
    CreateUserAccountName

    string

    建立者的阿里雲帳號名稱。

    pop****@aliyun.com
    ModifiedTime

    string

    工作空間最新修改時間。

    2020-11-10 17:51:07
    ModifyUser

    string

    修改者的 Quick BI 使用者 ID。

    de4bc5f9429141cc8091cdd1c15b****
    ModifyUserAccountName

    string

    修改者的阿里雲帳號名稱。

    pop****@aliyun.com
    OrganizationId

    string

    工作空間所屬的組織 ID。

    2fe4fbd8-588f-489a-b3e1-e92c7af0****
    Owner

    string

    工作空間擁有者的 Quick BI 使用者 ID。

    de4bc5f9429141cc8091cdd1c15b****
    OwnerAccountName

    string

    工作空間擁有者的阿里雲帳號名稱。

    pop****@aliyun.com
    WorkspaceDescription

    string

    工作空間備註。

    該空間是測試空間
    WorkspaceId

    string

    工作空間 ID。

    7350a155-0e94-4c6c-8620-57bbec38****
    WorkspaceName

    string

    工作空間名稱。

    測試空間
    RealOwnerAccountName

    string

    工作空間擁有者的 Quick BI 帳戶名稱。

    test
    WorkspaceExportConfig

    object

    空間匯出設定。

    ExportMainSwitch

    boolean

    匯出總開關，為 false 時下列項目皆不生效。

    true
    ImageExport

    boolean

    匯出圖片。

    true
    ExportToServer

    boolean

    匯出至伺服器。

    true
    DefaultExportType

    boolean

    預設匯出類型（含格式：true；不含格式：false）。

    true
    AllowExcelImageFile

    boolean

    此欄位表示 Excel 含格式匯出時，圖片的處理方式。僅在組織層級設定時有效。 取值說明：

    • false：表示不允許圖片欄位轉圖片；

    • true：表示允許圖片欄位轉圖片，報表匯出頁面才會顯示選項，還需要使用者手動選取才能轉圖片。

    true
    PdfExport

    boolean

    匯出 PDF。

    true
    ExportToPublicWork

    boolean

    作品公開連結是否支援匯出。

    true
    ExportToLocal

    boolean

    匯出至本機。

    true
    DataExport

    boolean

    匯出資料 Excel。

    true
    PageNum

    integer

    頁碼。

    1
    PageSize

    integer

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

    10
    TotalNum

    integer

    總列數。

    1
    TotalPages

    integer

    總頁數。

    1

    樣本

    正常返回樣本

    JSON格式

    {
  "Success": true,
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": {
    "Data": [
      {
        "AllowPublishOperation": true,
        "AllowShareOperation": true,
        "CreateTime": "2020-11-10 17:51:07",
        "CreateUser": "de4bc5f9429141cc8091cdd1c15b****",
        "CreateUserAccountName": "pop****@aliyun.com",
        "ModifiedTime": "2020-11-10 17:51:07",
        "ModifyUser": "de4bc5f9429141cc8091cdd1c15b****",
        "ModifyUserAccountName": "pop****@aliyun.com",
        "OrganizationId": "2fe4fbd8-588f-489a-b3e1-e92c7af0****",
        "Owner": "de4bc5f9429141cc8091cdd1c15b****",
        "OwnerAccountName": "pop****@aliyun.com",
        "WorkspaceDescription": "该空间是测试空间",
        "WorkspaceId": "7350a155-0e94-4c6c-8620-57bbec38****",
        "WorkspaceName": "测试空间",
        "RealOwnerAccountName": "test",
        "WorkspaceExportConfig": {
          "ExportMainSwitch": true,
          "ImageExport": true,
          "ExportToServer": true,
          "DefaultExportType": true,
          "AllowExcelImageFile": true,
          "PdfExport": true,
          "ExportToPublicWork": true,
          "ExportToLocal": true,
          "DataExport": true
        }
      }
    ],
    "PageNum": 1,
    "PageSize": 10,
    "TotalNum": 1,
    "TotalPages": 1
  }
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 Invalid.Parameter.Error The parameter is invalid:%s. 無效參數 %s。

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

    變更歷史

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