查询数据服务API列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| quickbi-public:QueryDataServiceList | get | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| Name | string | 否 | 数据服务名称。 | 测试sql |
| UserId | string | 否 | 用户 ID。 | dasdfdsa-csddf-dsadsa |
| PageNo | integer | 是 | 页码。默认取值 1。 | 1 |
| PageSize | integer | 是 | 分页查询时的每页行数：
| 10 |
返回参数
示例
正常返回示例
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。 |
访问错误中心查看更多错误码。