全部產品
Search

搜尋本產品

    Data Transmission Service：查詢源庫和目標庫的連通性

    文件中心

    Data Transmission Service：查詢源庫和目標庫的連通性

    更新時間：Feb 10, 2025

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

    錯誤碼

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