文档

GetDataSourceMeta - 获取目标数据源的Meta信息

更新时间:

调用GetDataSourceMeta获取目标数据源的Meta信息。

调试

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

授权信息

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

请求参数

名称类型必填描述示例值
ProjectIdlong

DataWorks 工作空间的 ID。您可以登录 DataWorks 控制台,进入工作空间配置页面获取工作空间 ID。

10000
DatasourceNamestring

目标数据源的名称。

mysql_name
PageNumberlong

请求的数据页数,用于翻页。

1
PageSizelong

每页显示的数据条数。

10
EnvTypestring

目标数据源所属的环境。取值如下:

  • 0:开发环境。
  • 1:生产环境。
1

返回参数

名称类型描述示例值
object

返回数据。

Successboolean

请求是否成功。取值如下:

  • true:成功。
  • false:失败。
true
RequestIdstring

本次调用的唯一 ID。用于出现错误后定位日志,排查问题。

0000-ABCD-EFG
Dataobject

获取目标数据源 Meta 信息的返回的结果。

Statusstring

获取目标数据源 Meta 信息的结果状态。取值如下:

  • success:表示获取目标数据源的 Meta 信息成功。
  • fail:表示获取目标数据源的 Meta 信息失败。您可以查看 Message 参数定位失败原因。
success
Messagestring

获取目标数据源 Meta 信息失败后的原因描述。如果获取目标数据源的 Meta 信息成功,则该参数的返回值为空。

read datasource time out
Metastring

返回的目标数据源的 Meta 信息。返回的信息为 JSON 格式。

{"dbTables":[{"dbName":"testdb","schema":[{"tableInfos":[{"dbName":"testdb","enable":true,"table":"table1","tableName":"table1"}]},{"tableInfos":[{"dbName":"testdb","enable":true,"table":"table2","tableName":"table2"}]}]}]}

参数描述如下:

  • dbName:数据源所在的数据库名称。
  • schema:数据库所属的模式。
  • enable:数据库是否可用,包含 true(表示数据库可用),false(表示数据库不可用)取值。
  • tableName:数据库包含的表名称。
  • tableInfos:数据库中表的信息。
{"dbTables":[{"dbName":"testdb","schema":[{"tableInfos":[{"dbName":"testdb","enable":true,"table":"table1","tableName":"table1"}]},{"tableInfos":[{"dbName":"testdb","enable":true,"table":"table2","tableName":"table2"}]}]}]}

示例

正常返回示例

JSON格式

{
  "Success": true,
  "RequestId": "0000-ABCD-EFG\t",
  "Data": {
    "Status": "success",
    "Message": "read datasource time out",
    "Meta": "{\"dbTables\":[{\"dbName\":\"testdb\",\"schema\":[{\"tableInfos\":[{\"dbName\":\"testdb\",\"enable\":true,\"table\":\"table1\",\"tableName\":\"table1\"}]},{\"tableInfos\":[{\"dbName\":\"testdb\",\"enable\":true,\"table\":\"table2\",\"tableName\":\"table2\"}]}]}]}"
  }
}

错误码

HTTP status code错误码错误信息描述
400Invalid.DI.ParameterThe parameter is invalid.参数错误
403Forbidden.DI.NoPrivilegeNo access.没有权限访问
500InternalError.DI.ParameterA DI internal error occurred.数据集成内部业务错误

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

变更历史

变更时间变更内容概要操作
2023-11-14OpenAPI 错误码发生变更查看变更详情