QueryDatasetDetailInfo用于获取指定数据集的详情,包括所属数据源、目录、以及数据集模型(包含维度、度量、物理字段、自定义SQL文本、关联关系等信息)。

请求参数

名称 类型 是否必选 示例值 描述
Action String QueryDatasetDetailInfo

要执行的操作。取值:QueryDatasetDetailInfo。

DatasetId String 5820f58c-c734-4d8a-baf1-7979af4f****

数据集ID。

返回数据

名称 类型 示例值 描述
RequestId String DC4E1E63-B337-44F8-8C22-6F00DF67E2C3

请求ID。

Result String 返回json格式的数据集数据,详见右侧说明。

返回json格式的数据集数据:

{ "cube": { "dimensions": [ { "caption": "客户名称", "dataType": "string", "dimensionType": "standard_dimension", "factColumn": "customer_name", "uid": "N5820f5_customer_name" }, { "caption": "订单编号", "dataType": "string", "dimensionType": "standard_dimension", "factColumn": "order_id", "uid": "N5820f5_order_id" }, ], "measures": [ { "caption": "订单金额", "dataType": "number", "factColumn": "order_amt", "measureType": "standard_measure", "uid": "N5820f5_order_amt" } ], "table": { "customsql": false, "dsId": "261b252d-c3c3-498a-a0a7-5d1ec6cd****", "tableName": "company_sales_record_copy" } }, "datasetId": "5820f58c-c734-4d8a-baf1-7979af4f****", "datasetName": "company_sales_record_copy12", "datasource": { "dsId": "261b252d-c3c3-498a-a0a7-5d1ec6cd****", "dsName": "立三自用", "dsType": "mysql" }, "directory": { "id": "schemaad8aad00-9c55-4984-a767-b4e0ec60****", "name": "我的数据集", "pathId": "schemaad8aad00-9c55-4984-a767-b4e0ec60****", "pathName": "我的数据集" }, "ownerId": "13651626232****", "ownerName": "张三", "rowLevel": false, "workspaceId": "95296e95-ca89-4c7d-8af9-dedf0ad0****", "workspaceName": "测试工作空间" }
Success Boolean true

返回接口执行结果。取值范围:

  • true:执行成功
  • false:执行失败

示例

请求示例

http(s)://quickbi-public.aliyun.com/?Action=QueryDatasetDetailInfo
&DatasetId=5820f58c-c734-4d8a-baf1-7979af4f****
&<公共请求参数>

正常返回示例

XML格式

<RequestId>DC4E1E63-B337-44F8-8C22-6F00DF67E2C3</RequestId>
<Success>true</Success>
<Result>返回json格式的数据集数据,详见右侧说明。</Result>

JSON格式

{"RequestId":"DC4E1E63-B337-44F8-8C22-6F00DF67E2C3","Success":"true","Result":"返回json格式的数据集数据,详见右侧说明。"}

错误码

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 Cube.Not.Exist The Cube does not exist. 数据集不存在。
500 Not.WorkspaceCube.Error You can only use the %s dataset of the current workspace. 只能使用当前工作空间的数据集。
500 UserInfo.Error The personal information is invalid. 个人信息不合法。
500 DatasourceId.IsNull.Error You must select a data source before selecting the table. 必须选择数据源之后再选择表。
500 Datasource.UserPermission.Error You do not have datasource authorization. 当前用户没有数据源权限。
500 Internal.System.Error An internal system error occurred. 系统内部异常。

访问错误中心查看更多错误码。