QueryDataServiceList - 数据服务列表API_智能商业分析 Quick BI(Quick BI)-阿里云帮助中心

查询数据服务API列表。

调试

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

授权信息

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

请求参数

名称	类型	必填	描述	示例值
Name	string	否	数据服务名称。	测试sql
UserId	string	否	用户 ID。	dasdfdsa-csddf-dsadsa
PageNo	integer	是	页码。默认取值 1。	1
PageSize	integer	是	分页查询时的每页行数：默认值：10 最大值：1000	10

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	78C1AA2D-9201-599E-A0BA-6FC462E57A95
Result	object	返回结果。
TotalPages	integer	总页数。	1
TotalNum	integer	总行数。	1
PageNum	integer	页码。	1
PageSize	integer	页记录数	10
Data	array<object>	数据服务信息。
QueryDataServiceModel	object
Sid	string	数据服务的唯一 ID。	dtsuq3i31f5j8v848b
Name	string	数据服务名称。	测试报表
Desc	string	描述	测试用
CubeId	string	cube 标识 id	d14e7448-0eb3-40d3-9375-4afef8de29fd
CubeName	string	数据集名称。	测试数据集
WorkspaceId	string	工作空间 ID。	7350a155-0e94-4c6c-8620-57bbec38****
WorkspaceName	string	工作空间名称。	测试工作空间
GmtCreate	string	创建时间。	2023-05-18 14:00:02.0
GmtModified	string	修改时间。	2023-03-21 18:02:36
CreatorId	string	创建人 id	7cb94cd48701
CreatorName	string	创建者姓名	张仔龙
ModifierId	string	修改者 userId。	7cb94cd48701
ModifierName	string	修改人名	张仔龙
OwnerId	string	拥有者 id	862801339
OwnerName	string	所有者名字	李四
Content	object	数据服务的 Model，JSON 格式。
ReturnFields	array<object>	返回信息。
SelectFieldModel	object
Alias	string	字段参数名。	s_number
Desc	string	返回字段的备注。	主题配置已存在。
Aggregator	string	聚合操作符。例如 SUM、AVG 和 MAX。	SUM
Orderby	string	排序。 asc：升序 desc：降序 no：不排序	no
Field	object	对应的 cube 字段信息。
Fid	string	原始字段唯一标志 ID。	1c1f88cb7d
Name	string	cube 字段的唯一名称，主要用于返回结果的唯一定位。	sss
Type	string	类型。 Dimension：维度 Measure：度量	dimension
Caption	string	cube 模型中的显示名（可能是中文，也可能是英文）。	日期(year)
Column	string	对应的物理字段名。	shid_star
DataType	string	数据类型。 number：数字 string：字符串 date：时间 datetime：时间 time：时间 geographic：地理 boolean：布尔 url：url	datetime
Granularity	string	日期维度、地理维度包含此属性，支持的粒度。	yearRegion
Filter	object	请求参数信息。
LogicalOperator	string	多个 SQL 文本关键词的逻辑关系。 or：或。 and：与。	and
Type	string	类型。 basic：基本 combined：复杂	basic
Filters	array<object>	组合条件。
AbstractFilter	object	分级门户菜单列表详情的 JSON 字符串。取值范围： Type：类型。 1.basic：基本 2.combined：复杂 field：对应的 cube 字段 alias：参数名 desc：字段的备注描述 aggregator：聚合函数 operator：操作符 essential：是否必传 defaultValue：系统默认值。如果接口调用不传入时，以此值替换。 interval：日期的偏移量。对于日期有效，相对默认值或者参数值的相对值。 logicalOperator：逻辑操作符 filters：组合条件（这是个套嵌结构）	[{ "field": { "fid": "1c1f88cb7d", "granularity": "yearRegion", "dataType": "datetime", "column": "s_date", "caption": "日期(year)", "type": "dimension" }, "defaultValue": ["2024"], "alias": "s_date", "type": "basic", "operator": "equal-to", "essential": true }]
CubeId	string	cube 标识 id。	56f9f34a-bdba-496a-91a3-a18b1ff73a80
CubeName	string	数据集名称。	测试数据集
Detail	boolean	明细 or 汇总。	true
Success	boolean	是否请求成功。取值范围： true：请求成功 false：请求失败	true

示例

正常返回示例

JSON格式

{
  "RequestId": "78C1AA2D-9201-599E-A0BA-6FC462E57A95",
  "Result": {
    "TotalPages": 1,
    "TotalNum": 1,
    "PageNum": 1,
    "PageSize": 10,
    "Data": [
      {
        "Sid": "dtsuq3i31f5j8v848b",
        "Name": "测试报表",
        "Desc": "测试用",
        "CubeId": "d14e7448-0eb3-40d3-9375-4afef8de29fd",
        "CubeName": "测试数据集",
        "WorkspaceId": "7350a155-0e94-4c6c-8620-57bbec38****",
        "WorkspaceName": "测试工作空间",
        "GmtCreate": "2023-05-18 14:00:02.0",
        "GmtModified": "2023-03-21 18:02:36",
        "CreatorId": "7cb94cd48701",
        "CreatorName": "张仔龙",
        "ModifierId": "7cb94cd48701",
        "ModifierName": "张仔龙\n",
        "OwnerId": "862801339",
        "OwnerName": "李四",
        "Content": {
          "ReturnFields": [
            {
              "Alias": "s_number",
              "Desc": "主题配置已存在。",
              "Aggregator": "SUM",
              "Orderby": "no",
              "Field": {
                "Fid": "1c1f88cb7d",
                "Name": "sss",
                "Type": "dimension",
                "Caption": "日期(year)",
                "Column": "shid_star",
                "DataType": "datetime",
                "Granularity": "yearRegion"
              }
            }
          ],
          "Filter": {
            "LogicalOperator": "and",
            "Type": "basic",
            "Filters": [
              [
                {
                  "field": {
                    "fid": "1c1f88cb7d",
                    "granularity": "yearRegion",
                    "dataType": "datetime",
                    "column": "s_date",
                    "caption": "日期(year)",
                    "type": "dimension"
                  },
                  "defaultValue": [
                    "2024"
                  ],
                  "alias": "s_date",
                  "type": "basic",
                  "operator": "equal-to",
                  "essential": true
                }
              ]
            ]
          },
          "CubeId": "56f9f34a-bdba-496a-91a3-a18b1ff73a80",
          "CubeName": "测试数据集",
          "Detail": true
        }
      }
    ]
  },
  "Success": true
}

错误码

HTTP status code	错误码	错误信息	描述
400	Internal.System.Error	An internal system error occurred.	系统内部异常。
500	Invalid.User.Organization	The user is not in your organization.	该用户不在您的组织中。
500	Invalid.Parameter.Error	The parameter is invalid:%s.	无效参数%s。

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