检查jdbc连接串网络连通性。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
gpdb:CheckJDBCSourceNetConnection | none | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 否 | 实例所在的地域 ID。 | cn-hangzhou |
DBInstanceId | string | 是 | 实例 ID。 | gp-xxxxxxx |
JdbcConnectionString | string | 否 | jdbc 连接串。 | jdbc:mysql://rm-xxx.mysql.rds.aliyuncs.com:3306/testadmin |
DataSourceId | string | 否 | DataSourceId 和 JdbcConnectionString 必须指定一项作为输入,否则报错。如果上述 2 个参数均指定,则优先使用 JdbcConnectionString 入参。 | 123 |
返回参数
示例
正常返回示例
JSON
格式
{
"ConnectionMessage": "connection timeout",
"ConnectionStatus": "Success",
"RequestId": "B4CAF581-2AC7-41AD-8940-D56DF7AADF5B"
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-08-20 | OpenAPI 入参发生变更 | 查看变更详情 |