全部產品
Search

搜尋本產品

    Quick BI：ListApiDatasource - 查詢API資料來源列表

    文件中心

    Quick BI：ListApiDatasource - 查詢API資料來源列表

    更新時間：Dec 24, 2025

    查詢API資料來源列表。

    介面說明

    具體的參數說明詳見建立 API 資料來源。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    quickbi-public:ListApiDatasource

    list

    *全部資源

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    WorkspaceId

    string

    是

    工作空間 ID。

    89713491-cb4f-4579-b889-e82c35f1****
    PageNum

    integer

    否

    API 資料來源列表的當前頁碼：

    • 起始值：1

    • 預設值：1

    1
    PageSize

    integer

    否

    分頁查詢時的每頁行數：

    • 預設值：10

    • 最大值：100

    10
    KeyWord

    string

    否

    API 資料來源名稱的關鍵字。

    測試

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    返回結果。

    RequestId

    string

    請求 ID。

    D787E1A3-A93C-424A-B626-C2B05DF8D885
    Result

    object

    返回查詢結果。

    Data

    array<object>

    查詢到的 API 資料來源列表。

    object

    ApiId

    string

    API 資料來源的 ID。

    0f2c3c6409be4dc0810f2a5785e816a8
    Body

    string

    JSON 格式的查詢語句參數配置，使用者可以自行定義。

    {"key1":"value1"}
    DataSize

    number

    API 資料來源的資料量。

    • 單位：KB

    0.39746094
    DateUpdateTime

    string

    API 資料來源最後同步時間。

    2022-05-25 16:19:43
    GmtCreate

    string

    建立時間。

    2022-05-25 16:19:43
    GmtModified

    string

    修改時間。

    2022-05-25 16:19:43
    JobId

    string

    任務 ID。

    REST_API_SYNC_0f2c3c6409be4dc0810f2a5785e816a8
    Parameters

    string

    JSONArray 格式的參數配置。

    • name：參數名稱

    • value：參數值

    [{"name":"token","value":"xxxxxxxxxxxx"},{"name":"pageSize","value":100}]
    ShowName

    string

    API 資料來源的名稱。

    測試資料來源
    StatusType

    integer

    API 資料來源同步任務狀態。

    枚舉值：

    • 0 :

      待運行

    • 1 :

      運行中

    • 2 :

      成功

    • 3 :

      失敗

    2
    PageNum

    integer

    請求擷取的資料頁碼數，用於翻頁。

    1
    PageSize

    integer

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

    10
    TotalNum

    integer

    總行數。

    1
    Success

    boolean

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

    • true：請求成功

    • false：請求失敗

    true

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": {
    "Data": [
      {
        "ApiId": "0f2c3c6409be4dc0810f2a5785e816a8",
        "Body": "{\"key1\":\"value1\"}",
        "DataSize": 0.39746094,
        "DateUpdateTime": "2022-05-25 16:19:43",
        "GmtCreate": "2022-05-25 16:19:43",
        "GmtModified": "2022-05-25 16:19:43",
        "JobId": "REST_API_SYNC_0f2c3c6409be4dc0810f2a5785e816a8",
        "Parameters": "[{\"name\":\"token\",\"value\":\"xxxxxxxxxxxx\"},{\"name\":\"pageSize\",\"value\":100}]",
        "ShowName": "測試資料來源",
        "StatusType": 2
      }
    ],
    "PageNum": 1,
    "PageSize": 10,
    "TotalNum": 1
  },
  "Success": true
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 Workspace.NotIn.Organization The workspace is not owned by the organization. 空間不在組織內。

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

    變更歷史

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