ListFavoriteReports 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:ListFavoriteReports

list

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
UserId	string	必須	クエリ対象の Quick BI ユーザーの UserID。	b5d8fd9348cc4327****afb604
Keyword	string	任意	作品名のキーワード。	财务报表
TreeType	string	任意	クエリ対象の作品のタイプ (すべてのタイプをクエリする場合は空白のままにします)。有効値： DATAPRODUCT：データポータル PAGE：ダッシュボード REPORT：電子帳票	PAGE
PageSize	integer	任意	クエリする作品リストの行数。デフォルト値：10 最大値：9999	10

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエスト ID。	D787E1A3-A93C-424A-B626-C2B05DF8D885
Result	object	クエリ結果を返します。
Data	array<object>	クエリされた作品のリスト。
	object
Favorite	boolean	ユーザーが作品をお気に入りに追加したかどうかを示します。	true
FavoriteDate	string	作品がお気に入りに追加されたときのタイムスタンプ。	1640088615000
GmtCreate	string	作品が作成されたときのタイムスタンプ。	1640088615000
GmtModified	string	作品が変更されたときのタイムスタンプ。	1640595729000
HasEditAuth	boolean	ユーザーが作品の編集権限を持っているかどうかを示します。	true
HasViewAuth	boolean	ユーザーが作品の表示権限を持っているかどうかを示します。	true
Name	string	作品名。	测试报表
OwnerName	string	作品のオーナーの Alibaba Cloud アカウント名。	luyaotest的昵称非管理员
OwnerNum	string	作品のオーナーの UserID。	1365*****238860
PublishStatus	integer	作品の公開ステータス。有効値： 0：未公開 1：公開済み 2：変更あり、未公開 3：オフライン	1
TreeId	string	作品 ID。	977c7698-**--**-44b7304d20fc
Type	string	作品のタイプ。有効値： DATAPRODUCT：データポータル PAGE：ダッシュボード REPORT：電子帳票	PAGE
WorkspaceId	string	作品が属するワークスペースの ID。	523793cb-**--**-aa71c65ffa39
WorkspaceName	string	作品が属するワークスペースの名前。	测试工作空间
PageNum	integer	ページ番号。	1
PageSize	integer	インターフェイスをリクエストする際に設定された、1ページあたりの行数。	10
TotalNum	integer	合計行数。	1
TotalPages	integer	合計ページ数。	1
Success	boolean	リクエストが成功したかどうかを示します。有効値： true：リクエストは成功しました。 false：リクエストは失敗しました。	true

例

成功レスポンス

JSONJSON

{
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": {
    "Data": [
      {
        "Favorite": true,
        "FavoriteDate": "1640088615000",
        "GmtCreate": "1640088615000",
        "GmtModified": "1640595729000",
        "HasEditAuth": true,
        "HasViewAuth": true,
        "Name": "测试报表",
        "OwnerName": "luyaotest的昵称非管理员",
        "OwnerNum": "1365*****238860",
        "PublishStatus": 1,
        "TreeId": "977c7698-****-****-****-44b7304d20fc",
        "Type": "PAGE",
        "WorkspaceId": "523793cb-****-****-****-aa71c65ffa39",
        "WorkspaceName": "测试工作空间"
      }
    ],
    "PageNum": 1,
    "PageSize": 10,
    "TotalNum": 1,
    "TotalPages": 1
  },
  "Success": true
}

エラーコード

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

変更履歴

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