ListDataSources - 查询数据源列表 - 大数据开发治理平台 DataWorks

根据数据源业务信息，查询符合的数据源列表。

接口说明

需要购买 DataWorks 基础版及以上版本才能使用。
需要在 DataWorks 项目空间中具有如下至少一种角色：

租户所有者、空间管理员、部署、开发、访客、项目所有者、运维、模型设计师、安全管理员、数据分析师、开发平台管理员、数据治理管理员

调试

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

调试

授权信息

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

请求参数

名称	类型	必填	描述	示例值
ProjectId	long	是	DataWorks 工作空间的 ID。您可以登录 DataWorks 控制台，进入工作空间配置页面获取工作空间 ID。该参数用来确定本次 API 调用操作使用的 DataWorks 工作空间。	17820
Name	string	否	数据源名称，基于此名称做模糊查询。	test
Types	array	否	数据源类型查询过滤，可以配置多个类型查询过滤。
	string	否	数据源的类型。	mysql
EnvType	string	否	数据源环境类型，枚举值： Dev：开发环境 Prod：生产环境	Prod
PageNumber	integer	否	查询第几页，默认值为 1 表示第一页。	1
PageSize	integer	否	分页大小，默认值为 10，最大值 100。	10
SortBy	string	否	数据源列表排序字段，支持名称、创建时间、数据源 ID 排序 CreateTime：创建时间 Id：数据源 ID Name：数据源名称默认值：Id	Id
Order	string	否	数据源列表排序方向，枚举值： Desc：倒序 Asc：正序默认值：Asc	Asc
Tags	string	否	数据源可以打标签，基于标签做数据源查询过滤：多个值之间是“且”的关系，比如`["tag1", "tag2", "tag3"]`底层查询同时有这 3 个标签打标的数据源列表。不传递，或者传递为空表示不作 tag 过滤。	["tag1", "tag2", "tag3"]

返回参数

名称	类型	描述	示例值
	object	返回结果。
RequestId	string	请求 ID。用于定位日志，排查问题。	7BE1433F-6D55-5D86-9344-CA6F7DD19B13
PagingInfo	object	分页信息。
TotalCount	long	总条数。	131
PageSize	long	页大小。	10
PageNumber	long	页码。	1
DataSources	array<object>	数据源列表，每一个元素是一个数据源组，包含开发环境（如有）和生产环境的信息。
数据源组	object	数据源组信息，包含开发环境（如有）和生产环境的数据源。开发环境和生产环境的数据源具有相同的数据源名称和数据源类型，不相同的数据源 ID。
Name	string	数据源的名称。	test
Type	string	数据源类型。	mysql
DataSource	array<object>	数据源列表，每个元素是单个数据源信息，具有唯一的数据源 ID。
数据源	object	单条数据源信息。
Id	long	数据源 ID，数据源的唯一标识符。	16035
ConnectionProperties	any	数据源的具体连接配置信息，包括连接地址、访问身份、环境信息等。数据源环境 envType 信息是此对象的成员属性，包括 Dev（开发环境） Prod（生产环境）不同类型的数据源在不同的配置模式（ConnectionPropertiesMode）下具有不同的属性信息规范，请参考数据源连接信息 ConnectionProperties	{ "envType": "Prod", "regionId": "cn-beijing", "instanceId": "hgprecn-cn-x0r3oun4k001", "database": "testdb", "securityProtocol": "authTypeNone", "authType": "Executor", "authIdentity": "1107550004253538" }
ConnectionPropertiesMode	string	数据源添加的类别，不同 type 下会有不同的子类型，对应有不同的参数约束，场景举例：InstanceMode 实例模式；UrlMode 连接串模式；CdhMode：CDH 模式。	UrlMode
Description	string	数据源的描述信息。	test
CreateTime	long	数据源的创建时间（时间戳）。	1648711113000
CreateUser	string	数据源的创建者 ID。	1624387842781448
ModifyTime	long	数据源的最近修改时间（时间戳）。	1648711113000
ModifyUser	string	数据源的修改者 ID。	1624387842781448
QualifiedName	string	数据源的业务唯一键，以 holo 举例格式是`${tenantOwnerId}:${regionId}:${type}:${instanceId}:${database}`。	1648711121000:cn-beijing:odps:yongxunQA_beijing_standard

示例

正常返回示例

JSON格式

{
  "RequestId": "7BE1433F-6D55-5D86-9344-CA6F7DD19B13",
  "PagingInfo": {
    "TotalCount": 131,
    "PageSize": 10,
    "PageNumber": 1,
    "DataSources": [
      {
        "Name": "test",
        "Type": "mysql",
        "DataSource": [
          {
            "Id": 16035,
            "ConnectionProperties": "{\n\t\"envType\": \"Prod\",\n\t\"regionId\": \"cn-beijing\",\n    \"instanceId\": \"hgprecn-cn-x0r3oun4k001\",\n    \"database\": \"testdb\",\n    \"securityProtocol\": \"authTypeNone\",\n    \"authType\": \"Executor\",\n    \"authIdentity\": \"1107550004253538\"\n}",
            "ConnectionPropertiesMode": "UrlMode",
            "Description": "test ",
            "CreateTime": 1648711113000,
            "CreateUser": "1624387842781448",
            "ModifyTime": 1648711113000,
            "ModifyUser": "1624387842781448",
            "QualifiedName": "1648711121000:cn-beijing:odps:yongxunQA_beijing_standard"
          }
        ]
      }
    ]
  }
}

错误码

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史