文档

QueryDatasetDetailInfo - 查询数据集详情

更新时间:

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

接口说明

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

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
DatasetIdstring

数据集 ID。

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

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

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

返回 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格式的数据集数据,详见左侧说明。
Successboolean

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

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

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400Cube.Not.ExistThe Cube does not exist.数据集不存在。
400Not.WorkspaceCube.ErrorYou can only use the %s dataset of the current workspace.只能使用当前工作空间的数据集。
400UserInfo.ErrorThe personal information is invalid.个人信息不合法。
400DatasourceId.IsNull.ErrorYou must select a data source before selecting the table.必须选择数据源之后再选择表。
400Datasource.UserPermission.ErrorYou do not have datasource authorization.当前用户没有数据源权限。
400Internal.System.ErrorAn internal system error occurred.系统内部异常。
400Instance.ExpiredYour instance has expired.您的购买实例已经过期。
400Instance.Not.ExistThe specified instance does not exist.暂未匹配到您的购买实例。
400Invalid.OrganizationThe specified organizational unit does not exist.该组织不存在。
400User.Not.In.OrganizationThe specified user is not in the organizational unit.该用户不在组织中。
400Invalid.ParameterAn error occurred while verifying parameters.参数验证失败。
400Invalid.Parameter.ErrorThe parameter is invalid:%s.无效参数%s。
400Invalid.Param.ErrorThe parameter is invalid.无效参数。
400Invalid.User.AdminYou are not an administrator of this organization.没有权限,您不是组织管理员。
400System.Param.EmptyYou must specify the %s parameter.参数%s不能为空。
400Access.ForbiddenYour instance version or access key is not allowed to call the API operation, only professional version supports calling.您的实例版本或者 AccessKey不允许调用该 API,仅专业版支持调用。
400ApiUser.Not.ExistsThe specified user does not exist.用户不存在。
400User.Not.WorkspaceAdminOnly administrators of the group workspace can perform this operation.没有权限,您不是该群空间的管理员。
400Application.Object.NotExistThe object you are operating does not exist or has been deleted.操作组件不存在或已被删除。
400Not.ApiCall.AuthUserYou are not an administrator or API call auth user of this organization.非组织管理员或API调用授权用户。

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