CancelReportShare - Quick BI - Alibaba Cloud Documentation Center

Delete a share authorization for a data work.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
quickbi-public:CancelReportShare	delete	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
ReportId	string	Yes	The ID of the work. The works here include BI portal, dashboards, spreadsheets, and self-service access.	6b407e50-e774-406b-9956-da2425c2****
ShareToIds	string	Yes	The ID of the person to be shared, which may be the user ID of the Quick BI or the user group ID. If ShareToType is 0 (user), ShareTo is the user ID. When ShareToType is set to 1 (user group), ShareTo is the user group ID. When ShareToType=2 (organization), ShareTo is the ID of the organization.	de4bc5f9429141cc8091cdd1c15b****
ShareToType	integer	Yes	The deletion method. Valid values: 0: Delete by user 1: Delete by user group 2: Delete by organization	0

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	DC4E1E63-B337-44F8-8C22-6F00DF67E2C3
Result	boolean	The execution result of the interface is returned. Valid values: true: The request was successful. false: The request fails.	true
Success	boolean	Indicates whether the request is successful. Valid values: true: The request was successful. false: The request failed.	true

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status code	Error code	Error message	Description
400	Instance.Expired	Your instance has expired.	Your instance has expired.
400	Instance.Not.Exist	The specified instance does 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.	The specified organizational unit does not exist.
400	User.Not.In.Organization	The specified user is not in the organizational unit.	The specified user is not in the organizational unit.
400	Invalid.Parameter.Error	The parameter is invalid:%s.	invalid parameter: ${0}.
400	Report.NotExist.Error	This work does not exist. It may have been deleted. Work ID is %s.	This work does not exist. It may have been deleted. Work ID is %s.
400	System.Param.Empty	You must specify the %s parameter.	You must specify the %s parameter.
400	Resource.NotBelongTo.CurrentOrganization	The resource does not belong to the current organization.	This Resource is not belong to current organization.
400	User.NotBelongTo.CurrentOrganization	The user %s does not belong to the current organization.	User %s is not belong to current organization.
400	Usergroup.NotBelongTo.CurrentOrganization	The usergroup %s does not belong to the current organization.	Usergroup %s is not belong to current organization.
400	Internal.System.Error	An internal system error occurred.	An internal system error occurred.
400	Invalid.Parameter	An error occurred while verifying parameters.	An error occurred while verifying parameters.
400	Invalid.Param.Error	The parameter is invalid.	The parameter is invalid.
400	Invalid.User.Admin	You are not an administrator of this organization.	Only organization administrators can perform this operation.
400	UserInfo.Error	The personal information is invalid.	The personal information is invalid.
400	ApiUser.Not.Exists	The specified user does not exist.	The specified user does not exist.

For a list of error codes, visit the Service error codes.