QueryShareList - Quick BI - Alibaba Cloud Documentation Center

This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Query the list of objects to which a work has been shared, returning only the sharing configurations that are still within their validity period.

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:QueryShareList	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
ReportId	string	Yes	The ID of the work. The works include data portal, dashboard, spreadsheet, self-service data retrieval, ad-hoc analysis, data entry, and data screen.	6b407e50-e774-406b-9956-da2425c2****

Response parameters

Parameter	Type	Description	Example
	object
Success	boolean	Indicates whether the request was successful. Possible values: true: The request was successful. false: The request failed.	true
RequestId	string	The request ID.	DC4E1E63-B337-44F8-8C22-6F00DF67E2C3
Result	array<object>	Returns the list of objects to which the work has been shared.
Data	object
AuthPoint	integer	Sharing permissions. Possible values: 1: View only 3: View and export	3
ExpireDate	long	The timestamp in milliseconds indicating the expiration time of the authorization.	1640102400000
ReportId	string	The ID of the work.	6b407e50-e774-406b-9956-da2425c2****
ShareId	string	The ID of the sharing configuration.	0ab9659e-29cf-47d7-a364-3a91553b****
ShareToId	string	The ID of the sharing target, which could be a user ID or a group ID in Quick BI. When ShareToType=2 (all members within an organization), ShareToId is the organization ID.	95296e95-ca89-4c7d-8af9-dedf0ad0****
ShareToName	string	The name of the sharing target.	test
ShareToType	integer	The type of sharing. Possible values: 0: User 1: Group 2: Organization 3: Space	0
ShareType	string	The type of the shared work. The value range includes: dataProduct: Data Portal dashboard: Dashboard report: Spreadsheet dashboardOfflineQuery: Self-service Data Extraction ANALYSIS: Ad-hoc Analysis DATAFORM: Data Entry SCREEN: Data Visualization Screen	dashboard

Examples

Sample success responses

JSONformat

{
  "Success": true,
  "RequestId": "DC4E1E63-B337-44F8-8C22-6F00DF67E2C3",
  "Result": [
    {
      "AuthPoint": 3,
      "ExpireDate": 1640102400000,
      "ReportId": "6b407e50-e774-406b-9956-da2425c2****",
      "ShareId": "0ab9659e-29cf-47d7-a364-3a91553b****",
      "ShareToId": "95296e95-ca89-4c7d-8af9-dedf0ad0****",
      "ShareToName": "test",
      "ShareToType": 0,
      "ShareType": "dashboard"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
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	Workspace.Not.Exist	The group workspace does not exist.	The group workspace does not exist.
400	Workspace.NotIn.Organization	The workspace is not owned by the organization.	The workspace is not owned by the organization.

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