GetWorksEmbedList API で埋め込みレポートをリスト - Quick BI

埋め込みレポートのリストを照会します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

quickbi-public:GetWorksEmbedList

list

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
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	任意	1 ページあたりのアイテム数 (空の場合、デフォルトで 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	1 ページあたりのアイテム数	10
TotalNum	integer	アイテムの総数	18
TotalPages	integer	総ページ数	2
Success	boolean	リクエストが成功したかどうか	true

例

成功レスポンス

JSONJSON

{
  "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
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。