GetDataSource - 查看数据源详情_大数据开发治理平台 DataWorks(DataWorks)-阿里云帮助中心

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

接口说明

需要权限：

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

调试

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

调试

授权信息

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

请求参数

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

返回参数

名称	类型	描述	示例值
	object	返回结果。
RequestId	string	请求 ID。用于定位日志，排查问题。	9252F32F-D855-549E-8898-61CF5A733050
DataSource	object	数据源详情。
Id	long	数据源的 ID。	16738
ProjectId	long	数据源所属的项目空间 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	long	数据源的创建时间（时间戳）。	1698286929333
CreateUser	string	数据源的创建者 ID。	1107550004253538
ModifyTime	long	数据源的最近修改时间（时间戳）。	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"
  }
}

错误码

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