跳到主要内容

查询有权限的数据源

分页查询当前 OpenAPI 凭证可访问的数据源。您可以按数据源 ID、类型、名称或关键词筛选,并使用页码和分页大小控制返回记录数。

调用本接口前,请按 OpenAPI 接口文档配置认证请求头。

请求地址:/openapi/v1/datasource/listAuthorized

请求方法:GET

请求参数​

参数类型是否必选说明示例
datasourceIdString否数据源 ID。<datasourceId>
datasourceTypeString否数据源类型。请使用目标环境当前启用的数据源类型值。<datasourceType>
nameString否数据源名称。<datasourceName>
keywordString否搜索关键词。可以使用数据源名称作为关键词。<keyword>
currentInteger否当前页码,从 1 开始,默认值为 1。1
pageSizeInteger否每页返回的记录数,默认值为 10。10

返回参数​

参数类型说明示例
successBool接口调用是否成功。true
requestIdString请求 ID。<requestId>
dataArray当前凭证有权访问且符合筛选条件的数据源记录。[{"datasourceId":"<datasourceId>"}]
currentInteger当前页码。1
pageSizeInteger每页返回的记录数。1
totalInteger符合当前权限范围和筛选条件的数据源总数。1

data 数组中的数据源记录可能包含连接地址和账号等信息。请按组织的数据处理要求保护响应内容。有关数据源响应字段的说明,请参见获取数据源列表。

调用成功示例​

{
"success": true,
"requestId": "<requestId>",
"data": [
{
"datasourceId": "<datasourceId>",
"name": "<datasourceName>",
"datasourceType": "<datasourceType>"
}
],
"current": 1,
"pageSize": 1,
"total": 1
}