详情页标题前

阿里云大数据开发治理平台 DataWorksListDataSources-云淘科技

详情页1

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

调试

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

请求参数

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

系统规定参数。取值:ListDataSources

ProjectId Long 1

数据源所在的DataWorks工作空间ID。您可以通过ListProjects接口获取工作空间ID。

Name String test

查询的数据源名称。

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的正整数。

返回数据

名称 类型 示例值 描述
HttpStatusCode Integer 200

HTTP状态码。

RequestId String 0bc14115159376359****

请求ID。

Success Boolean true

请求是否成功。

Data Object

数据源的查询结果。

PageNumber Integer 1

页码。

PageSize Integer 20

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

TotalCount Integer 233

数据源的总数。

DataSources Array of DataSources

数据源列表。

Status Integer 1

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

  • 1,表示数据源正常使用。
  • 2,表示数据源已禁用。
ProjectId Integer 123

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

SubType String mysql

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

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

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

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

EnvType Integer 1

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

  • 0,开发环境。
  • 1,生产环境。
ConnectStatus Integer 1

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

  • 1,表示数据源正常使用。
  • 2,表示数据源已禁用。
Sequence Integer 300

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

Description String a connection

数据源的描述信息。

DataSourceType String rds

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

  • odps
  • mysql
  • rds
  • oss
  • sqlserver
  • polardb
  • oracle
  • mongodb
  • emr
  • postgresql
  • analyticdb_for_mysql
  • hybriddb_for_postgresql
  • holo
GmtCreate String Mar 17, 2021 4:09:32 PM

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

DefaultEngine Boolean false

数据源关联的引擎是否为同类型数据源选用的默认引擎。

Shared Boolean false

是否为共享的数据源。

Operator String 193543050****

最近一次修改数据源的阿里云用户ID。

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″}

数据连接串的相关信息。格式为JSON格式。常用的数据源对应的连接串样例如下:

  • MaxCompute
json
{
  "pubEndpoint": "http://service.cn.maxcompute.aliyun.com/api",
  "accessId": "xxxxxxx",
  "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"
}
  • mysql
json
{
  "configType": "1",
  "database": "mysql_d111b",
  "instanceName": "rm-xxxxxx",
  "password": "***",
  "rdsOwnerId": "12133xxxxxx",
  "tag": "rds",
  "username": "mysql_db111"
}
  • sqlserver
json
{
  "configType": "1",
  "jdbcUrl": "jdbc:sqlserver://rm-xxxxx.sqlserver.rds.aliyuncs.com:1433;DatabaseName=sqlserver_db1",
  "password": "***",
  "tag": "public",
  "username": "sqlserver_db111"
}
  • oss
json
{
  "accessId": "LTAINbR9Uxxxx",
  "accessKey": "***",
  "bucket": "bigxxx1223",
  "configType": "1",
  "endpoint": "http://oss-cn-hangzhou.aliyuncs.com",
  "tag": "public"
}
  • postgresql
json
{
  "configType": "1",
  "database": "cdp_xxx",
  "instanceName": "rm-xxxx",
  "password": "***",
  "rdsOwnerId": "121xxxxx",
  "tag": "rds",
  "username": "cdp_xxx"
}
  • ads
json
{
  "configType": "1",
  "password": "***",
  "schema": "ads_demo",
  "tag": "public",
  "url": "ads-xxx-xxxx.cn-hangzhou-1.ads.aliyuncs.com:3029",
  "username": "lslslsls"
}
Id Long 1

数据源ID。

BindingCalcEngineId Long 123

数据源关联的计算引擎ID。

TenantId Long 1234567

租户ID。

示例

请求示例

http(s)://[Endpoint]/?Action=ListDataSources
&Name=test
&ProjectId=1
&RegionId=cn-shanghai
&

正常返回示例

XML格式

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

