ExportDataSources - 导出数据源列表-阿里云帮助中心

导出数据源列表。

调试

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

授权信息

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

请求参数

名称	类型	必填	描述	示例值
ProjectId	integer	是	目标数据源所在的 DataWorks 工作空间 ID。您可以调用 ListProjects 接口获取工作空间 ID。	10000
Name	string	否	待导出的目标数据源名称所包含的关键字。当前仅支持配置一个关键字。例如，该参数配置为 test（即待导出的目标数据源名称所包含的关键字为 test），则调用 ExportDataSources 接口会导出目标工作空间中所有名称包含 test 的数据源。	test
DataSourceType	string	否	目标数据源的类型。常用的类型如下： odps mysql rds oss sqlserver polardb oracle mongodb emr postgresql analyticdb_for_mysql hybriddb_for_postgresql holo	rds
SubType	string	否	目标数据源的子类型。仅当 DataSourceType 参数配置为 RDS 时，该参数生效。当 DataSourceType 参数配置为 RDS 时，该参数可以配置为 mysql、sqlserver 或 postgresql。	mysql
EnvType	integer	否	目标数据源所属的环境。取值如下： 0：开发环境。 1：生产环境。	1
PageSize	integer	否	每页显示的条数，默认为 10 条，最大为 100 条。	10
PageNumber	integer	否	分页查询的页码。取值为大于等于 1 的正整数。	1

返回参数

名称	类型	描述	示例值
	object
HttpStatusCode	integer	此次调用的返回结果状态。取值如下： 200：表示此次调用的返回结果成功。其他值：表示此次调用的返回结果异常。您可以根据对应错误码处理相关异常。	200
RequestId	string	请求 ID。用于定位日志，排查问题。	0bc14115159376359****
Success	boolean	请求是否成功。取值如下： true：成功。 false：失败。	true
Data	object	批量导出数据源的返回结果。
PageNumber	integer	分页查询的页码。取值为大于等于 1 的正整数。	10
PageSize	integer	每页显示的数据条数。	1
TotalCount	integer	返回满足条件的数据源总条数。	100
DataSources	array<object>	批量导出的数据源的详细信息。此次调用的返回结果为导出数据源的详细信息数组，如下信息为数组中的一个数据源的详细信息示例。
	object
Status	integer	数据源是否可用。取值如下： 1：表示数据源可用。 0：表示数据源不可用。	1
ProjectId	integer	数据源所属的 DataWorks 工作空间 ID。	123
SubType	string	数据源的子类型。仅当 DataSourceType 参数配置为 RDS 时，该参数生效。当 DataSourceType 参数配置为 RDS 时，该参数可以取值为 mysql、sqlserver 或 postgresql。	mysql
GmtModified	string	最近一次修改数据源的时间。格式示例为：Mar 17, 2021 4:09:32 PM。	Mar 17, 2021 4:09:32 PM
EnvType	integer	数据源所属的环境。取值如下： 0：开发环境。 1：生产环境。	1
ConnectStatus	integer	数据源与任意独享资源组的连通性状态。取值如下： 1：表示数据源至少与一个独享资源组连通。 0：表示数据源与所有独享资源组均未连通。	1
Sequence	integer	数据源的序列。	300
Description	string	数据源的描述信息。	a connection
DataSourceType	string	数据源的类型。常用的类型如下： odps mysql rds oss sqlserver polardb oracle mongodb emr postgresql analyticdb_for_mysql hybriddb_for_postgresql holo	rds
GmtCreate	string	数据源的创建时间。格式示例为：Mar 17, 2021 4:09:32 PM。	Mar 17, 2021 4:09:32 PM
DefaultEngine	boolean	数据源所在的引擎是否为默认引擎。取值如下： true：是默认引擎。 false：不是默认引擎。	false
Shared	boolean	数据源是否可以分享。取值如下： true：数据源可以分享。 false：数据源不可以分享。	false
Operator	string	操作数据源的用户 ID。	193543050****
Name	string	数据源的名称。	abc
Content	string	数据源的详细配置。	{"pubEndpoint":"http://service.cn.maxcompute.aliyun.com/api","accessId":"TMP.3KecGjvzy3i8MYfn2BGHgF7EHGyBFZcHm7GgngrABVRyvvKQrfF5kskR36xP361C3dqwbGo7SGYptAeGyiTwHXqLaBUvYC","securityToken":null,"endpoint":"http://service.cn.maxcompute.aliyun-inc.com/api","accessKey":"***","name":"PRE_PROJECT_A_engine","project":"PRE_PROJECT_A","vpcEndpoint":"http://service.cn.maxcompute.aliyun-inc.com/api","region":"cn-shanghai","authType":"2"}
Id	integer	数据源的 ID。	1
BindingCalcEngineId	integer	数据源所绑定的引擎 ID。	123
TenantId	integer	数据源所属租户的租户 ID。	1234567

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "RequestId": "0bc14115159376359****",
  "Success": true,
  "Data": {
    "PageNumber": 10,
    "PageSize": 1,
    "TotalCount": 100,
    "DataSources": [
      {
        "Status": 1,
        "ProjectId": 123,
        "SubType": "mysql",
        "GmtModified": "Mar 17, 2021 4:09:32 PM",
        "EnvType": 1,
        "ConnectStatus": 1,
        "Sequence": 300,
        "Description": "a connection",
        "DataSourceType": "rds",
        "GmtCreate": "Mar 17, 2021 4:09:32 PM",
        "DefaultEngine": false,
        "Shared": false,
        "Operator": "193543050****",
        "Name": "abc",
        "Content": "{\"pubEndpoint\":\"http://service.cn.maxcompute.aliyun.com/api\",\"accessId\":\"TMP.3KecGjvzy3i8MYfn2BGHgF7EHGyBFZcHm7GgngrABVRyvvKQrfF5kskR36xP361C3dqwbGo7SGYptAeGyiTwHXqLaBUvYC\",\"securityToken\":null,\"endpoint\":\"http://service.cn.maxcompute.aliyun-inc.com/api\",\"accessKey\":\"***\",\"name\":\"PRE_PROJECT_A_engine\",\"project\":\"PRE_PROJECT_A\",\"vpcEndpoint\":\"http://service.cn.maxcompute.aliyun-inc.com/api\",\"region\":\"cn-shanghai\",\"authType\":\"2\"}",
        "Id": 1,
        "BindingCalcEngineId": 123,
        "TenantId": 1234567
      }
    ]
  }
}

错误码

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

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

变更历史

更多信息，参考变更详情。