ListCollections - 获取用户收藏作品列表 - 智能商业分析 Quick BI

获取用户收藏的作品列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

quickbi-public:ListCollections

list

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
UserId	string	是	用户 ID。此处的用户 ID 为 Quick BI 的 UserID，而非阿里云的 UID。	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。此处的用户 ID 为 Quick BI 的 UserID，而非阿里云的 UID。	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	工作空间名称。	测试工作空间

示例

正常返回示例

JSON格式

{
  "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 status code	错误码	错误信息	描述
400	Workspace.NotIn.Organization	The workspace is not owned by the organization.

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。