0bc14115159376359****
200

    233
    20
    1
    
        1
        193543050****
        1
        mysql
        a connection
        123
        123
        Mar 17, 2021 4:09:32 PM
        300
        false
        1
        abc
        false
        1234567
        Mar 17, 2021 4:09:32 PM
        {"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"}
        rds
        1
    

true

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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",
      "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 错误码 错误信息 描述
400 Invalid.Tenant.ConnectionNotExists The connection does not exist. 数据源不存在。
400 Invalid.Tenant.ProjectNotExists The project does not exist. 项目不存在。
400 Invalid.Tenant.UserNotInProject The user is not in the project. 用户不在项目中。
403 Invalid.Tenant.UserIsNotProjectOwnerOrAdmin The user is not a project administrator or owner. 用户不是项目负责人或者项目管理员。
403 Invalid.Tenant.UserNotInTenant The user is not in tenant. 用户不在租户中。

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

内容没看懂? 不太想学习?想快速解决? 有偿解决: 联系专家

阿里云企业补贴进行中: 马上申请

腾讯云限时活动1折起,即将结束: 马上收藏

同尘科技为腾讯云授权服务中心。

购买腾讯云产品享受折上折,更有现金返利:同意关联,立享优惠

转转请注明出处:https://www.yunxiaoer.com/170997.html

(0)
上一篇 2023年12月10日
下一篇 2023年12月10日
详情页2

相关推荐

  • 阿里云ECS云服务器DescribePrefixListAssociations-云淘科技

    调用DescribePrefixListAssociations查询指定前缀列表已关联的资源信息。 调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。 请求参数 名称 类型 是否必选 示例值 描述 Action String 是 DescribePre…

    阿里云服务器 2023年12月9日
  • 腾讯云轻量应用服务器退费云小二

    简介 轻量对象存储(Lighthouse-COS)提供套餐包自助退费功能。您在退费前,请先阅读 退费规则。 退费须知 退费规则 购买套餐包时所使用的代金券不支持退还,非代金券费用按支付方式(现金/赠送金)及支付比例退还到支付方腾讯云账户。退费详情,请前往 订单管理页 查看。支持自助退费的套餐包需同时满足以下三个条件:订单类型:为新购或续费。用量:套餐包未使用…

    2023年12月9日
  • 腾讯云对象存储判断对象是否存在

    简介 本文档提供判断对象是否存在的 SDK 示例代码。 判断对象是否存在 功能说明 检查存储桶中是否存在某个对象。 方法原型 object_exists(Bucket, Key) 请求示例 # -*- coding=utf-8from qcloud_cos import CosConfigfrom qcloud_cos import CosS3Clienti…

    腾讯云 2023年12月9日
  • 腾讯云对象存储存储桶操作

    简介 本文档提供关于存储桶基本操作的相关 API 概览以及 SDK 示例代码。 API 操作名 操作描述 GET Service(List Buckets) 查询存储桶列表 查询指定账号下所有的存储桶列表 PUT Bucket 创建存储桶 在指定账号下创建一个存储桶 HEAD Bucket 检索存储桶及其权限 检索存储桶是否存在且是否有权限访问 DELETE…

    腾讯云 2023年12月9日
  • 信息流广告,信息流部分建议宽度830px,只针对默认列表样式,顺序随机
  • 腾讯云对象存储图片批量审核

    功能描述 图片批量审核接口支持同步、异步请求方式,您可以通过本接口对多个图片文件进行内容审核。该接口属于 POST 请求。说明支持审核腾讯云 COS 上的图片文件。支持审核第三方云存储厂商的图片 URL。支持审核加密数据,如有需要,请 联系服务人员 咨询。支持根据不同的业务场景 配置自定义的审核策略。 授权说明 授权策略中 action 设置为 ci:C…

    2023年12月9日

联系我们

400-800-8888

在线咨询: QQ交谈

邮件:admin@example.com

工作时间:周一至周五,9:30-18:30,节假日休息

关注微信
本站为广大会员提供阿里云、腾讯云、华为云、百度云等一线大厂的购买,续费优惠,保证底价,买贵退差。