全部產品
Search

搜尋本產品

    Data Transmission Service：配置DTS訂閱任務

    文件中心

    Data Transmission Service：配置DTS訂閱任務

    更新時間：Feb 10, 2025

    調用ConfigureSubscription介面配置DTS訂閱任務。

    說明 您可以根據需求在控制台進行相應的預配置，然後預覽對應配置的OpenAPI參數資訊，以協助您填寫請求參數。更多資訊，請參見預覽OpenAPI的請求參數。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    請求參數

    名稱

    類型

    是否必選

    樣本值

    描述
    Action String 是 ConfigureSubscription

    系統規定參數。取值：ConfigureSubscription。
    RegionId String 是 cn-hangzhou

    訂閱執行個體所在地區，請參見支援的地區列表。
    DtsJobName String 是 MySQL訂閱

    訂閱任務名稱。

    說明 建議配置具有業務意義的名稱（無唯一性要求），便於後續識別。
    DtsInstanceId String 否 dtsy0zz3t13h7d****

    訂閱執行個體ID，可以調用DescribeDtsJobs查詢。
    DtsJobId String 否 y0zz3t13h7d****

    訂閱任務ID，可以調用DescribeDtsJobs查詢。
    SourceEndpointEngineName String 否 PostgreSQL

    來源資料庫類型，取值為MySQL、PostgreSQL、Oracle。

    說明 當來源資料庫為自建資料庫，本參數必須傳入。
    SourceEndpointInstanceType String 否 RDS

    來源資料庫的執行個體類型，取值：

    • RDS：雲資料庫RDS。
    • PolarDB：PolarDB MySQL。
    • DRDS: PolarDB-X 1.0。
    • LocalInstance：有公網IP的自建資料庫。
    • ECS：ECS上的自建資料庫。
    • Express：通過專線接入的自建資料庫。
    • CEN：通過雲企業網CEN接入的自建資料庫。
    • dg：通過資料庫網關接入的自建資料庫。
    SourceEndpointRegion String 否 cn-hangzhou

    源執行個體所屬地區，詳情請參見支援的地區列表。

    說明 如果源執行個體為有公網IP的自建資料庫，則可以傳入cn-hangzhou或者離自建資料庫物理距離最近的地區ID。
    SourceEndpointInstanceID String 否 rm-bp1zc3iyqe3qw****

    源執行個體ID。

    說明 來源資料庫的執行個體類型為RDS MySQL、PolarDB-X 1.0、PolarDB MySQL時，本參數才可用且必須傳入。
    SourceEndpointIP String 否 172.16.8*.***

    來源資料庫的串連地址。

    說明 當來源資料庫為自建資料庫時，本參數才可用且必須傳入。
    SourceEndpointPort String 否 3306

    來源資料庫的服務連接埠。

    說明 當來源資料庫為自建資料庫時，本參數才可用且必須傳入。
    SourceEndpointOracleSID String 否 testsid

    Oracle資料庫的SID資訊。

    說明 當來源資料庫為自建Oracle時，且Oracle資料庫為非RAC執行個體時，本參數才可用且必須傳入。
    SourceEndpointDatabaseName String 否 dtstestdata

    待訂閱的資料庫名稱。
    SourceEndpointUserName String 否 dtstest

    源執行個體的資料庫帳號。

    說明 訂閱不同的資料庫所需的許可權有所差異，請參見準備用於資料訂閱的資料庫帳號中的帳號許可權。
    SourceEndpointPassword String 否 Test123456

    源執行個體的資料庫帳號密碼。
    SourceEndpointOwnerID String 否 140692647406****

    源執行個體所屬的阿里雲帳號ID。

    說明 僅在配置跨阿里雲帳號的資料訂閱時本參數才可用，且必須傳入。
    SourceEndpointRole String 否 ram-for-dts

    源執行個體的授權角色。當源執行個體與配置訂閱任務所屬阿里雲帳號不同時，需傳入該參數，來指定源執行個體的授權角色，以允許配置訂閱任務所屬阿里雲帳號訪問源執行個體的執行個體資訊。

    說明 角色所需的許可權及授權方式，請參見跨阿里雲帳號資料移轉或同步時如何配置RAM授權。
    DbList String 是 {"dtstest":{"name":"dtstest","all":true}}

    訂閱對象，格式為JSON串。詳細定義，請參見遷移、同步或訂閱對象說明。
    Reserve String 否 { "srcInstanceId": "cen-9kqshqum*******" }

    DTS預留參數，格式為JSON串，您可以傳入本參數完善源目庫資訊（如目標Kafka資料庫的資料存放區格式、雲企業網CEN的執行個體ID）。更多資訊，請參見Reserve參數說明參數說明。
    Checkpoint String 否 1616902385

    訂閱啟動時間，格式為Unix時間戳記，單位為秒（s）。

    說明 Unix時間戳記轉換工具可用搜尋引擎擷取。
    SubscriptionInstanceNetworkType String 是 vpc

    訂閱任務的網路類型，目前取值僅支援vpc，表示專用網路。

    說明
    • 如果傳入了本參數，則訂閱任務被定義為新版，您還需要正確設定SubscriptionInstanceVPCId和SubscriptionInstanceVSwitchID參數；如果不傳入該參數，則訂閱任務被定義為舊版。
    • 舊版訂閱任務支援訂閱自建MySQL、RDS MySQL和PolarDB-X 1.0的資料，新版訂閱任務支援訂閱自建MySQL、RDS MySQL、PolarDB MySQL和Oracle的資料。
    SubscriptionInstanceVPCId String 否 vpc-bp1vwnn14rqpyiczj****

    訂閱執行個體的專用網路ID。

    說明 當SubscriptionInstanceNetworkType取值為vpc時，本參數才可用且必須傳入。
    SubscriptionInstanceVSwitchId String 否 vsw-bp10df3mxae6lpmku****

    訂閱執行個體的虛擬交換器ID。

    說明 當SubscriptionInstanceNetworkType取值為vpc時，本參數才可用且必須傳入。
    SubscriptionDataTypeDDL Boolean 否 true

    是否訂閱DDL類型的資料，取值：

    • true：是，為預設值。
    • false：否。
    SubscriptionDataTypeDML Boolean 否 true

    是否訂閱DML類型的資料，取值：

    • true：是，為預設值。
    • false：否。
    DelayPhone String 否 1361234****,1371234****

    延遲警示的連絡人手機號碼，多個手機號碼以英文逗號（,）分隔。

    說明
    DelayRuleTime Long 否 10

    觸發延遲警示的閾值，單位為秒且需為整數，可根據業務需要設定閾值，建議設定10秒以上，避免因網路、資料庫負載等原因導致的延遲波動。

    說明 當DelayNotice取值為true時，本參數必須傳入。
    DelayNotice Boolean 否 true

    是否監控延遲狀態，取值：

    • true：是。
    • false：否。
    ErrorPhone String 否 1361234****,1371234****

    異常警示的連絡人手機號碼，多個手機號碼以英文逗號（,）分隔。

    說明
    ErrorNotice Boolean 否 true

    是否監控異常狀態，取值：

    • true：是。
    • false：否。
    DedicatedClusterId String 否 dtscluster_atyl3b5214uk***

    DTS專屬叢集ID，用於將訂閱任務調度到指定的DTS專屬叢集上。
    DtsBisLabel String 否 normal

    DTS執行個體的環境標籤，取值為：

    • normal：普通
    • online：線上
    MinDu double 否 1

    Serverless執行個體的DU下限，取值為：1、2、4、8、16。

    說明 當前暫不支援此功能，請勿傳入參數。
    MaxDu double 否 16

    Serverless執行個體的DU上限，取值為：2、4、8、16。

    說明 當前暫不支援此功能，請勿傳入參數。
    SrcCaCertificateOssUrl String 否 ****

    源庫通過SSL安全連線時，CA認證的路徑。

    說明 當前暫不支援此功能，請勿傳入此參數。
    SrcCaCertificatePassword String 否 ****

    源庫通過SSL安全連線時，CA認證的密鑰。

    說明 當前暫不支援此功能，請勿傳入此參數。
    SrcClientCertOssUrl String 否 ****

    源庫通過SSL安全連線時，用戶端認證的路徑。

    說明 當前暫不支援此功能，請勿傳入此參數。
    SrcClientKeyOssUrl String 否 ****

    源庫通過SSL安全連線時，用戶端認證私密金鑰的路徑。

    說明 當前暫不支援此功能，請勿傳入此參數。
    SrcClientPassword String 否 ****

    源庫通過SSL安全連線時，用戶端認證私密金鑰的密碼。

    說明 當前暫不支援此功能，請勿傳入此參數。
    ResourceGroupId String 否 rg-acfmzawhxxc****

    資源群組ID。

    返回資料

    名稱

    類型

    樣本值

    描述
    HttpStatusCode String 200

    狀態代碼。
    RequestId String 1D6ECADF-C5E9-4C96-8811-77602B31****

    請求ID。
    ErrCode String InternalError

    調用出錯時返回的錯誤碼。
    DtsJobId String y0zz3t13h7d****

    訂閱任務ID。
    Success String true

    請求是否成功。
    DtsInstanceId String dtsy0zz3t13h7d****

    訂閱執行個體ID。
    ErrMessage String The request processing has failed due to some unknown error.

    調用出錯時返回對應的錯誤資訊。

    樣本

    請求樣本

    http(s)://dts.aliyuncs.com/?Action=ConfigureSubscription
