QueryDatasetDetailInfo - 查询数据集详情

查询指定数据集的详情,包括所属数据源、目录、以及数据集模型。

接口说明

其中包括所属数据源、目录、以及数据集模型(包含维度、度量、物理字段、自定义 SQL 文本、关联关系等信息)。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

quickbi-public:QueryDatasetDetailInfo

get

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

DatasetId

string

数据集 ID。

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

返回参数

名称

类型

描述

示例值

object

RequestId

string

请求 ID。

DC4E1E63-B337-44F8-8C22-6F00DF67E2C3

Result

string

返回 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": "测试工作空间" }

返回JSON格式的数据集数据,详见左侧说明。

Success

boolean

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

  • true:执行成功

  • false:执行失败

true

示例

正常返回示例

JSON格式

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

错误码

HTTP status code

错误码

错误信息

描述

400 Cube.Not.Exist The Cube does not exist. 数据集不存在。
400 Not.WorkspaceCube.Error You can only use the %s dataset of the current workspace. 只能使用当前工作空间的数据集。
400 DatasourceId.IsNull.Error You must select a data source before selecting the table. 必须选择数据源之后再选择表。
400 Datasource.UserPermission.Error You do not have datasource authorization. 当前用户没有数据源权限。
400 CubeDimension.NotExist.Error The dimension does not exist in the dataset. The dimension ID is %s. 数据集包含的维度不存在,维度path id:%s。

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

变更历史

更多信息,参考变更详情