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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
UserId	string	Yes	User ID.	3d7ebb8***********500078f4
WorkspaceId	string	Yes	Workspace ID.	3d7ebb8***********500078f4

Response elements

Element	Type	Description	Example
	object	Response schema.
RequestId	string	Request ID.	46e537a5**,3dadsu**
Result	array<object>	Result of the API execution. Possible values: true: Request succeeded false: Request failed
	object	The API execution result.
DashboardName	string	The name of the dashboard.	612b
DashboardNl2sqlId	string	The ID of the dashboard question resource.	sasdas****sawdau
OwnerId	string	The user ID of the dashboard creator.	46e5374665ba4b679ee22e2a2927****
Authorities	array	When this parameter includes "READ", the user has read permission for the dashboard question resource.
	string	When this parameter includes "READ", the user has read permission for the dashboard question resource.	READ
Success	boolean	Indicates whether the request was successful. Possible values: true: Request succeeded false: 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.