调用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
  • 支持自建数据库的数据库类型为MySQL、Oracle,您需要提前调用CreateSubscriptionInstance设置。
SourceEndpoint.InstanceID String rm-bp1zc3iyqe3qw****

源实例ID。

说明 源数据库的实例类型为RDS MySQL、PolarDB-X 1.0、PolarDB MySQL时,本参数才可用且必须传入。
SourceEndpoint.IP String 172.16.88.***

源库的连接地址。

说明 当源数据库的实例类型为自建MySQL、自建Oracle时,本参数才可用且必须传入。
SourceEndpoint.Port String 3306

源库的服务端口。

说明 当源数据库的实例类型为自建MySQL、自建Oracle时,本参数才可用且必须传入。
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

订阅实例的网络类型,取值:

  • classic:经典网络。
  • vpc:专有网络。
说明
  • 如果传入了本参数,则订阅实例被定义为新版,如果不传入该参数,则订阅实例被定义为旧版。
  • 旧版订阅实例支持订阅自建MySQL、RDS for MySQL和DRDS的数据,新版订阅实例支持订阅自建MySQL、RDS for MySQL、PolarDB MySQL和Oracle的数据。
  • 如果本参数传入的值为vpc时,您还需要传入SubscriptionInstance.VPCIdSubscriptionInstance.VSwitchID参数。
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
}

错误码

访问错误中心查看更多错误码。