根据数据源业务信息,查询符合的数据源列表。
接口说明
- 需要购买 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 | 否 | 数据源环境类型,枚举值:
| Prod |
PageNumber | integer | 否 | 查询第几页,默认值为 1 表示第一页。 | 1 |
PageSize | integer | 否 | 分页大小,默认值为 10,最大值 100。 | 10 |
SortBy | string | 否 | 数据源列表排序字段,支持名称、创建时间、数据源 ID 排序
默认值:Id | Id |
Order | string | 否 | 数据源列表排序方向,枚举值:
默认值:Asc | Asc |
Tags | string | 否 | 数据源可以打标签,基于标签做数据源查询过滤:
| ["tag1", "tag2", "tag3"] |
返回参数
示例
正常返回示例
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"
}
]
}
]
}
}
错误码
访问错误中心查看更多错误码。