调用GetDataSource通过数据源ID查询数据源详情-大数据开发治理平台 DataWorks-阿里云-大数据开发治理平台 DataWorks(DataWorks)-阿里云帮助中心

根据数据源ID，查询指定的数据源。

接口说明

需要购买 DataWorks 基础版及以上版本才能使用。
需要在 DataWorks 项目空间中具有如下至少一种角色：

租户所有者、空间管理员、部署、开发、项目所有者、运维

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

dataworks:GetDataSource

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
Id	integer	是	数据源 ID，数据源的唯一标识符。	16035

返回参数

名称	类型	描述	示例值
	object	返回结果。
RequestId	string	请求 ID。用于定位日志，排查问题。	9252F32F-D855-549E-8898-61CF5A733050
DataSource	object	数据源详情。
Id	integer	数据源的 ID。	16738
ProjectId	integer	数据源所属的项目空间 ID。	52660
Name	string	数据源的名称。	test
Type	string	数据源的类型。	hologres
ConnectionProperties	any	数据源的具体连接配置信息，包括连接地址、访问身份、环境信息等。数据源环境 envType 信息是此对象的成员属性，包括 Dev（开发环境） Prod（生产环境）不同类型的数据源在不同的配置模式（ConnectionPropertiesMode）下具有不同的属性信息规范，请参考数据源连接信息 ConnectionProperties	{ "envType": "Prod", "regionId": "cn-beijing", "instanceId": "hgprecn-cn-x0r3oun4k001", "database": "testdb", "securityProtocol": "authTypeNone", "authType": "Executor", "authIdentity": "1107550004253538" }
ConnectionPropertiesMode	string	数据源添加的类别，不同 type 下会有不同的子类型，对应有不同的参数约束，场景举例： InstanceMode 实例模式； UrlMode 连接串模式； CdhMode：CDH 模式。	UrlMode
Description	string	数据源的描述信息。	test
CreateTime	integer	数据源的创建时间（时间戳）。	1698286929333
CreateUser	string	数据源的创建者 ID。	1107550004253538
ModifyTime	integer	数据源的最近修改时间（时间戳）。	1698286929333
ModifyUser	string	数据源的修改者 ID。	1107550004253538
QualifiedName	string	数据源的业务唯一键，以 holo 举例格式是`${tenantOwnerId}:${regionId}:${type}:${instanceId}:${database}`。	1107550004253538:cn-beijing:holo:hgprecn-cn-x0r3oun4k001:testdb

示例

正常返回示例

JSON格式

{
  "RequestId": "9252F32F-D855-549E-8898-61CF5A733050",
  "DataSource": {
    "Id": 16738,
    "ProjectId": 52660,
    "Name": "test",
    "Type": "hologres",
    "ConnectionProperties": "{\n\t\"envType\": \"Prod\",\n\t\"regionId\": \"cn-beijing\",\n    \"instanceId\": \"hgprecn-cn-x0r3oun4k001\",\n    \"database\": \"testdb\",\n    \"securityProtocol\": \"authTypeNone\",\n    \"authType\": \"Executor\",\n    \"authIdentity\": \"1107550004253538\"\n}",
    "ConnectionPropertiesMode": "UrlMode",
    "Description": "test",
    "CreateTime": 1698286929333,
    "CreateUser": "1107550004253538",
    "ModifyTime": 1698286929333,
    "ModifyUser": "1107550004253538",
    "QualifiedName": "1107550004253538:cn-beijing:holo:hgprecn-cn-x0r3oun4k001:testdb"
  }
}

错误码

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

变更历史

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