Queries the datasets of a specified workspace. The datasets are sorted in descending order by creation time.
Debugging
Authorization information
There is currently no authorization information disclosed in the API.
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| WorkspaceId | string | Yes | The name of the data source. | 95296e95-ca89-4c7d-8af9-dedf0ad0**** |
| DirectoryId | string | No | The ID of the request. | schemaad8aad00-9c55-4984-a767-b4e0ec60**** |
| WithChildren | boolean | Yes | The total number of pages returned. | true |
| Keyword | string | No | Information about the directory where the dataset is located | Queries the datasets of a specified workspace. The datasets are sorted in descending order by creation time. |
| PageNum | integer | Yes | The ID of the workspace. | 1 |
| PageSize | integer | No | Specifies the directory ID.
| 10 |
Response parameters
Examples
Sample success responses
JSONformat
{
"Success": true,
"RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
"Result": {
"TotalPages": 1,
"PageNum": 1,
"PageSize": 10,
"TotalNum": 1,
"Data": [
{
"RowLevel": true,
"WorkspaceId": "95296e95-ca89-4c7d-8af9-dedf0ad06adf",
"Description": "The total number of rows in the table.\n",
"CreateTime": "2020-11-02 10:36:05",
"OwnerName": "The ID of the workspace.\n",
"WorkspaceName": "Test dataset\n",
"OwnerId": "136516262323****",
"ModifyTime": "2020-11-02 10:36:05",
"DatasetName": "company_sales_record_copy12",
"DatasetId": "5820f58c-c734-4d8a-baf1-7979af4f****",
"DataSource": {
"DsType": "mysql",
"DsName": "The name of the training dataset.\n",
"DsId": "261b252d-c3c3-498a-a0a7-5d1ec6cd****"
},
"Directory": {
"PathId": "schemaad8aad00-9c55-4984-a767-b4e0ec60****",
"PathName": "Test a data source\n",
"Name": "Information about the directory where the dataset is located\n",
"Id": "schemaad8aad00-9c55-4984-a767-b4e0ec60****"
}
}
]
}
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | Instance.Expired | Your instance has expired. | Your instance has expired. |
| 400 | Instance.Not.Exist | The specified instance does not exist. | The specified instance does not exist. |
| 400 | Access.Forbidden | Access forbidden. Your instance version or access key is not allowed to call the API operation. | - |
| 400 | Invalid.Organization | The specified organizational unit does not exist. | The specified organizational unit does not exist. |
| 400 | User.Not.In.Organization | The specified user is not in the organizational unit. | The specified user is not in the organizational unit. |
| 400 | Invalid.Param.Error | The parameter is invalid. | The parameter is invalid. |
| 400 | Workspace.NotIn.Organization | The workspace is not owned by the organization. | The workspace is not owned by the organization. |
| 400 | CubeSchema.Not.Exist | The cube schema does not exist. | cube schema do not exists. |
| 400 | System.Param.Empty | You must specify the %s parameter. | You must specify the %s parameter. |
| 400 | Internal.System.Error | An internal system error occurred. | An internal system error occurred. |
| 400 | Invalid.Parameter | An error occurred while verifying parameters. | An error occurred while verifying parameters. |
| 400 | Invalid.Parameter.Error | The parameter is invalid:%s. | invalid parameter: ${0}. |
| 400 | Invalid.User.Admin | You are not an administrator of this organization. | Only organization administrators can perform this operation. |
| 400 | UserInfo.Error | The personal information is invalid. | The personal information is invalid. |
| 400 | ApiUser.Not.Exists | The specified user does not exist. | The specified user does not exist. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-05-22 | The Error code has changed. The response structure of the API has changed | View Change Details |