调用DescribeConnectionStatus查询DTS服务器与源库和目标库的连通性。

调试

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

请求参数

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

系统规定参数，取值：DescribeConnectionStatus。

DestinationEndpointArchitecture String 是 SID

当SourceEndpointEngineName为Oracle时，才需要传入本参数，取值为：

  • SID：非集群架构。
  • RAC：集群架构。
说明 该参数的类型应为String，且为非必填参数。
DestinationEndpointInstanceType String 是 PolarDB_o

目标库的实例类型，取值：

说明
  • ECS：ECS上的自建数据库。
  • LocalInstance：有公网IP的自建数据库。
  • RDS：阿里云RDS实例。
  • DRDS：阿里云PolarDB-X实例。
  • MongoDB：阿里云MongoDB实例。
  • Redis：阿里云Redis实例。
  • PetaData：阿里云HybridDB for MySQL实例。
  • POLARDB：阿里云PolarDB MySQL集群。
  • PolarDB_o：阿里云PolarDB O引擎集群。
  • AnalyticDB：阿里云云原生数据仓库AnalyticDB MySQL 3.0和2.0版本。
  • Greenplum：阿里云云原生数据仓库AnalyticDB PostgreSQL。
DestinationEndpointOracleSID String 是 SID

当DestinationEndpointEngineName为Oracle时，才需要传入本参数，取值为：

  • SID：非集群架构。
  • RAC：集群架构。
说明 该参数的类型应为String，且为非必填参数。
SourceEndpointArchitecture String 是 SID

当SourceEndpointEngineName为Oracle时，才需要传入本参数，取值为：

  • SID：非集群架构。
  • RAC：集群架构。
说明 该参数为非必填参数。
SourceEndpointInstanceType String 是 RDS

源实例类别：

  • RDS：RDS实例。
  • LocalInstance：本地自建数据库。
  • ECS：ECS上的自建数据库。
  • Express：通过专线接入的自建数据库。
  • dg：通过DG网关接入的数据库。
  • MongoDB：阿里云MongoDB实例。
  • POLARDB：阿里云PolarDB MySQL集群。
  • PolarDB_o：阿里云PolarDB O引擎集群。
SourceEndpointInstanceID String 否 rm-bp1imrtn6fq7h****

源实例ID。
SourceEndpointEngineName String 否 MySQL

源实例数据库引擎类型，取值包括：MySQL、TiDB、SQLServer、PostgreSQL、Oracle、MongoDB、Redis。

说明 默认取值为MySQL。
SourceEndpointRegion String 否 cn-hangzhou

源实例所属地域，详情请参见支持的地域列表。

SourceEndpointIP String 否 172.16.88.***

源库的连接地址。

说明 当SourceEndpointInstanceType取值为LocalInstance或Express时，本参数才可用且必须传入。
SourceEndpointPort String 否 3306

源库的服务端口。

说明 当SourceEndpointInstanceType取值为ECS、LocalInstance或Express时，本参数才可用且必须传入。
SourceEndpointOracleSID String 否 testsid

Oracle数据库的SID信息。

说明 当SourceEndpointEngineName取值为Oracle，且Oracle数据库为非RAC实例时，本参数才可用且必须传入。
SourceEndpointDatabaseName String 否 dtstestdata

待迁移的数据库名称或鉴权数据库名称。

说明
  • 当SourceEndpointEngineName取值为PostgreSQL或MongoDB，或者SourceEndpointInstanceType为PolarDB_o时，本参数才可用且必须传入。
  • 当SourceEndpointEngineName取值为PostgreSQL或DRDS时，传入待迁移的数据库名称；取值为MongoDB时，传入数据库账号的鉴权数据库名称。
  • 当SourceEndpointInstanceType取值为PolarDB_o时，传入待迁移的数据库名称。
SourceEndpointUserName String 否 dtstest

源库的数据库账号。

说明 迁移或同步不同的数据库所需的权限有所差异，详情请参见迁移方案概览或同步方案概览中对应的配置案例。
SourceEndpointPassword String 否 Test123456

源库数据库账号的密码。
DestinationEndpointInstanceID String 否 testsid

目标实例ID。
DestinationEndpointEngineName String 否 MySQL

目标库的数据库类型。取值：MySQL、DRDS、SQLServer、PostgreSQL、PPAS、MongoDB或Redis。

说明 当DestinationEndpointInstanceType取值为RDS、DRDS、ECS、LocalInstance或Express时，本参数才可用且必须传入。
DestinationEndpointRegion String 否 cn-hangzhou

目标实例所属地域，详情请参见支持的地域列表。

DestinationEndpointIP String 否 172.16.88.***

目标库连接地址。

说明 当DestinationEndpointInstanceType取值为LocalInstance或Express时，本参数才可用且必须传入。
DestinationEndpointPort String 否 3306

