全部产品
Search
文档中心

云原生数据仓库AnalyticDB:CheckJDBCSourceNetConnection - 检查JDBC连接串网络连通性

更新时间:Dec 20, 2024

检查jdbc连接串网络连通性。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
gpdb:CheckJDBCSourceNetConnectionnone
*DBInstance
acs:gpdb::{#accountId}:dbinstance/{#DBInstanceId}

请求参数

名称类型必填描述示例值
RegionIdstring

实例所在的地域 ID。

cn-hangzhou
DBInstanceIdstring

实例 ID。

gp-xxxxxxx
JdbcConnectionStringstring

jdbc 连接串。

jdbc:mysql://rm-xxx.mysql.rds.aliyuncs.com:3306/testadmin
DataSourceIdstring

DataSourceId 和 JdbcConnectionString 必须指定一项作为输入,否则报错。如果上述 2 个参数均指定,则优先使用 JdbcConnectionString 入参。

123

返回参数

名称类型描述示例值
object
ConnectionMessagestring

返回信息:连接不通时返回报错信息,否则返回为""。

connection timeout
ConnectionStatusstring

服务状态:

  • 网络联通:Success

  • 网络不通:Failed

Success
RequestIdstring

请求 ID。

B4CAF581-2AC7-41AD-8940-D56DF7AADF5B

示例

正常返回示例

JSON格式

{
  "ConnectionMessage": "connection timeout",
  "ConnectionStatus": "Success",
  "RequestId": "B4CAF581-2AC7-41AD-8940-D56DF7AADF5B"
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-08-20OpenAPI 入参发生变更查看变更详情