調用ConfigureSubscriptionInstance接口配置訂閱實例。

調用本接口前，已調用CreateSubscriptionInstance接口創建了數據訂閱實例。

調試

您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。

請求參數

名稱 類型 是否必選 示例值 描述
Action String 是 ConfigureSubscriptionInstance

系統規定參數，取值：ConfigureSubscriptionInstance。

SubscriptionDataType.DDL Boolean 是 true

是否訂閱DDL類型的數據，取值：

  • true：是，為默認值。
  • false：否。
SubscriptionDataType.DML Boolean 是 true

是否訂閱DML類型的數據，取值：

  • true：是，為默認值。
  • false：否。
SubscriptionObject String 是 [{ "DBName": "dtstestdata" }]

訂閱對象，格式為JSON串且支持一定的正則表達式，詳細說明，請參見訂閱對象配置說明。

SubscriptionInstanceId String 是 dtshp8n2ze4r5x****

數據訂閱實例ID，可以通過調用DescribeSubscriptionInstances接口查詢。

RegionId String 否 cn-hangzhou

數據訂閱實例所在地域的ID，詳情請參見支持的地域列表。

SubscriptionInstanceName String 否 MySQL訂閱

訂閱實例名稱。

說明 建議配置具有業務意義的名稱（無唯一性要求），便于后續識別。
SourceEndpoint.InstanceType String 否 RDS

源數據庫的實例類型，取值：

  • RDS：RDS MySQL。
  • PolarDB：PolarDB MySQL。
  • LocalInstance：有公網IP的自建數據庫。
  • ECS：ECS上的自建數據庫。
  • Express：通過專線接入的自建數據庫。
  • CEN：通過云企業網CEN接入的自建數據庫。
  • dg：通過數據庫網關接入的自建數據庫。
說明 支持自建數據庫的數據庫類型為MySQL、Oracle，您需要提前調用CreateSubscriptionInstance設置。
SourceEndpoint.InstanceID String 否 rm-bp1zc3iyqe3qw****

源實例ID。

說明 源數據庫的實例類型為RDS MySQL、PolarDB-X 1.0、PolarDB MySQL時，本參數才可用且必須傳入。
SourceEndpoint.IP String 否 172.16.88.***

源數據庫的連接地址。

說明 當源數據庫為自建數據庫時，本參數才可用且必須傳入。
SourceEndpoint.Port String 否 3306

源數據庫的服務端口。

說明 當源數據庫為自建數據庫時，本參數才可用且必須傳入。
SourceEndpoint.UserName String 否 dtstestaccount

源實例的數據庫賬號。

說明 訂閱不同的數據庫所需的權限有所差異，詳情請參見DTS數據訂閱方案概覽中對應的配置案例。
SourceEndpoint.Password String 否 Test123456

源實例的數據庫賬號密碼。
SourceEndpoint.OracleSID String 否 testsid

Oracle數據庫的SID信息。

說明 當源數據庫為自建Oracle時，且Oracle數據庫為非RAC實例時，本參數才可用且必須傳入。
SourceEndpoint.DatabaseName String 否 dtstestdata

待訂閱的數據庫名稱。
SourceEndpoint.OwnerID String 否 140692647406****

源實例所屬的阿里云賬號ID。

說明 僅在配置跨阿里云賬號的數據訂閱時本參數才可用，且必須傳入。
SourceEndpoint.Role String 否 ram-for-dts

源實例的授權角色。當源實例與配置訂閱任務所屬阿里云賬號不同時，需傳入該參數，來指定源實例的授權角色，以允許配置訂閱任務所屬阿里云賬號訪問源實例的實例信息。

說明 角色所需的權限及授權方式，請參見跨阿里云賬號數據遷移或同步時如何配置RAM授權。
SubscriptionInstanceNetworkType String 否 vpc

訂閱實例的網絡類型，目前取值僅支持vpc，表示專有網絡。

說明
  • 如果傳入了本參數，則訂閱實例被定義為新版，您還需要正確設置SubscriptionInstance.VPCId和SubscriptionInstance.VSwitchID參數；如果不傳入該參數，則訂閱實例被定義為舊版。
  • 舊版訂閱實例支持訂閱自建MySQL、RDS for MySQL和DRDS的數據，新版訂閱實例支持訂閱自建MySQL、RDS for MySQL、PolarDB MySQL和Oracle的數據。
SubscriptionInstance.VPCId String 否 vpc-bp1vwnn14rqpyiczj****

訂閱實例的專有網絡ID。

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

訂閱實例的虛擬交換機ID。

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

阿里云主賬號ID，無需設置，該參數即將下線。

返回數據

名稱 類型 示例值 描述
ErrCode String InternalError

調用出錯時返回的錯誤碼。
ErrMessage String The request processing has failed due to some unknown error.

調用錯誤時返回的錯誤信息。
RequestId String 0CC15092-8957-4532-B559-B4FB80AC****

請求ID。
Success String true

請求是否成功。

示例

請求示例

http(s)://dts.aliyuncs.com/?Action=ConfigureSubscriptionInstance
&SubscriptionDataType.DDL=true
&SubscriptionDataType.DML=true
&SubscriptionInstanceId=dtshp8n2ze4r5x****
&SubscriptionObject=[{"DBName":"dtstestdata","TableIncludes":[{"TableName":"customer"}]}]
&<公共請求參數>

正常返回示例

XML格式 

<ConfigureSubscriptionInstanceResponse>
      <RequestId>0CC15092-8957-4532-B559-B4FB80AC****</RequestId>
      <Success>true</Success>
</ConfigureSubscriptionInstanceResponse>

JSON格式 

{
	"RequestId": "0CC15092-8957-4532-B559-B4FB80AC****",
	"Success": true
}

錯誤碼

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