源库的服务端口。

说明 当SourceEndpointInstanceType取值为ECS、LocalInstance或Express时，本参数才可用且必须传入。
DestinationEndpointDatabaseName String 否 dtstestdata

待迁入的数据库名称或鉴权数据库名称。

说明
  • 当DestinationEndpointEngineName取值为PostgreSQL、DRDS或MongoDB时，或者DestinationEndpointInstanceType取值为PolarDB_o时，本参数才可用且必须传入。
  • 当DestinationEndpointEngineName取值为PostgreSQL或DRDS时，传入待迁移的数据库名称；取值为MongoDB时，传入数据库账号的鉴权数据库名称。
  • 当DestinationEndpointInstanceType取值为PolarDB_o时，传入待迁移的数据库名称。
DestinationEndpointUserName String 否 dtstest

目标库的数据库账号。

说明 迁移或同步不同的数据库所需的权限有所差异，详情请参见迁移方案概览或同步方案概览中对应的配置案例。
DestinationEndpointPassword String 否 Test123456

目标库数据库账号的密码。
RegionId String 否 cn-hangzhou

DTS实例所在地域，详情请参见支持的地域列表。

返回数据

名称 类型 示例值 描述
DestinationConnectionStatus Map { "connectDetail": [ { "testName": "PolarDB_o JDBC Connect", "testSuccess": true }, { "testName": "Ping ", "testSuccess": true }, { "testName": "Telnet ", "testSuccess": true } ], "connectRes": true, "connectAdvice": "" }

目标库测试连接结果。
ErrCode String InternalError

调用出错时返回的错误码。
ErrMessage String The request processing has failed due to some unknown error.

调用错误时返回对应的错误信息。
RequestId String 0A47C784-70EF-4111-8677-369CAA00****

请求ID。
SourceConnectionStatus Map { "connectDetail": [ { "testName": "Oracle JDBC Connect", "testSuccess": true }, { "testName": "Ping ", "testSuccess": false }, { "testName": "Telnet ", "testSuccess": true } ], "connectRes": true, "connectAdvice": "" }

源库测试连接结果。
Success String true

请求是否成功。

示例

请求示例

http(s)://dts.aliyuncs.com/?Action=DescribeConnectionStatus
&DestinationEndpointArchitecture=SID
&DestinationEndpointInstanceType=PolarDB_o
&DestinationEndpointOracleSID=SID
&SourceEndpointArchitecture=SID
&SourceEndpointInstanceType=RDS
&<公共请求参数>

正常返回示例

XML格式 

<DescribeConnectionStatusResponse>
      <RequestId>0A47C784-70EF-4111-8677-369CAA00****</RequestId>
      <SourceConnectionStatus>
            <connectDetail>
                  <testName>Oracle JDBC Connect</testName>
                  <testSuccess>true</testSuccess>
            </connectDetail>
            <connectDetail>
                  <testName>Ping </testName>
                  <testSuccess>false</testSuccess>
            </connectDetail>
            <connectDetail>
                  <testName>Telnet </testName>
                  <testSuccess>true</testSuccess>
            </connectDetail>
            <connectRes>true</connectRes>
            <connectAdvice></connectAdvice>
      </SourceConnectionStatus>
      <DestinationConnectionStatus>
            <connectDetail>
                  <testName>PolarDB_o JDBC Connect</testName>
                  <testSuccess>true</testSuccess>
            </connectDetail>
            <connectDetail>
                  <testName>Ping </testName>
                  <testSuccess>true</testSuccess>
            </connectDetail>
            <connectDetail>
                  <testName>Telnet </testName>
                  <testSuccess>true</testSuccess>
            </connectDetail>
            <connectRes>true</connectRes>
            <connectAdvice></connectAdvice>
      </DestinationConnectionStatus>
      <Success>true</Success>
</DescribeConnectionStatusResponse>

JSON格式 

{
  "RequestId": "0A47C784-70EF-4111-8677-369CAA00****",
  "SourceConnectionStatus": {
    "connectDetail": [
      {
        "testName": "Oracle JDBC Connect",
        "testSuccess": true
      },
      {
        "testName": "Ping ",
        "testSuccess": false
      },
      {
        "testName": "Telnet ",
        "testSuccess": true
      }
    ],
    "connectRes": true,
    "connectAdvice": ""
  },
  "DestinationConnectionStatus": {
    "connectDetail": [
      {
        "testName": "PolarDB_o JDBC Connect",
        "testSuccess": true
      },
      {
        "testName": "Ping ",
        "testSuccess": true
      },
      {
        "testName": "Telnet ",
        "testSuccess": true
      }
    ],
    "connectRes": true,
    "connectAdvice": ""
  },
  "Success": true
}

错误码

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