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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 DescribeDBClusterConnectivity

系统规定参数。取值：DescribeDBClusterConnectivity。
ResourceGroupId String 否 rg-************

资源组ID。
DBClusterId String 是 pc-xxxxxxxxxxxxx

集群ID。
SourceIpAddress String 是 192.***.***.1

用户源IP地址。

返回数据

名称 类型 示例值 描述
RequestId String 73A85BAF-1039-4CDE-A83F-1A140F******

请求ID。
DBClusterId String pc-xxxxxxxxxxxxx

集群ID。
ConnCheckResult String Failed

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

  • Success
  • Failed
ConnCheckErrorCode String SRC_IP_NOT_IN_USER_WHITELIST

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

  • SRC_IP_NOT_IN_USER_WHITELIST：源IP地址没有加入白名单。
  • CONNECTION_ABNORMAL：连接正常。
ConnCheckErrorMessage String Src ip:192.***.***.1 not in user whitelist

连接诊断错误信息。

示例

请求示例

http(s)://polardb.aliyuncs.com/?Action=DescribeDBClusterConnectivity
&ResourceGroupId=rg-************
&DBClusterId=pc-xxxxxxxxxxxxx
&SourceIpAddress=192.***.***.1
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDBClusterConnectivityResponse>
    <RequestId>73A85BAF-1039-4CDE-A83F-1A140F******</RequestId>
    <DBClusterId>pc-xxxxxxxxxxxxx</DBClusterId>
    <ConnCheckResult>Failed</ConnCheckResult>
    <ConnCheckErrorCode>SRC_IP_NOT_IN_USER_WHITELIST</ConnCheckErrorCode>
    <ConnCheckErrorMessage>Src ip:192.***.***.1 not in user whitelist</ConnCheckErrorMessage>
</DescribeDBClusterConnectivityResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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"
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidAction Specified action is not valid. 指定 action 无效。

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