全部产品
Search
文档中心

智能商业分析 Quick BI:QueryShareList - 查询作品的分享记录

更新时间:Aug 28, 2026

查询作品被分享给哪些对象的列表,只返回仍然在有效期限内的分享配置。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

quickbi-public:QueryShareList

list

*全部资源

*

无 无

请求参数

名称

类型

必填

描述

示例值

ReportId

string

是

作品 ID。这里的作品包括数据门户、仪表板、电子表格、自助取数、即席分析、数据填报、数据大屏。

6b407e50-e774-406b-9956-da2425c2****

返回参数

名称

类型

描述

示例值

object

Success

boolean

是否请求成功。取值范围:

  • true:请求成功

  • false:请求失败

true

RequestId

string

请求 ID。

DC4E1E63-B337-44F8-8C22-6F00DF67E2C3

Result

array<object>

返回作品被分享给的对象列表。

object

AuthPoint

integer

分享权限。取值范围:

  • 1:仅查看

  • 3:查看和导出

3

ExpireDate

integer

授权有效时间的毫秒级时间戳。

1640102400000

ReportId

string

作品 ID。

6b407e50-e774-406b-9956-da2425c2****

ShareId

string

分享配置 ID。

0ab9659e-29cf-47d7-a364-3a91553b****

ShareToId

string

分享目标的 ID,可能是在 Quick BI 的用户 ID,可能是用户组 ID。

  • 当 ShareToType=2(所有组织内的成员)的时候,ShareToId 为组织 ID。

95296e95-ca89-4c7d-8af9-dedf0ad0****

ShareToName

string

分享对象的名称。

小张

ShareToType

integer

分享类型。取值范围:

  • 0:用户

  • 1:用户组

  • 2:组织

  • 3:空间

0

ShareType

string

被分享作品的类型。取值范围:

  • dataProduct:数据门户

  • dashboard:仪表板

  • report:电子表格

  • dashboardOfflineQuery:自助取数

  • ANALYSIS:即席分析

  • DATAFORM:数据填报

  • SCREEN:数据大屏

dashboard

示例

正常返回示例

JSON格式

{
  "Success": true,
  "RequestId": "DC4E1E63-B337-44F8-8C22-6F00DF67E2C3",
  "Result": [
    {
      "AuthPoint": 3,
      "ExpireDate": 1640102400000,
      "ReportId": "6b407e50-e774-406b-9956-da2425c2****",
      "ShareId": "0ab9659e-29cf-47d7-a364-3a91553b****",
      "ShareToId": "95296e95-ca89-4c7d-8af9-dedf0ad0****",
      "ShareToName": "小张",
      "ShareToType": 0,
      "ShareType": "dashboard"
    }
  ]
}

错误码

HTTP status code

错误码

错误信息

描述

400 Report.NotExist.Error This work does not exist. It may have been deleted. Work ID is %s. 作品不存在,可能已经被删除。作品ID:%s。
400 Workspace.Not.Exist The group workspace does not exist. 群空间不存在。
400 Workspace.NotIn.Organization The workspace is not owned by the organization. 空间不在组织内。

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

变更历史

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