All Products
Search
Document Center

Quick BI:CancelCollection

Last Updated:Nov 04, 2025

Cancel the data works from the user's collection.

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
quickbi-public:CancelCollectiondelete
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
WorksIdstringYes

The ID of the work to cancel the collection.

5d6ae4e7-cede-43cd-b4d3-d2fd442a9202
UserIdstringYes

The ID of the favorite user. The user ID is the UserID of the Quick BI, not the UID of Alibaba Cloud.

121344444790****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

7c7223ae-****-3c744528014b
Resultboolean

The execution result of the interface is returned. Valid values:

  • true: The request was successful.
  • false: The request fails.
true
Successboolean

Indicates whether the request is successful. Valid values:

  • true: The request was successful.
  • false: The request failed.
true

Examples

Sample success responses

JSONformat

{
  "RequestId": "7c7223ae-****-3c744528014b",
  "Result": true,
  "Success": true
}

Error codes

HTTP status codeError codeError messageDescription
400Workspace.NotIn.OrganizationThe workspace is not owned by the organization.The workspace is not owned by the organization.
400Favorite.NotCancel.PermissionYou have not added this work to favorites.You have not added this work to favorites.
400Internal.System.ErrorAn internal system error occurred.An internal system error occurred.
400Report.NotExist.ErrorThis 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.
400Instance.ExpiredYour instance has expired.Your instance has expired.
400Instance.Not.ExistThe specified instance does not exist.The specified instance does not exist.
400Invalid.OrganizationThe specified organizational unit does not exist.The specified organizational unit does not exist.
400User.Not.In.OrganizationThe specified user is not in the organizational unit.The specified user is not in the organizational unit.
400Invalid.ParameterAn error occurred while verifying parameters.An error occurred while verifying parameters.
400Invalid.Parameter.ErrorThe parameter is invalid:%s.invalid parameter: ${0}.
400Invalid.Param.ErrorThe parameter is invalid.The parameter is invalid.
400Invalid.User.AdminYou are not an administrator of this organization.Only organization administrators can perform this operation.
400System.Param.EmptyYou must specify the %s parameter.You must specify the %s parameter.
400Access.ForbiddenYour instance version or access key is not allowed to call the API operation, only professional version supports calling.Your instance version or access key is not allowed to call the API operation, only professional version supports calling.
400UserInfo.ErrorThe personal information is invalid.The personal information is invalid.
400ApiUser.Not.ExistsThe specified user does not exist.The specified user does not exist.

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