调用GetDBInstanceConnectivityDiagnosis获取数据库实例网络连通性诊断结果

获取用户输入IP地址到指定数据库实例的网络连通性诊断结果。

接口说明

使用该接口需满足以下前提条件：

使用阿里云或 DAS 的 SDK 时，建议使用最新版本。
使用 SDK 调用 DAS 服务时，需要将地域指定为 cn-shanghai。
数据库实例已接入 DAS。

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
hdm:GetDBInstanceConnectivityDiagnosis	Read	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	实例 ID。	rm-2ze8g2am97624****
SrcIp	string	是	源 IP 地址。	47.100.XX.XX

返回参数

名称	类型	描述	示例值
	object	返回信息列表。
Code	string	返回的状态码。	200
Message	string	请求返回消息。说明请求成功时该参数返回 Successful，请求失败时会返回请求异常信息（如错误码等）。	Successful
Data	object	详细信息列表。
instanceId	string	实例 ID。	rm-2ze8g2am97624****
success	boolean	是否检测通过： true：检测通过。 false：检测不通过。	false
failType	string	异常类型： 0：用户可自助处理的。 1：需要联系值班人员处理的。	0
connCheckErrorCode	string	异常检测项： SRC_IP_NOT_IN_USER_WHITELIST：源 IP 地址没有配置在用户白名单中。 VIP_NOT_EXISTS：VIP 对应的 ALB 实例不存在。 RS_NOT_EXISTS：RS 不正常挂载。 VIP_TUNNEL_ID_NOT_CONSISTENT：VPC 类型 VIP 使用的 TUNNEL ID 与 VPC 对应的实际 TUNNEL ID 不一致。 VIP_VPC_CLOUD_INSTANCE_NOT_EXISTS：VPC 类型 VIP 不存在。 VIP_IS_NOT_NGLB：VIP 关闭了 NGLB 模式。 CUSTINS_NOT_ASSOCIATE_ECS_SECURITY_GROUP：实例没有关联安全组。 SRC_IP_NOT_IN_USER_WHITELIST：源 IP 地址没有配置在用户白名单中。 SRC_IP_NOT_IN_ADMIN_WHITELIST：源 IP 地址没有配置在管理机白名单中。 SRC_IP_NOT_IN_ECS_SECURITY_GROUP：源 IP 地址没有配置在实例关联的安全组中。 VPC_INSTANCE_IP_NOT_WORKING_STATUS：VPC IP 地址状态异常。	SRC_IP_NOT_IN_USER_WHITELIST
connCheckErrorMessage	string	异常检测详情信息。	Src ip:47.100.XX.XX not in user whitelist
RequestId	string	请求 ID。	B6D17591-B48B-4D31-9CD6-9B9796B2****
Success	string	请求是否执行成功： true：执行成功。 false：执行失败。	true

示例

正常返回示例

JSON格式

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

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidParams	The request parameters are invalid.	请求参数错误
403	NoPermission	You are not authorized to do this action.	没有权限执行该操作

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