调用ListApiDatasource查询API数据源列表-智能商业分析 Quick BI-阿里云-智能商业分析 Quick BI(Quick BI)-阿里云帮助中心

查询API数据源列表。

接口说明

具体的参数说明详见创建 API 数据源。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

quickbi-public:ListApiDatasource

list

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
WorkspaceId	string	是	工作空间 ID。	89713491-cb4f-4579-b889-e82c35f1****
PageNum	integer	否	API 数据源列表的当前页码：起始值：1 默认值：1	1
PageSize	integer	否	分页查询时的每页行数：默认值：10 最大值：100	10
KeyWord	string	否	API 数据源名称的关键字。	测试

返回参数

名称	类型	描述	示例值
	object	返回结果。
RequestId	string	请求 ID。	D787E1A3-A93C-424A-B626-C2B05DF8D885
Result	object	返回查询结果。
Data	array<object>	查询到的 API 数据源列表。
	object
ApiId	string	API 数据源的 ID。	0f2c3c6409be4dc0810f2a5785e816a8
Body	string	JSON 格式的查询语句参数配置，用户可以自行定义。	{"key1":"value1"}
DataSize	number	API 数据源的数据量。单位：KB	0.39746094
DateUpdateTime	string	API 数据源最后同步时间，格式示例为 YYYY-MM-DD HH:mm:ss。	2022-05-25 16:19:43
GmtCreate	string	创建时间。	2022-05-25 16:19:43
GmtModified	string	修改时间。	2022-05-25 16:19:43
JobId	string	任务 ID。	REST_API_SYNC_0f2c3c6409be4dc0810f2a5785e816a8
Parameters	string	JSONArray 格式的参数配置。 name：参数名称 value：参数值	[{"name":"token","value":"xxxxxxxxxxxx"},{"name":"pageSize","value":100}]
ShowName	string	API 数据源的名称。	测试数据源
StatusType	integer	API 数据源同步任务状态。枚举值： 0 : 待运行 1 : 运行中 2 : 成功 3 : 失败	2
PageNum	integer	请求获取的数据页码数，用于翻页。	1
PageSize	integer	请求接口时设置的每页行数。	10
TotalNum	integer	总行数。	1
Success	boolean	是否请求成功。取值范围： true：请求成功 false：请求失败	true

示例

正常返回示例

JSON格式

{
  "RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
  "Result": {
    "Data": [
      {
        "ApiId": "0f2c3c6409be4dc0810f2a5785e816a8",
        "Body": "{\"key1\":\"value1\"}",
        "DataSize": 0.39746094,
        "DateUpdateTime": "2022-05-25 16:19:43",
        "GmtCreate": "2022-05-25 16:19:43",
        "GmtModified": "2022-05-25 16:19:43",
        "JobId": "REST_API_SYNC_0f2c3c6409be4dc0810f2a5785e816a8",
        "Parameters": "[{\"name\":\"token\",\"value\":\"xxxxxxxxxxxx\"},{\"name\":\"pageSize\",\"value\":100}]",
        "ShowName": "测试数据源",
        "StatusType": 2
      }
    ],
    "PageNum": 1,
    "PageSize": 10,
    "TotalNum": 1
  },
  "Success": true
}

错误码

HTTP status code	错误码	错误信息	描述
400	Workspace.NotIn.Organization	The workspace is not owned by the organization.	空间不在组织内。

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

变更历史

更多信息，参考变更详情。