GetWorksEmbedList API查詢已嵌入報表列表-智能商務分析 Quick BI-阿里雲

查詢已嵌入報表列表。

調試

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

調試

授權資訊

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

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

quickbi-public:GetWorksEmbedList

list

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
WsId	string	否	工作空間 ID	919818-*-***-wdasd
WorksType	string	否	報表類型 page, 儀表板 screen, 資料大屏 report, 試算表 ANALYSIS, 即席分析 dashboardOfflineQuery, 自助取數 dataForm, 資料填報枚舉值： dataForm : 資料填報 dashboardOfflineQuery : 自助取數 report : 試算表 screen : 資料大屏 ANALYSIS : 即席分析 page : 儀表板	page
Keyword	string	否	報表名稱（模糊比對）	測試資料集
PageNo	integer	否	頁數（為空白預設選 1）	1
PageSize	integer	否	每頁顯示的條數（為空白預設選 10）	100

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID	38C0F***0-4159F1-***422BDB65
Result	object	報表數組對象
Data	array<object>	報表數組
	object	報表對象
EmbedTime	string	嵌入時間	YYYY-mm-DD hh:MM:ss
WorksId	string	報表 ID	897ce25e-**--af84-d13c5610**
WorksName	string	報表名稱	測試哦
WorksType	string	報表類型	page
WorkspaceId	string	所屬空間 ID	87c6b145-**-43e1-9426-8f93be23**
PageNo	integer	頁數	1
PageSize	integer	每頁顯示的條數	10
TotalNum	integer	總條數	18
TotalPages	integer	總頁碼	2
Success	boolean	請求是否成功	true

樣本

正常返回樣本

JSON格式

{
  "RequestId": "38C0F*****0-415****9F1-*****422BDB65",
  "Result": {
    "Data": [
      {
        "EmbedTime": "YYYY-mm-DD hh:MM:ss",
        "WorksId": "897ce25e-****-****-af84-d13c5610****",
        "WorksName": "測試哦",
        "WorksType": "page",
        "WorkspaceId": "87c6b145-****-43e1-9426-8f93be23****"
      }
    ],
    "PageNo": 1,
    "PageSize": 10,
    "TotalNum": 18,
    "TotalPages": 2
  },
  "Success": true
}

錯誤碼

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

變更歷史

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