&DbList={"dtstest":{"name":"dtstest","all":true}}
&DtsJobName=MySQL訂閱
&SourceEndpointInstanceType=RDS
&SubscriptionInstanceNetworkType=vpc
&SourceEndpointInstanceID=rm-bp1zc3iyqe3qw****
&SourceEndpointUserName=dtstest
&SourceEndpointPassword=Test123456
&<公用請求參數>

    正常返回樣本

    XML格式

    HTTP/1.1 200 OK
Content-Type:application/xml

<ConfigureSubscriptionResponse>
    <DtsJobId>y0zz3t13h7d****</DtsJobId>
    <RequestId>1D6ECADF-C5E9-4C96-8811-77602B31****</RequestId>
    <HttpStatusCode>200</HttpStatusCode>
    <DtsInstanceId>dtsy0zz3t13h7d****</DtsInstanceId>
    <Success>true</Success>
</ConfigureSubscriptionResponse>

    JSON格式

    HTTP/1.1 200 OK
Content-Type:application/json

{
  "DtsJobId" : "y0zz3t13h7d****",
  "RequestId" : "1D6ECADF-C5E9-4C96-8811-77602B31****",
  "HttpStatusCode" : 200,
  "DtsInstanceId" : "dtsy0zz3t13h7d****",
  "Success" : true
}

    錯誤碼

    HttpCode

    錯誤碼

    錯誤資訊

    描述
    400 Throttling.User Request was denied due to user flow control. 由於請求頻次達到閾值，請求被拒絕，請稍後重試。
    500 ServiceUnavailable The request has failed due to a temporary failure of the server. 由於服務端響應逾時或者不可用導致請求失敗，請重試，重試後仍失敗請聯絡支援人員。
    403 InvalidSecurityToken.Expired Specified SecurityToken is expired. 簽名已經到期，請更新簽名

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