TestDataSourceConnectivity - 测试数据源的连通性

测试数据源在资源组上的连通性。

接口说明

  1. 需要购买 DataWorks 基础版及以上版本才能使用。
  2. 需要在 DataWorks 项目空间中具有如下至少一种角色: 租户所有者、空间管理员、部署、开发、项目所有者、运维

调试

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

授权信息

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

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

请求参数

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

资源组 ID,即资源组的唯一标识符。

Serverless_res_group_524257424564736_6831777003XXXXX
DataSourceIdlong

待测试连通性的数据源 ID,数据源 ID 是数据源的唯一标识符。

144544
ProjectIdlong

DataWorks 项目空间 ID。

10001

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID,一次请求的唯一标识。

4CDF7B72-020B-542A-8465-21CFFA81****
Connectivityobject

连通性详情

ConnectStatestring

测试后的连通性状态。 枚举值: ● Connectable:可连通 ● ConfigError:网络可通,但是配置有误 ● Unreachable:不可连通 ● Unsupport:其他不支持的场景,例如资源组处于初始化中

Connectable
ConnectMessagestring

连通性测试失败时,具体的描述信息。 连通性测试成功时,无该信息。

连接数据库失败
DetailLogsarray<object>

测试连通性各个阶段的详细日志

测试连通性各个阶段的详细日志object
StartTimelong

表示该步骤的起始时间

1730217600001
EndTimelong

表示该步骤的终止时间

1730217604002
Codestring

测试项代码

validate_input_parameters
Messagestring

测试步骤名称

校验输入参数

示例

正常返回示例

JSON格式

{
  "RequestId": "4CDF7B72-020B-542A-8465-21CFFA81****",
  "Connectivity": {
    "ConnectState": "Connectable",
    "ConnectMessage": "连接数据库失败",
    "DetailLogs": [
      {
        "StartTime": 1730217600001,
        "EndTime": 1730217604002,
        "Code": "validate_input_parameters",
        "Message": "校验输入参数"
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史