QueryDashboardNl2sql API Reference - Quick BI - Alibaba Cloud - Quick BI

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:QueryDashboardNl2sql

none

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
UserId	string	Yes	The user ID.	3d7ebb8***********500078f4
WorkspaceId	string	Yes	The workspace ID.	3d7ebb8***********500078f4

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	46e537a5**,3dadsu**
Result	array<object>	The execution result of the API operation. Valid values: true: The request succeeded. false: The request failed.
	object	The returned execution result of the API operation.
DashboardName	string	The name of the dashboard.	612b
DashboardNl2sqlId	string	The NL2SQL resource ID of the dashboard.	sasdas****sawdau
OwnerId	string	The user ID of the dashboard creator.	46e5374665ba4b679ee22e2a2927****
Authorities	array	The permissions on the dashboard NL2SQL resource. If this parameter has a value and contains READ, it indicates that the user has NL2SQL permissions on the dashboard NL2SQL resource.
	string	The permissions on the dashboard NL2SQL resource. If this parameter has a value and contains READ, it indicates that the user has NL2SQL permissions on the dashboard NL2SQL resource.	READ
Success	boolean	Specifies whether the request is successful. Valid values: true: The request succeeded. false: The request failed.	true

Examples

Success response

JSON format

{
  "RequestId": "46e537a5****,3dadsu****",
  "Result": [
    {
      "DashboardName": "612b",
      "DashboardNl2sqlId": "sasdas****sawdau",
      "OwnerId": "46e5374665ba4b679ee22e2a2927****",
      "Authorities": [
        "READ"
      ]
    }
  ],
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	Internal.System.Error	An internal system error occurred.	An internal system error occurred.
400	User.Not.In.Organization	The specified user is not in the organizational unit.	The specified user is not in the organizational unit.
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.
400	UserRoleConfig.NotContain.Function	The user %s does not have permission to operate.	The user %s does not have permission to operate.
400	User.NotIn.Workspace	The user is not a member of the group workspace.	The user is not a member of the group workspace.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.