調用ConfigureSubscriptionInstance配置訂閱執行個體-Data Transmission Service-阿里雲

調用本介面前，已調用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串且支援一定的Regex，詳細說明，請參見訂閱對象配置說明。
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
}

錯誤碼

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