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

list

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
UserId	string	必須	ユーザー ID。これは Alibaba Cloud UID ではなく、Quick BI の UserID を指します。	fe67f61a35a94b7da1a34ba174a7****

レスポンスフィールド

フィールド	型	説明	例
	object
Success	boolean	お気に入りレコードのプライマリキー ID です。	true
RequestId	string	リクエスト ID。	162A632E-0A88-51CF-98F8-94FDEE82DB7D
Result	array<object>	ユーザーがお気に入りに追加したワークのリストの詳細。
	object
FavoriteId	integer	お気に入りレコードのプライマリキー ID。	12373
OwnerId	string	ワークのオーナーのユーザー ID。これは Alibaba Cloud UID ではなく、Quick BI の UserID を指します。	fe67f61a35a94b7da1a34ba174a7****
WorksId	string	ワークの ID。	95296e95-ca89-4c7d-8af9-dedf0ad0****
WorksName	string	ワークの名前。	奇异博士
WorksType	string	ワークのタイプ。指定できる値は次のとおりです： DATAPRODUCT：データポータル PAGE：ダッシュボード REPORT：スプレッドシート dataForm：データ入力フォーム dashboardOfflineQuery：セルフサービスデータ抽出	dashboardOfflineQuery
WorkspaceId	string	ワークスペース ID。	9337d121-a78f-4c1b-a8bc-f81de117****
WorkspaceName	string	ワークスペース名。	测试工作空间

例

成功レスポンス

JSONJSON

{
  "Success": true,
  "RequestId": "162A632E-0A88-51CF-98F8-94FDEE82DB7D",
  "Result": [
    {
      "FavoriteId": 12373,
      "OwnerId": "fe67f61a35a94b7da1a34ba174a7****",
      "WorksId": "95296e95-ca89-4c7d-8af9-dedf0ad0****",
      "WorksName": "奇异博士",
      "WorksType": "dashboardOfflineQuery",
      "WorkspaceId": "9337d121-a78f-4c1b-a8bc-f81de117****",
      "WorkspaceName": "测试工作空间"
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	Workspace.NotIn.Organization	The workspace is not owned by the organization.

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

変更履歴

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