使用AddShareReport添加数据作品分享配置-智能商业分析 Quick BI-阿里云

添加数据作品的一个分享配置。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
quickbi-public:AddShareReport	create	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
WorksId	string	是	分享作品的 ID。这里的作品包括数据门户，仪表板，电子表格，自助取数。	6b407e50-e774-406b-9956-da2425c2****
ShareToId	string	是	被分享者的 ID，可能是 Quick BI 的用户 ID，也可能是用户组 ID。 ShareToType=0（用户）时，ShareTo 为用户 ID。 ShareToType=1（用户组）时，ShareTo 为用户组 ID。 ShareToType=2（组织）时，ShareTo 为组织 ID。	de4bc5f9429141cc8091cdd1c15b****
ShareToType	integer	是	分享类型。取值范围： 0：用户 1：用户组 2：组织	0
ExpireDate	long	是	分享的有效期限，格式为毫秒级时间戳。	1608202110838
AuthPoint	integer	是	授权类型。取值范围： 1：仅查看 3：查看并导出	3

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	05739b8e-3de0-4204-9669-7f04f02522b9
Result	boolean	返回接口执行结果。取值范围： true：执行成功 false：执行失败	true
Success	boolean	是否请求成功。取值范围： true：请求成功 false：请求失败	true

示例

正常返回示例

JSON格式

{
  "RequestId": "05739b8e-3de0-4204-9669-7f04f02522b9",
  "Result": true,
  "Success": true
}

错误码

HTTP status code	错误码	错误信息	描述
400	Instance.Expired	Your instance has expired.	您的购买实例已经过期。
400	Instance.Not.Exist	The specified instance does not exist.	暂未匹配到您的购买实例。
400	Access.Forbidden	Access forbidden. Your instance version or access key is not allowed to call the API operation.	-
400	Invalid.Organization	The specified organizational unit does not exist.	该组织不存在。
400	User.Not.In.Organization	The specified user is not in the organizational unit.	该用户不在组织中。
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.	空间不在组织内。
400	System.Param.Empty	You must specify the %s parameter.	参数%s不能为空。
400	Workspace.Share.Forbidden	Content in the current group workspace cannot be shared.	当前群空间设置了禁止分享。
400	Invalid.User.Organization	The user is not in your organization.	该用户不在您的组织中。
400	UserInfo.Error	The personal information is invalid.	个人信息不合法。
400	Workspace.OutsideShare.Forbidden	Content in the current group workspace cannot be shared with another organization.	当前群空间设置了禁止组织外分享。
400	Usergroup.Not.Exist	The user group does not exist.	用户组不存在。
400	UserGroup.NotIn.Organization	The user group is not in the current organization.	用户组不在当前组织内。
400	Invalid.Param.Error	The parameter is invalid.	无效参数。
400	Internal.System.Error	An internal system error occurred.	系统内部异常。
400	Share.ExpireDate.Error	The expire date is illegal.	设置的过期时间不合法。

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

变更历史

变更时间	变更内容概要	操作
2023-10-24	OpenAPI 错误码发生变更	查看变更详情