QueryDashboardNl2sql - 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 Dashboard's Question Resource Information

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

There is currently no authorization information disclosed in the API.

Request parameters

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

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	Request ID.	46e537a5**,3dadsu**
Result	array<object>	Result of the API execution. Possible values: true: Request succeeded false: Request failed
Data	object	Returns the result of the API execution.
DashboardName	string	Dashboard name	612b
DashboardNl2sqlId	string	Dashboard question resource ID	sasdas****sawdau
OwnerId	string	UserID of the dashboard creator	46e5374665ba4b679ee22e2a2927****
Authorities	array	If this parameter has a value and includes "READ", it indicates that the user has read permission for the dashboard question resource.
Authorities	string	If this parameter has a value and includes "READ", it indicates that 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

Sample success responses

JSONformat

{
  "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.

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