调用ListDataSources接口,查询Dataworks数据源列表。

调试

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

请求参数

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

要执行的操作。

Name String test

查询的数据源名称。

ProjectId Long 1

数据源所在的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。

Status String ENABLED

数据源的状态。取值如下:

  • ENABLED,正常。
  • DISABLED,禁用。
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,表示数据源正常使用。
  • 2,表示数据源已禁用。
DataSourceType String rds

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

  • odps
  • mysql
  • rds
  • oss
  • sqlserver
  • polardb
  • oracle
  • mongodb
  • emr
  • postgresql
  • analyticdb_for_mysql
  • hybriddb_for_postgresql
  • holo
DefaultEngine Boolean 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

数据源关联的工作空间ID。

Sequence Integer 300

排序字段。数据源按此字段从大到小排序。

Shared Boolean false

是否为共享的数据源。

Status Integer 1

数据源的状态。取值如下:

  • 1,表示数据源正常使用。
  • 2,表示数据源已禁用。
SubType String mysql

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

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

TenantId Long 1234567

租户ID。

PageNumber Integer 1

页码。

PageSize Integer 20

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

TotalCount Integer 233

数据源的总数。

HttpStatusCode Integer 200

HTTP状态码。

RequestId String 0bc14115159376359****

请求ID。

Success Boolean true

请求是否成功。

示例

请求示例

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

正常返回示例

XML格式

<RequestId>0bc14115159376359****</RequestId>
<HttpStatusCode>200</HttpStatusCode>
<Data>
    <TotalCount>233</TotalCount>
    <PageSize>20</PageSize>
    <PageNumber>1</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>
        <DataSourceType>rds</DataSourceType>
        <Id>1</Id>
    </DataSources>
</Data>
<Success>true</Success>

JSON格式

{
  "RequestId": "0bc14115159376359****",
  "HttpStatusCode": "200",
  "Data": {
    "TotalCount": "233",
    "PageSize": "20",
    "PageNumber": "1",
    "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",
        "DataSourceType": "rds",
        "Id": "1"
      }
    ]
  },
  "Success": "true"
}

错误码

HttpCode 错误码 错误信息 描述
400 Invalid.Tenant.ConnectionNotExists The connection does not exist. 数据源不存在。
400 Invalid.Tenant.ProjectNotExists The project does not exist. 项目不存在。
403 Invalid.Tenant.UserIsNotProjectOwnerOrAdmin The user is not a project administrator or owner. 用户不是项目负责人或者项目管理员。
400 Invalid.Tenant.UserNotInProject The user is not in the project. 用户不在项目中。
403 Invalid.Tenant.UserNotInTenant The user is not in tenant. 用户不在租户中。

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