DescribeDBClusterConnectivity - PolarDB - Alibaba Cloud Documentation Center

Queries whether the source IP address can access the cluster.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeDBClusterConnectivity	The action that you want to perform. Set the value to DescribeDBClusterConnectivity.
ResourceGroupId	String	No	rg-************	The ID of the resource group.
DBClusterId	String	Yes	pc-xxxxxxxxxxxxx	The ID of the cluster.
SourceIpAddress	String	Yes	192.*.*.1	The source IP address.

Response parameters


Parameter	Type	Example	Description
RequestId	String	73A85BAF-1039-4CDE-A83F-1A140F******	The ID of the request.
DBClusterId	String	pc-xxxxxxxxxxxxx	The ID of the cluster.
ConnCheckResult	String	Failed	The connection diagnosis result. Valid values: Success Failed
ConnCheckErrorCode	String	SRC_IP_NOT_IN_USER_WHITELIST	The error code for connection diagnosis. Valid values: SRC_IP_NOT_IN_USER_WHITELIST: The source IP address is not added to the whitelist. CONNECTION_ABNORMAL: The connection is abnormal.
ConnCheckErrorMessage	String	Src ip:192.*.*.1 not in user whitelist	The error message for connection diagnosis.

Examples

Sample requests

http(s)://polardb.aliyuncs.com/?Action=DescribeDBClusterConnectivity
&ResourceGroupId=rg-************
&DBClusterId=pc-xxxxxxxxxxxxx
&SourceIpAddress=192.***.***.1
&<Common request parameters>

Sample success responses

XML format

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 format

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"
}

Error codes


HTTP status code	Error code	Error message	Description
400	InvalidAction	Specified action is not valid.	The error message returned because the specified action is invalid.

For a list of error codes, see Service error codes.