CheckReadable接口用于查询用户对某个作品（仪表板、电子表格等）是否有权限查看。

请求参数

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

要执行的操作。取值：CheckReadable。
UserId String 是 de4bc5f9429141cc8091cdd1c15b****

待检测的Quick BI用户ID。
WorksId String 是 95296e95-ca89-4c7d-8af9-dedf0ad0****

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

返回数据

名称 类型 示例值 描述
RequestId String D787E1A3-A93C-424A-B626-C2B05DF8D885

请求ID。
Result Boolean true

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

  • true：请求成功
  • false：请求失败
Success Boolean true

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

  • true：执行成功
  • false：执行失败

示例

请求示例

http(s)://quickbi-public.aliyuncs.com/?Action=CheckReadable
&UserId=de4bc5f9429141cc8091cdd1c15b****
&WorksId=95296e95-ca89-4c7d-8af9-dedf0ad0****
&<公共请求参数>

正常返回示例

XML格式 

<RequestId>	 D787E1A3-A93C-424A-B626-C2B05DF8D885</RequestId>
<Success>true</Success>
<Result>true</Result>

JSON格式 

{"RequestId":"\t D787E1A3-A93C-424A-B626-C2B05DF8D885","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 An error occurred while verifying parameters. 参数验证失败。
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 Internal.System.Error An internal system error occurred. 系统内部异常。

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