调用ExportDataSources批量导出指定条件的目标数据源至本地。

调试

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

请求参数

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

要执行的操作。

Name String test

待导出的目标数据源名称所包含的关键字。

当前仅支持配置一个关键字。例如,该参数配置为test(即待导出的目标数据源名称所包含的关键字为test),则调用ExportDataSources接口会导出目标工作空间中所有名称包含test的数据源。

ProjectId Long 10000

目标数据源所在的DataWorks工作空间ID。您可以调用ListProjects接口获取工作空间ID。

RegionId String cn-shanghai

目标数据源所在的地域。例如,华东2(上海)为cn-shanghai,华北3(张家口)为cn-zhangjiakou。您无需填写RegionId,会根据调用的Endpoint自动解析。

DataSourceType String rds

目标数据源的类型。常用的类型如下:

  • odps
  • mysql
  • rds
  • oss
  • sqlserver
  • polardb
  • oracle
  • mongodb
  • emr
  • postgresql
  • analyticdb_for_mysql
  • hybriddb_for_postgresql
  • holo
SubType String mysql

目标数据源的子类型。仅当DataSourceType参数配置为rds时,该参数生效。

当DataSourceType参数配置为rds时,该参数可以配置为mysql、sqlserver或postgresql。

EnvType Integer 1

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

  • 0:开发环境。
  • 1:生产环境。
PageSize Integer 10

每页显示的条数,默认为10条,最大为100条。

PageNumber Integer 1

分页查询的页码。取值为大于等于1的正整数。

返回数据

名称 类型 示例值 描述
Data Struct

批量导出数据源的返回结果。

DataSources Array of DataSources

批量导出的数据源的详细信息。

此次调用的返回结果为导出数据源的详细信息数组,如下信息为数组中的一个数据源的详细信息示例。

BindingCalcEngineId Integer 123

数据源所绑定的引擎ID。

ConnectStatus Integer 1

数据源与任意独享资源组的连通性状态。取值如下:

  • 1:表示数据源至少与一个独享资源组连通。
  • 0:表示数据源与所有独享资源组均未连通。
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"}

数据源的详细配置。

DataSourceType String rds

数据源的类型。常用的类型如下:

  • odps
  • mysql
  • rds
  • oss
  • sqlserver
  • polardb
  • oracle
  • mongodb
  • emr
  • postgresql
  • analyticdb_for_mysql
  • hybriddb_for_postgresql
  • holo
DefaultEngine Boolean false

数据源所在的引擎是否为默认引擎。取值如下:

  • true:是默认引擎。
  • false:不是默认引擎。
Description String a connection

数据源的描述信息。

EnvType Integer 1

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

  • 0:开发环境。
  • 1:生产环境。
GmtCreate String Mar 17, 2021 4:09:32 PM

数据源的创建时间。格式示例为:Mar 17, 2021 4:09:32 PM。

GmtModified String Mar 17, 2021 4:09:32 PM

最近一次修改数据源的时间。格式示例为:Mar 17, 2021 4:09:32 PM。

Id Integer 1

数据源的ID。

Name String abc

数据源的名称。

Operator String 193543050****

操作数据源的用户ID。

ProjectId Integer 123

数据源所属的DataWorks工作空间ID。

Sequence Integer 300

数据源的序列。

Shared Boolean false

数据源是否可以分享。取值如下:

  • true:数据源可以分享。
  • false:数据源不可以分享。
Status Integer 1

数据源是否可用。取值如下:

  • 1:表示数据源可用。
  • 0:表示数据源不可用。
SubType String mysql

数据源的子类型。仅当DataSourceType参数配置为rds时,该参数生效。

当DataSourceType参数配置为rds时,该参数可以取值为mysql、sqlserver或postgresql。

TenantId Long 1234567

数据源所属租户的租户ID。

PageNumber Integer 10

分页查询的页码。取值为大于等于1的正整数。

PageSize Integer 1

每页显示的数据条数。

TotalCount Integer 100

返回满足条件的数据源总条数。

HttpStatusCode Integer 200

此次调用的返回结果状态。取值如下:

  • 200:表示此次调用的返回结果成功。
  • 其他值:表示此次调用的返回结果异常。您可以根据对应错误码处理相关异常。
RequestId String 0bc14115159376359****

请求ID。用于定位日志,排查问题。

Success Boolean true

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

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

示例

请求示例

http(s)://[Endpoint]/?Action=ExportDataSources
&Name=test
&ProjectId=10000
&RegionId=cn-shanghai
&<公共请求参数>

正常返回示例

XML格式

<RequestId>0bc14115159376359****</RequestId>
<HttpStatusCode>200</HttpStatusCode>
<Data>
    <TotalCount>100</TotalCount>
    <PageSize>1</PageSize>
    <PageNumber>10</PageNumber>
    <DataSources>
        <Status>1</Status>
        <Operator>193543050****</Operator>
        <ConnectStatus>1</ConnectStatus>
        <SubType>mysql</SubType>
        <Description>a connection</Description>
        <BindingCalcEngineId>123</BindingCalcEngineId>
        <ProjectId>123</ProjectId>
        <GmtModified>Mar 17, 2021 4:09:32 PM</GmtModified>
        <Sequence>300</Sequence>
        <Shared>false</Shared>
        <EnvType>1</EnvType>
        <Name>abc</Name>
        <DefaultEngine>false</DefaultEngine>
        <TenantId>1234567</TenantId>
        <GmtCreate>Mar 17, 2021 4:09:32 PM</GmtCreate>
        <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"}</Content>
        <DataSourceType>rds</DataSourceType>
        <Id>1</Id>
    </DataSources>
</Data>
<Success>true</Success>

JSON格式

{
    "RequestId": "0bc14115159376359****",
    "HttpStatusCode": 200,
    "Data": {
        "TotalCount": 100,
        "PageSize": 1,
        "PageNumber": 10,
        "DataSources": {
            "Status": 1,
            "Operator": "193543050****",
            "ConnectStatus": 1,
            "SubType": "mysql",
            "Description": "a connection",
            "BindingCalcEngineId": 123,
            "ProjectId": 123,
            "GmtModified": "Mar 17, 2021 4:09:32 PM",
            "Sequence": 300,
            "Shared": false,
            "EnvType": 1,
            "Name": "abc",
            "DefaultEngine": false,
            "TenantId": 1234567,
            "GmtCreate": "Mar 17, 2021 4:09:32 PM",
            "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\"}",
            "DataSourceType": "rds",
            "Id": 1
        }
    },
    "Success": true
}

错误码

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

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