QueryDatasetList接口用于获取指定工作空间的数据集列表,按照创建时间倒序排列。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | QueryDatasetList |
要执行的操作。取值:QueryDatasetList。 |
PageNum | Integer | 是 | 1 |
数据集列表的当前页码:
|
WithChildren | Boolean | 是 | true |
是否递归包好子目录下的数据集。取值范围:
|
WorkspaceId | String | 是 | 95296e95-ca89-4c7d-8af9-dedf0ad0**** |
工作空间ID。 |
DirectoryId | String | 否 | schemaad8aad00-9c55-4984-a767-b4e0ec60**** |
指定目录ID。
|
Keyword | String | 否 | 测试数据集 |
数据集名称搜索关键字。 |
PageSize | Integer | 否 | 10 |
分页查询时的每页行数:
|
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | D787E1A3-A93C-424A-B626-C2B05DF8D885 |
请求ID。 |
Result | Struct |
返回数据集列表的分页结果,数据集列表的详细信息存放在返回参数Data中。 |
|
Data | Array of Data |
数据集列表详情。 |
|
CreateTime | String | 2020-11-02 10:36:05 |
创建时间。 |
DataSource | Struct |
数据集所属数据源信息 |
|
DsId | String | 261b252d-c3c3-498a-a0a7-5d1ec6cd**** |
数据源ID。 |
DsName | String | 测试数据源 |
数据源类型。 |
DsType | String | mysql |
数据源名称。 |
DatasetId | String | 5820f58c-c734-4d8a-baf1-7979af4f**** |
数据集ID。 |
DatasetName | String | company_sales_record_copy12 |
数据集名称。 |
Description | String | 测试数据集 |
数据集备注。 |
Directory | Struct |
数据集所处目录信息 |
|
Id | String | schemaad8aad00-9c55-4984-a767-b4e0ec60**** | |
Name | String | 我的数据集目录 | |
PathId | String | schemaad8aad00-9c55-4984-a767-b4e0ec60**** | |
PathName | String | 我的数据集目录 | |
ModifyTime | String | 2020-11-02 10:36:05 |
修改时间。 |
OwnerId | String | 136516262323**** |
数据集拥有者在Quick BI的UserID。 |
OwnerName | String | luyaotest的昵称非管理员 |
数据集拥有者的昵称。 |
RowLevel | Boolean | false |
是否开启行级权限。取值范围: true:开启 false:关闭 |
WorkspaceId | String | 95296e95-ca89-4c7d-8af9-dedf0ad06adf |
工作空间ID。 |
WorkspaceName | String | 测试空间 |
工作空间名称。 |
PageNum | Integer | 1 |
页码。 |
PageSize | Integer | 10 |
请求接口时设置的每页行数。 |
TotalNum | Integer | 1 |
总行数。 |
TotalPages | Integer | 1 |
总页数。 |
Success | Boolean | true |
是否请求成功。取值范围:
|
示例
请求示例
http(s)://quickbi-public.aliyuncs.com/?Action=QueryDatasetList
&PageNum=1
&WithChildren=true
&WorkspaceId=95296e95-ca89-4c7d-8af9-dedf0ad0****
&<公共请求参数>
正常返回示例
XML
格式
<RequestId>D787E1A3-A93C-424A-B626-C2B05DF8D885</RequestId>
<Success>true</Success>
<Result>
<TotalNum>1</TotalNum>
<PageSize>10</PageSize>
<PageNum>1</PageNum>
<TotalPages>1</TotalPages>
<Data>
<ModifyTime>2020-11-02 10:36:05</ModifyTime>
<OwnerName>luyaotest的昵称非管理员</OwnerName>
<Description>测试数据集</Description>
<OwnerId>136516262323****</OwnerId>
<DatasetName>company_sales_record_copy12</DatasetName>
<CreateTime>2020-11-02 10:36:05</CreateTime>
<WorkspaceId>95296e95-ca89-4c7d-8af9-dedf0ad06adf</WorkspaceId>
<WorkspaceName>测试空间</WorkspaceName>
<RowLevel>false</RowLevel>
<DatasetId>5820f58c-c734-4d8a-baf1-7979af4f****</DatasetId>
</Data>
<Data>
<DataSource>
<DsName>测试数据源</DsName>
<DsId>261b252d-c3c3-498a-a0a7-5d1ec6cd****</DsId>
<DsType>mysql</DsType>
</DataSource>
<Directory>
<PathId>schemaad8aad00-9c55-4984-a767-b4e0ec60****</PathId>
<PathName>我的数据集目录</PathName>
<Id>schemaad8aad00-9c55-4984-a767-b4e0ec60****</Id>
<Name>我的数据集目录</Name>
</Directory>
</Data>
</Result>
JSON
格式
{"RequestId":"D787E1A3-A93C-424A-B626-C2B05DF8D885","Success":"true","Result":{"TotalNum":"1","PageSize":"10","PageNum":"1","TotalPages":"1","Data":[{"ModifyTime":"2020-11-02 10:36:05","OwnerName":"luyaotest的昵称非管理员","Description":"测试数据集","OwnerId":"136516262323****","DatasetName":"company_sales_record_copy12","CreateTime":"2020-11-02 10:36:05","WorkspaceId":"95296e95-ca89-4c7d-8af9-dedf0ad06adf","WorkspaceName":"测试空间","RowLevel":"false","DatasetId":"5820f58c-c734-4d8a-baf1-7979af4f****"},{"DataSource":{"DsName":"测试数据源","DsId":"261b252d-c3c3-498a-a0a7-5d1ec6cd****","DsType":"mysql"},"Directory":{"PathId":"schemaad8aad00-9c55-4984-a767-b4e0ec60****","PathName":"我的数据集目录","Id":"schemaad8aad00-9c55-4984-a767-b4e0ec60****","Name":"我的数据集目录"}}]}}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
500 | Instance.Expired | Your instance has expired. | 您的购买实例已经过期。 |
500 | Instance.Not.Exist | The specified instance does not exist. | 暂未匹配到您的购买实例。 |
500 | Access.Forbidden | Access forbidden. Your instance version or access key is not allowed to call the API operation. | 访问被禁止,您的实例版本或者 AccessKey不允许调用该 API。 |
500 | Invalid.Organization | The specified organizational unit does not exist. | 该组织不存在。 |
500 | User.Not.In.Organization | The specified user is not in the organizational unit. | 该用户不在组织中。 |
500 | Invalid.Param.Error | The parameter is invalid. | 无效参数。 |
500 | System.Param.empty | This error code has been discarded. | 错误码已废弃。 |
500 | Workspace.NotIn.Organization | The workspace is not owned by the organization. | 空间不在组织内。 |
500 | CubeSchema.Not.Exist | The cube schema does not exist. | 数据集模型不存在。 |
500 | Internal.System.Error | An internal system error occurred. | 系统内部异常。 |
访问错误中心查看更多错误码。