文档

TestNetworkConnection - 测试数据源网络连通性

更新时间:

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

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
ProjectIdlong

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

10000
DatasourceNamestring

目标数据源的名称。

mysql_name
EnvTypestring

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

  • 0:开发环境。
  • 1:生产环境。
1
ResourceGroupstring

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

S_res_group_2XXXX4_1619100XXXXX

返回参数

名称类型描述示例值
object
Successboolean

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

  • true:成功。
  • false:失败。
true
RequestIdstring

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

0000-ABCD-EFG
TaskListobject

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

ConnectMessagestring

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

可连通
ConnectStatusboolean

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

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

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400Invalid.DI.ParameterThe parameter is invalid.参数错误
403Forbidden.DI.NoPrivilegeNo access.没有权限访问
500InternalError.DI.ParameterA DI internal error occurred.数据集成内部业务错误

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)