All Products
Search

This Product

    Database Autonomy Service:GetDBInstanceConnectivityDiagnosis

    Document Center

    Database Autonomy Service:GetDBInstanceConnectivityDiagnosis

    Last Updated:Aug 25, 2026

    Retrieves the network connectivity diagnosis result from a user-specified IP address to a specified database instance.

    Operation description

    Before you begin:

    • Use the latest version of Alibaba Cloud SDK or DAS SDK.

    • When calling DAS by using the SDK, set the region to cn-shanghai.

    • The database instance is connected to DAS.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    hdm:GetDBInstanceConnectivityDiagnosis

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    InstanceId

    string

    Yes

    The instance ID.

    rm-2ze8g2am97624****
    SrcIp

    string

    Yes

    The source IP address.

    47.100.XX.XX

    Response elements

    Element

    Type

    Description

    Example

    object

    The response parameters.

    Code

    string

    The returned status code.

    200
    Message

    string

    The returned message.

    Note

    If the request is successful, Successful is returned. If the request fails, an error message is returned, such as an error code.

    Successful
    Data

    object

    The details.

    instanceId

    string

    The instance ID.

    rm-2ze8g2am97624****
    success

    boolean

    Indicates whether the check is passed. Valid values:

    • true: The check is passed.

    • false: The check is not passed.

    false
    failType

    string

    The exception type. Valid values:

    • 0: The issue can be resolved by the user.

    • 1: The issue requires on-duty personnel to resolve.

    0
    connCheckErrorCode

    string

    The outlier detection item. Valid values:

    • SRC_IP_NOT_IN_USER_WHITELIST: The source IP address is not added to the user whitelist.

    • VIP_NOT_EXISTS: The ALB instance corresponding to the VIP does not exist.

    • RS_NOT_EXISTS: The RS is not properly mounted.

    • VIP_TUNNEL_ID_NOT_CONSISTENT: The TUNNEL ID used by the VPC-type VIP is inconsistent with the actual TUNNEL ID of the VPC.

    • VIP_VPC_CLOUD_INSTANCE_NOT_EXISTS: The VPC-type VIP does not exist.

    • VIP_IS_NOT_NGLB: The NGLB pattern is shutdown for the VIP.

    • CUSTINS_NOT_ASSOCIATE_ECS_SECURITY_GROUP: The instance is not associated with a security group.

    • SRC_IP_NOT_IN_USER_WHITELIST: The source IP address is not added to the user whitelist.

    • SRC_IP_NOT_IN_ADMIN_WHITELIST: The source IP address is not added to the management machine whitelist.

    • SRC_IP_NOT_IN_ECS_SECURITY_GROUP: The source IP address is not added to the security group associated with the instance.

    • VPC_INSTANCE_IP_NOT_WORKING_STATUS: The VPC IP address is in an abnormal state.

    SRC_IP_NOT_IN_USER_WHITELIST
    connCheckErrorMessage

    string

    The details of the outlier detection item.

    Src ip:47.100.XX.XX not in user whitelist
    RequestId

    string

    The request ID.

    B6D17591-B48B-4D31-9CD6-9B9796B2****
    Success

    string

    Indicates whether the request is successful. Valid values:

    • true: The request is successful.

    • false: The request fails.

    true

    Examples

    Success response

    JSON format

    {
  "Code": "200",
  "Message": "Successful",
  "Data": {
    "instanceId": "rm-2ze8g2am97624****",
    "success": false,
    "failType": "0",
    "connCheckErrorCode": "SRC_IP_NOT_IN_USER_WHITELIST",
    "connCheckErrorMessage": "Src ip:47.110.180.62 not in user whitelist"
  },
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Success": "true"
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 InvalidParams The request parameters are invalid. The request parameters are invalid.
    403 NoPermission You are not authorized to do this action. You do not have the permissions to perform this operation.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.