調用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
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。