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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 GetDataSourceMeta

系统规定参数。取值：GetDataSourceMeta。

ProjectId Long 是 10000

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

DatasourceName String 是 mysql_name

目标数据源的名称。
PageNumber Long 是 1

请求的数据页数，用于翻页。
PageSize Long 是 10

每页显示的数据条数。
RegionId String 是 cn-shanghai

数据源所在的地域。例如，华东2（上海）是cn-shanghai，华北3（张家口）是cn-zhangjiakou。您无需填写RegionId，会根据调用的endpoint自动解析。
EnvType String 否 1

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

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

返回数据

名称 类型 示例值 描述
Success Boolean true

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

  • true：成功。
  • false：失败。
RequestId String 0000-ABCD-EFG

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

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

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

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

获取目标数据源Meta信息失败后的原因描述。如果获取目标数据源的Meta信息成功，则该参数的返回值为空。
Meta String {"dbTables":[{"dbName":"testdb","schema":[{"tableInfos":[{"dbName":"testdb","enable":true,"table":"table1","tableName":"table1"}]},{"tableInfos":[{"dbName":"testdb","enable":true,"table":"table2","tableName":"table2"}]}]}]}

返回的目标数据源的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：数据库中表的信息。

示例

请求示例

http(s)://[Endpoint]/?Action=GetDataSourceMeta
&ProjectId=10000
&DatasourceName=mysql_name
&PageNumber=1
&PageSize=10
&EnvType=1
&公共请求参数

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Success" : true,
  "RequestId" : "0000-ABCD-EFG",
  "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\"}]}]}]}"
  }
}

错误码

HttpCode 错误码 错误信息 描述
400 Invalid.DI.Parameter The parameter is invalid. 参数错误
403 Forbidden.DI.NoPrivilege No access. 没有权限访问
500 InternalError.DI.Parameter A DI internal error occurred. 数据集成内部业务错误

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