文档

DescribeDBClusterConnectivity - 查询源IP地址能否正常访问数据库

更新时间:

调用接口DescribeDBClusterConnectivity查询源IP地址能否正常访问数据库。

调试

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

授权信息

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

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

请求参数

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

资源组 ID。

rg-************
DBClusterIdstring

集群 ID。

pc-xxxxxxxxxxxxx
SourceIpAddressstring

用户源 IP 地址。

192.***.***.1

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

73A85BAF-1039-4CDE-A83F-1A140F******
DBClusterIdstring

集群 ID。

pc-xxxxxxxxxxxxx
ConnCheckResultstring

连接诊断结果。取值范围如下:

  • Success
  • Failed
Failed
ConnCheckErrorCodestring

连接诊断错误码。取值范围如下:

  • SRC_IP_NOT_IN_USER_WHITELIST:源 IP 地址没有加入白名单。
  • CONNECTION_ABNORMAL:连接正常。
SRC_IP_NOT_IN_USER_WHITELIST
ConnCheckErrorMessagestring

连接诊断错误信息。

Src ip:192.***.***.1 not in user whitelist

示例

正常返回示例

JSON格式

{
  "RequestId": "73A85BAF-1039-4CDE-A83F-1A140F******",
  "DBClusterId": "pc-xxxxxxxxxxxxx",
  "ConnCheckResult": "Failed",
  "ConnCheckErrorCode": "SRC_IP_NOT_IN_USER_WHITELIST",
  "ConnCheckErrorMessage": "Src ip:192.***.***.1 not in user whitelist"
}

错误码

HTTP status code错误码错误信息描述
400InvalidActionSpecified action is not valid.指定 action 无效。

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

  • 本页导读 (0)
文档反馈