调用GetDataSourceConnectionInfo获取数据源连接信息-智能商业分析 Quick BI-阿里云

获取数据源信息。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
quickbi-public:GetDataSourceConnectionInfo	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
DsId	string	是	数据源 ID。	7AAB95D-***-*-4FC0C976

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	7AAB95D-***-*-4FC0C976
Result	object	数据源信息。
Address	string	数据库连接串地址（域名或 ip）。	172...48
AuthLevel	string	权限级别： 0 -- 私有 1 -- 协同编辑(旧) 11 -- 协同编辑——空间成员 12 -- 协同编辑——指定到人	0
CreatorId	string	创建人的 Quick BI 用户 ID。	U240****0880C6095
DsId	string	数据源 ID。	a201c85c-******
DsType	string	数据源类型。枚举值： hive：Hive 数据源。 vertica：Vertica 数据源。 ppas：RDS PPAS数据源。 dm：DM7数据源-达梦。 tsdb：TSDB数据源。 tdsql：TDSQL-H数据源。 mysql_hybrid：HybridDB for MySQL数据源。 sqlserver：sqlserver数据源。 postgresql：postgresql数据源。 garuda：garuda数据源。 adb_spark：adb数据源Spark引擎。 greenplum：greenplum数据源。 phoenix_thin：PHOENIX THIN 数据源。 dla：DataLake Analytics 数据源。 starrocks：StarRocks数据源。 mysql：mysql数据源。 hana：SAP HANA 数据源。 mongodb：MongoDB数据源。 adb：ADB。 hbase：HBASE数据源。 oscar：神通数据源。 gbase：Gbase数据源。 oracle：oracle数据源。 sybase： SAP SYBASE IQ 数据源。 dataphin：DataPhin数据源-多引擎。 odps：odps数据源。 db2：IBM DB2数据源(LUW)。 yida：宜搭应用数据源。 clickhouse：ClickHouse数据源。 oceanbase_oracle：OceanBase_Oracle模式数据源。 presto：presto数据源。 polardb：polardb数据源。 dataphin_odps：DataPhin数据源odps引擎。 selectdb：SelectDB数据源。	mysql
DsVersion	string	数据源的版本。	5.7
Instance	string	数据库实例，对应数据库名称，ODPS 为 project。	rm*********t44ju1
InstanceId	string	实例 ID。	rm*********t44ju1
ModifyUser	string	修改人的 Quick BI 用户 ID。	U240****0880C6095
NoSasl	boolean	impala 数据源是否需要身份验证即可登录： true-需要账户密码登录 false-不需要验证(默认)	true
ParentDsType	string	多引擎数据源的主数据源类型。	dataphin
Port	string	端口。	3306
Project	string	获取连接串详情时，odps 供前端展示使用。	prod-ossdoc
Schema	string	数据库 schema，仅对支持 schema 的数据库需要设置。	Analysis
ShowName	string	数据源前端展示名称。	0327
WorkspaceId	string	数据源所属工作空间 ID。	0de62-d-4720-8836-0cc****1394c
Success	boolean	是否成功。	true

示例

正常返回示例

JSON格式

{
  "RequestId": "7AAB95D-*****-****-*4FC0C976",
  "Result": {
    "Address": "172.**.**.48",
    "AuthLevel": 0,
    "CreatorId": "U240****0880C6095",
    "DsId": "a201c85c-******",
    "DsType": "mysql",
    "DsVersion": 5.7,
    "Instance": "rm*********t44ju1",
    "InstanceId": "rm*********t44ju1",
    "ModifyUser": "U240****0880C6095",
    "NoSasl": true,
    "ParentDsType": "dataphin",
    "Port": 3306,
    "Project": "prod-ossdoc",
    "Schema": "Analysis",
    "ShowName": "0327",
    "WorkspaceId": "0de6**2-d**-4720-8836-0cc****1394c"
  },
  "Success": true
}

错误码

HTTP status code	错误码	错误信息	描述
297	Invalid.Parameter	The length of the parameter must not exceed 1000.	参数长度超过1000条限制
297	Invalid.Parameter	You must specify the parameter.	参数不能为空
400	Access.Forbidden	Your instance version or access key is not allowed to call the API operation, only professional version supports calling.	您的实例版本或者 AccessKey不允许调用该 API，仅专业版支持调用。
500	Internal.System.Error	An internal system error occurred.	系统内部异常。
500	Instance.Expired	Your instance has expired.	您的购买实例已经过期。
500	Instance.Not.Exist	The specified instance does not exist.	暂未匹配到您的购买实例。
500	Invalid.Organization	The specified organizational unit does not exist.	该组织不存在。
500	User.Not.In.Organization	The specified user is not in the organizational unit.	该用户不在组织中。
500	Invalid.Param.Error	The parameter is invalid.	无效参数。
500	Invalid.Parameter	An error occurred while verifying parameters.	参数验证失败。
500	Invalid.Parameter.Error	The parameter is invalid:%s.	无效参数%s。
500	Datasource.NotFound.Error	The specified data source does not exist: %s.	数据源不存在：%s。
500	Application.Object.NotExist	The object you are operating does not exist or has been deleted.	操作组件不存在或已被删除。

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