Query the share list of a work with QueryShareList - Quick BI - Alibaba Cloud - Quick BI

Queries the sharing records of a work and returns only sharing configurations that are still valid.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

quickbi-public:QueryShareList

list

*All Resource

*

None

Request parameters

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

Response elements

Element	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>	The list of sharing records for the specified work.
	object
AuthPoint	integer	Sharing permissions. Possible values: 1: View only 3: View and export	3
ExpireDate	integer	The expiration time of the sharing authorization, in milliseconds (Unix timestamp).	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.	小张
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. Possible values: 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

Success response

JSON format

{
  "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": "小张",
      "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.