CancelReportShare接口用于删除作品的一个分享授权。

请求参数

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

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

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

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

ShareToIds String de4bc5f9429141cc8091cdd1c15b****

被分享者的ID,可能是Quick BI的用户ID,也可能是用户组ID。

  • ShareToType=0(用户)时,ShareTo为用户ID。
  • ShareToType=1(用户组)时,ShareTo为用户组ID。
  • ShareToType=2(组织)时,ShareTo为组织ID。
ShareToType Integer 0

删除方式。取值范围:

  • 0:按用户删除
  • 1:按用户组删除
  • 2:按组织删除

返回数据

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

请求ID。

Result Boolean true

返回接口执行结果。取值范围:

  • true:执行成功
  • false:执行失败
Success Boolean true

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

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

示例

请求示例

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

正常返回示例

XML格式

<RequestId>DC4E1E63-B337-44F8-8C22-6F00DF67E2C3</RequestId>
<Success>true</Success>
<Result>true</Result>

JSON格式

{"RequestId":"DC4E1E63-B337-44F8-8C22-6F00DF67E2C3","Success":"true","Result":"true"}

错误码

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 Invalid.Parameter.Error The parameter is invalid:%s. 无效参数%s。
500 Report.NotExist.Error This work does not exist. It may have been deleted. Work ID is %s. 作品不存在,可能已经被删除。作品ID:%s。
500 System.Param.Empty You must specify the %s parameter. 参数%s不能为空。
500 Resource.NotBelongTo.CurrentOrganization The resource does not belong to the current organization. 该资源不属于当前组织。
500 User.NotBelongTo.CurrentOrganization The user %s does not belong to the current organization. 用户%s不属于当前组织。
500 Usergroup.NotBelongTo.CurrentOrganization The usergroup %s does not belong to the current organization. 用户组%s不属于当前组织。
500 Internal.System.Error An internal system error occurred. 系统内部异常。

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