GetDataSourceMeta - 获取目标数据源的Meta信息 - 大数据开发治理平台 DataWorks

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

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
dataworks:*	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
ProjectId	long	是	DataWorks 工作空间的 ID。您可以登录 DataWorks 控制台，进入工作空间配置页面获取工作空间 ID。	10000
DatasourceName	string	是	目标数据源的名称。	mysql_name
PageNumber	long	是	请求的数据页数，用于翻页。	1
PageSize	long	是	每页显示的数据条数。	10
EnvType	string	否	目标数据源所属的环境。取值如下： 0：开发环境。 1：生产环境。	1

返回参数

名称	类型	描述	示例值
	object	返回数据。
Success	boolean	请求是否成功。取值如下： true：成功。 false：失败。	true
RequestId	string	本次调用的唯一 ID。用于出现错误后定位日志，排查问题。	0000-ABCD-EFG
Data	object	获取目标数据源 Meta 信息的返回的结果。
Status	string	获取目标数据源 Meta 信息的结果状态。取值如下： success：表示获取目标数据源的 Meta 信息成功。 fail：表示获取目标数据源的 Meta 信息失败。您可以查看 Message 参数定位失败原因。	success
Message	string	获取目标数据源 Meta 信息失败后的原因描述。如果获取目标数据源的 Meta 信息成功，则该参数的返回值为空。	read datasource time out
Meta	string	返回的目标数据源的 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	错误码	错误信息	描述
400	Invalid.DI.Parameter	The parameter is invalid.	参数错误
403	Forbidden.DI.NoPrivilege	No access.	没有权限访问
500	InternalError.DI.Parameter	A DI internal error occurred.	数据集成内部业务错误

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

变更历史

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