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

请求参数

名称 类型 是否必选 示例值 描述
Action String QueryShareList

要执行的操作。取值:QueryShareList。

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

作品ID。这里的作品包括数据门户,仪表板,电子表格,自助取数。

返回数据

名称 类型 示例值 描述
RequestId String DC4E1E63-B337-44F8-8C22-6F00DF67E2C3

请求ID。

Result Array of Data

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

AuthPoint Integer 1

分享权限。取值范围:

  • 1:仅查看
  • 3:查看和导出
ExpireDate Long 1640102400000

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

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

作品ID。

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

分享配置ID。

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

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

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

ShareToName String 小张

分享对象的名称。

ShareToType Integer 0

分享类型。取值范围:

  • 0:用户
  • 1:用户组
  • 2:组织
  • 3:空间
ShareType String dashboard

被分享作品的类型。

  • product:数据门户
  • dashboard:仪表板
  • worksheet:电子表格
Success Boolean true

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

  • true:请求成功
  • false:请求失败

示例

请求示例

http(s)://quickbi-public.aliyun.com/?Action=QueryShareList
&ReportId=6b407e50-e774-406b-9956-da2425c2****
&<公共请求参数>

正常返回示例

XML格式

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

JSON格式

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

错误码

HttpCode 错误码 错误信息 描述
500 Instance.Expired Your instance has expired. 您的购买实例已经过期。
500 Instance.Not.Exist The specified instance does not exist. 暂未匹配到您的购买实例。
500 Access.Forbidden Access forbidden. Your instance version or access key is not allowed to call the API operation. 访问被禁止,您的实例版本或者 AccessKey不允许调用该 API。
500 Invalid.Organization The specified organizational unit does not exist. 该组织不存在。
500 User.Not.In.Organization The specified user is not in the organizational unit. 该用户不在组织中。
500 Report.NotExist.Error This work does not exist. It may have been deleted. Work ID is %s. 作品不存在,可能已经被删除。作品ID:%s。
500 Workspace.Not.Exist The group workspace does not exist. 群空间不存在。
500 Workspace.NotIn.Organization The workspace is not owned by the organization. 空间不在组织内。
500 System.Param.Empty You must specify the %s parameter. 参数%s不能为空。
500 Invalid.Param.Error The parameter is invalid. 无效参数。
500 Internal.System.Error An internal system error occurred. 系统内部异常。

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