查询指定数据集的信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| quickbi-public:QueryDatasetInfo | get | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DatasetId | string | 是 | 数据集唯一 ID。 | a201c85c-****** |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "a4d1a221d-41za1-****",
"Result": {
"CubeTableList": [
{
"Caption": "odps_40",
"Customsql": false,
"DatasourceId": "dfefd7f4-fc6e-42c9-b4******",
"DsType": "maxcompute",
"FactTable": true,
"Sql": "select * from ****",
"TableName": "viewdasb8494aab2612473cb74992159fe****",
"UniqueId": "7a62530b36"
}
],
"CustimzeSql": false,
"DatasetId": "a201c85c-******",
"DatasetName": "opds_40",
"DimensionList": [
{
"Caption": "city",
"DataType": "string",
"DimensionType": "group_dimension",
"Expression": "example_expression",
"FactColumn": "city",
"FieldDescription": "hhhh",
"Granularity": "example_granularity",
"RefUid": "308f7****",
"TableUniqueId": "7a62530***",
"Uid": "a69774***",
"ExpressionV2": "example_expression"
}
],
"Directory": {
"Id": "a3eecab7-618d-4f9f-*****",
"Name": "测试目录",
"PathId": "88b680****",
"PathName": "测试目录"
},
"DsId": "a201c85c-******",
"DsName": "odps",
"DsType": "odps",
"GmtCreate": 1629450382000,
"GmtModify": 1629450382000,
"MeasureList": [
{
"Caption": "profit_amt",
"DataType": "string",
"Expression": "example_expression",
"FactColumn": "profit_amt",
"FieldDescription": "asadsda",
"MeasureType": "calculate_measure",
"TableUniqueId": "7a62530b36",
"Uid": "88b680****",
"ExpressionV2": "example_expression"
}
],
"OpenOfflineAcceleration": false,
"OwnerId": "b8494aab26124*****",
"OwnerName": "大娃",
"RowLevel": false,
"WorkspaceId": "420abef4-a79b-4289-b12****",
"WorkspaceName": "测试空间"
},
"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 | Decryption.Error | An error occurred while decoding. | 解密失败。 |
| 400 | Datasource.UserPermission.Error | You do not have datasource authorization. | 当前用户没有数据源权限。 |
| 400 | CubeMeta.ToXml.Error | An error occurred while converting the data object to the XML format. | 数据对象转换XML失败。 |
| 400 | Datasource.NotFound.Error | The specified data source does not exist: %s. | 数据源不存在：%s。 |
| 400 | Cube.ParseToXml.Error | An error occurred while parsing a dataset object to XML format. | 将多维数据集对象解析为XML错误。 |
| 400 | DatasourceId.IsNull.Error | You must select a data source before selecting the table. | 必须选择数据源之后再选择表。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-05-22 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |