Creates a dataset from a custom SQL statement.
Try it now
Test
RAM authorization
Request syntax
POST HTTP/1.1Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| CustomSql |
string |
Yes |
The custom SQL statement. |
select * from qqq |
| Caption |
string |
Yes |
The name of the custom dataset. |
test |
| DsId |
string |
Yes |
The ID of the data source. |
7AAB95D-*****-****-*4FC0C976 |
| WorkspaceId |
string |
Yes |
The ID of the workspace. |
95296e95-ca89-4c7d-8af9-dedf0ad0**** |
| UserId |
string |
Yes |
The ID of a Quick BI user with permissions to create datasets. This is not your Alibaba Cloud account ID. Call the QueryUserInfoByAccount operation to obtain the user ID. |
asdaf-asda*****asd |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Schema of Response |
||
| RequestId |
string |
The request ID. |
05739b************02522b9 |
| Result |
string |
The result of the API call. Valid values:
|
true |
| Success |
boolean |
Indicates whether the request was successful. Valid values:
|
true |
Examples
Success response
JSON format
{
"RequestId": "05739b************02522b9",
"Result": "true",
"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 | Invalid.User.Organization | The user is not in your organization. | The user is not in your organization. |
| 400 | User.NotIn.Workspace | The user is not in this workspace. | The user is not in this workspace. |
| 400 | Invalid.Workspace | The workspace is not owned by the organization. | |
| 400 | Datasource.NotFound.Error | The specified data source does not exist: %s. | The specified data source does not exist: %s. |
| 400 | DatasourceId.IsNull.Error | You must select a data source before selecting the table. | You must select a data source before selecting the table. |
| 400 | Name.RegularExpression.Error | Name format validation failed. | |
| 400 | NameExceeded.MaxLength.Error | The name cannot exceed %s characters in length. | The name cannot be longer than% s characters. |
| 400 | Cube.DuplicatedName.Error | The dataset name already exists. Modify the name before saving. | The dataset name already exists. Modify the name before saving. |
| 400 | Directory.NotExist.Error | The directory does not exist. | The directory does not exist. |
| 400 | Xengnie.TaskExecute.Error | Fail to execute task %s. | Fail to execute task %s. |
| 400 | Datasource.Sql.ExecuteFailed | Failed to execute the SQL statement in the data source. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.