调用TestNetworkConnection接口，测试目标数据源与所使用资源组的网络连通性。

调试

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

请求参数

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

要执行的操作。
DatasourceName String 是 mysql_name

目标数据源的名称。
EnvType String 是 1

目标数据源所属的环境。取值如下：

  • 0：开发环境。
  • 1：生产环境。
ProjectId Long 是 10000

目标数据源所在的DataWorks工作空间ID。您可以调用ListProjects接口获取工作空间ID。

RegionId String 是 cn-shanghai

目标数据源所在的地域。例如，华东2（上海）是cn-shanghai，华北3（张家口）是cn-zhangjiakou。您无需填写RegionId，会根据调用的endpoint自动解析。
ResourceGroup String 是 S_res_group_2XXXX4_1619100XXXXX

目标数据源所使用的资源组的标识（Identifier）。您可以调用ListResourceGroups接口获取资源组的标识（Identifier）。

返回数据

名称 类型 示例值 描述
TaskList Struct

测试数据源与资源组网络连通性的返回结果。
ConnectMessage String 可连通

测试目标数据源与其所使用资源组的网络连通性失败后的原因描述。如果数据源与资源组网络连通性测试成功，则该参数的返回值为空。
ConnectStatus Boolean true

测试目标数据源与其所使用资源组网络连通性的结果状态。取值如下：

  • true：表示目标数据源与其所使用资源组的网络连通成功。
  • false：表示目标数据源与其所使用资源组的网络连通失败。您可以查看ConnectMessage参数定位失败原因。
Success Boolean true

请求是否成功。取值如下：

  • true：成功。
  • false：失败。
RequestId String 0000-ABCD-EFG

本次调用的唯一ID。用于出现错误后定位日志，排查问题。

示例

请求示例

http(s)://[Endpoint]/?Action=TestNetworkConnection
&DatasourceName=mysql_name
&EnvType=1
&ProjectId=10000
&RegionId=cn-shanghai
&ResourceGroup=S_res_group_2XXXX4_1619100XXXXX
&<公共请求参数>

正常返回示例

XML格式 

<RequestId>0000-ABCD-EFG	</RequestId>
<TaskList>
    <ConnectStatus>true</ConnectStatus>
    <ConnectMessage>可连通</ConnectMessage>
</TaskList>
<Success>true</Success>

JSON格式 

{
    "RequestId": "0000-ABCD-EFG",
    "TaskList": {
        "ConnectStatus": true,
        "ConnectMessage": "可连通"
    },
    "Success": true
}

错误码

HttpCode 错误码 错误信息 描述
403 Forbidden.DI.NoPrivilege No access. 没有权限访问
500 InternalError.DI.Parameter A DI internal error occurred. 数据集成内部业务错误
400 Invalid.DI.Parameter The parameter is invalid. 参数错误

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