TestAgenticDataSourceConnection - 测试数据源连接-数据管理 DMS-阿里云帮助中心

测试数据源的网络和认证信息是否可用。

接口说明

只验证本次传入的连接信息，不创建或修改数据源。测试已有数据源时可以传入 DataSourceUuid 复用已保存的密码。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

dms:TestAgenticDataSourceConnection

none

*全部资源

*

无

请求语法

POST  HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
InstanceSource	string	是	数据源来源。取值：RDS-云数据库实例，PUBLIC_OWN-公网自建数据库，ECS_OWN-ECS 自建数据库，GATEWAY-通过数据库网关接入，VPC_IDC-专有网络或 IDC 接入。	RDS
InstanceResourceId	string	否	选择已有云实例时填写云资源实例 ID；按连接地址录入时可不填。	rm-bp1234567890
Alias	string	否	测试连接时可不填，不会创建或修改数据源。	demo_mysql
CatalogName	string	否	测试连接时可不填，不会创建元数据目录。	demo_catalog
DbType	string	是	数据源类型，使用大写标识，不要传数字。当前支持：MYSQL、POSTGRESQL、ORACLE、SQLSERVER、MARIADB、POLARDB、POLARDB_POSTGRESQL、POLARDB_ORACLE、OCEANBASEX、DRDS、ADB_MYSQL、ADB_POSTGRESQL、CLICKHOUSE、SELECTDB、STARROCKS、HOLOGRES、MAXCOMPUTE、ES_REST、TRINO。	MYSQL
Host	string	否	可选。数据库域名或 IP，不包含协议、路径和端口；选择已有云实例且地址已自动带出时可不填。	mysql.example.com
Port	integer	否	可选。数据库服务端口；选择已有云实例且端口已自动带出时可不填。	3306
Schema	string	否	可选。ADB_POSTGRESQL、DRDS、POSTGRESQL、POLARDB_POSTGRESQL 填数据库名；ORACLE 填 SID 或服务名，服务名前加 /；POLARDB_ORACLE 填 SID；MAXCOMPUTE 填 Project；其他类型不填。	postgres
SnowflakeWarehouse	string	否	Snowflake 计算仓库名称，仅 DbType=SNOWFLAKE 生效	WAREHOUSE
SnowflakeRole	string	否	Snowflake 角色名称，仅 DbType=SNOWFLAKE 生效	ROLE
AdbSparkResourceGroup	string	否	ADB MySQL Spark 资源组名称，仅 DbType=ADB_MYSQL_SPARK 生效。该类型连接时必须指定资源组；与 Schema（数据库名）独立，不能相互替代。	resourceGroup1
AuthType	integer	否	可选。取值：-1-无需认证，0-用户名和密码，1-仅密码，2-免密。	0
AuthAccount	string	否	登录用户名；无需用户名的认证方式可不填。	db_user
AuthPassword	string	否	登录密码；测试已有数据源时可不填以沿用已保存的密码，传入新值时优先使用本次值。	P@ss****
UseSsl	integer	否	是否使用 SSL：1-启用，0-关闭，-1-使用默认设置。仅 ADB_MYSQL、CLICKHOUSE、MARIADB、MYSQL、OCEANBASEX、POLARDB、SELECTDB、STARROCKS 支持 SSL，其他类型不填。	1
RoleArn	string	否	使用阿里云 RAM 角色访问数据源时填写完整角色 ARN；其他场景不填。	acs:ram::123456789012****:role/DataSourceRole
KmsSecret	string	否	使用 KMS 托管数据库凭据时填写凭据名称；其他场景不填。	datasource-secret
EnvType	string	否	测试连接时可不填。取值：product、pre、dev、test、sit、uat、pet、stag。	product
SyncAlias	integer	否	测试连接时可不填，不会修改数据源名称。	0
DataSourceUuid	string	否	测试已有数据源时填写其 UUID；若未传新密码，将沿用已保存的密码。测试新数据源时不填。	cn-hangzhou_a1b2c3d4e5f6
VpcId	string	否	通过专有网络访问 MaxCompute 时填写目标 VPC ID；其他场景不填。	vpc-bp1234567890
ZoneId	string	否	通过专有网络访问 MaxCompute 时填写目标可用区 ID；其他场景不填。	cn-hangzhou-h
VSwitchId	string	否	通过专有网络访问 MaxCompute 时填写目标交换机 ID；其他场景不填。	vsw-bp1234567890

按新建或已有数据源场景填写连接参数；测试已有数据源且不修改密码时可不传 AuthPassword。

返回参数

名称	类型	描述	示例值
	object	接口响应。
Data	object	连接测试结果。
Message	string	连接测试结果说明；连接成功时通常为空，失败时返回原因。	连接超时，请检查连接地址。
Success	boolean	数据源是否连接成功。
ErrorCode	string	调用失败时返回的错误码；成功时为空。	InvalidParameter
ErrorMessage	string	调用失败时返回的错误信息；成功时为空。	参数不合法。
RequestId	string	请求 ID，用于定位本次调用。	request-1234567890
Success	boolean	本次调用是否成功。

返回是否连接成功及失败原因。

示例

正常返回示例

JSON格式

{
  "Data": {
    "Message": "连接超时，请检查连接地址。",
    "Success": true
  },
  "ErrorCode": "InvalidParameter",
  "ErrorMessage": "参数不合法。",
  "RequestId": "request-1234567890",
  "Success": true
}

错误码

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

变更历史

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