ALIYUN::DTS::SubscriptionJob2类型用于配置订阅通道。
语法
{
"Type": "ALIYUN::DTS::SubscriptionJob2",
"Properties": {
"Status": String,
"Reserve": Map,
"DelayPhone": String,
"DedicatedClusterId": String,
"ErrorNotice": Boolean,
"DtsJobName": String,
"DelayRuleTime": Integer,
"DtsInstanceId": String,
"DbList": Map,
"DtsBisLabel": String,
"SubscriptionDataType": Map,
"Checkpoint": String,
"DelayNotice": Boolean,
"DtsJobId": String,
"SubscriptionInstance": Map,
"SourceEndpoint": Map,
"ErrorPhone": String
}
}属性
属性名称 | 类型 | 必须 | 允许更新 | 描述 | 约束 |
Status | String | 否 | 是 | 资源的状态。 | 取值：
|
Reserve | Map | 否 | 否 | DTS的保留参数。 | 通过指定此参数，可以向DTS任务添加源实例或目标实例的更多配置。 例如，指定目的Kafka数据库的数据存储格式和CEN实例的ID。 |
DelayPhone | String | 否 | 否 | 延迟报警的联系人手机号码。 | 多个手机号码以英文逗号（,）分隔。 说明
|
DedicatedClusterId | String | 否 | 否 | DTS专属集群ID。 | 用于将订阅任务调度到指定的DTS专属集群上。 |
ErrorNotice | Boolean | 否 | 否 | 是否监控异常状态。 | 取值：
|
DtsJobName | String | 是 | 是 | 订阅任务名称。 | 建议配置具有业务意义的名称（无唯一性要求），便于后续识别。 |
DelayRuleTime | Integer | 否 | 否 | 触发延迟报警的阈值。 | 单位为秒且需为整数，可根据业务需要设置阈值，建议设置10秒以上，避免因网络、数据库负载等原因导致的延迟波动。 说明 当DelayNotice取值为true时，本参数必须传入。 |
DtsInstanceId | String | 否 | 否 | 订阅实例ID。 | 无 |
DbList | Map | 是 | 是 | 订阅对象。 | 格式为JSON串。更多信息，请参见迁移、同步或订阅对象说明。 |
DtsBisLabel | String | 否 | 否 | DTS实例的环境标签。 | 取值：
|
SubscriptionDataType | Map | 否 | 是 | 订阅数据类型。 | 更多信息，请参见SubscriptionDataType属性。 |
Checkpoint | String | 否 | 否 | 增量数据迁移的启动位点或者同步位点。 | 格式为Unix时间戳，单位为秒。 |
DelayNotice | Boolean | 否 | 否 | 是否监控延迟状态。 | 取值：
|
DtsJobId | String | 否 | 否 | 数据订阅任务ID。 | 无 |
SubscriptionInstance | Map | 是 | 否 | 订阅实例配置。 | 更多信息，请参见SubscriptionInstance属性。 |
SourceEndpoint | Map | 是 | 是 | 源实例配置。 | 更多信息，请参见SourceEndpoint属性。 |
ErrorPhone | String | 否 | 否 | 异常报警的联系人手机号码。 | 多个手机号码以英文逗号（,）分隔。 说明
|
SubscriptionDataType语法
"SubscriptionDataType": {
"DML": Boolean,
"DDL": Boolean
}SubscriptionDataType属性
属性名称 | 类型 | 必须 | 允许更新 | 描述 | 约束 |
DML | Boolean | 否 | 是 | 是否订阅DML类型的数据。 | 取值：
|
DDL | Boolean | 否 | 是 | 是否订阅DDL类型的数据。 | 取值：
|
SubscriptionInstance语法
"SubscriptionInstance": {
"VPCId": String,
"NetworkType": String,
"VSwitchId": String
}SubscriptionInstance属性
属性名称 | 类型 | 必须 | 允许更新 | 描述 | 约束 |
VPCId | String | 否 | 否 | 订阅实例的专有网络ID。 | 当NetworkType取值为VPC时，本参数才可用且必须传入。 |
NetworkType | String | 是 | 否 | 订阅实例的网络类型。 | 取值：VPC，表示专有网络。
|
VSwitchId | String | 否 | 否 | 订阅实例的虚拟交换机ID。 | 当NetworkType取值为VPC时，本参数才可用且必须传入。 |
SourceEndpoint语法
"SourceEndpoint": {
"OracleSID": String,
"UserName": String,
"InstanceID": String,
"IP": String,
"Port": String,
"VSwitchID": String,
"DatabaseName": String,
"EngineName": String,
"Role": String,
"OwnerID": String,
"Region": String,
"InstanceType": String,
"Password": String
}SourceEndpoint属性
属性名称 | 类型 | 必须 | 允许更新 | 描述 | 约束 |
OracleSID | String | 否 | 否 | Oracle数据库的SID信息。 | 当EngineName取值为Oracle，且Oracle数据库为非RAC实例时，本参数才可用且必须传入。 |
UserName | String | 否 | 否 | 源库的数据库账号。 | 迁移不同的数据库所需的权限有所差异，请参见迁移方案概览中对应的配置案例。 |
InstanceID | String | 否 | 否 | 源库的实例ID。 | 取值：
|
IP | String | 否 | 否 | 源库的连接地址。 | 当InstanceType取值为LocalInstance或Express时，本参数才可用且必须传入。 |
Port | String | 否 | 否 | 源库的服务端口。 | 当InstanceType取值为ECS、LocalInstance或Express时，本参数才可用且必须传入。 |
VSwitchID | String | 否 | 否 | 用于数据传输链路的vSwitch的ID。 | 无 |
DatabaseName | String | 否 | 否 | 待迁移的数据库名称或鉴权数据库名称。 |
|
EngineName | String | 否 | 否 | 源库的数据库类型。 | 取值：
说明 当InstanceType取值为RDS、PolarDB、ECS、LocalInstance或Express时，本参数才可用且必须传入。 |
Role | String | 否 | 否 | 指定源实例的授权角色。 | 当源实例与目标实例所属阿里云账号不同时，需传入该参数，来指定源实例的授权角色，以允许目标实例阿里云账号访问源实例的实例信息。 说明 角色所需的权限及授权方式，请参见跨阿里云账号任务如何配置RAM授权。 |
OwnerID | String | 否 | 否 | 源实例所属的阿里云账号ID。 | 仅在配置跨阿里云账号的数据迁移时本参数才可用，且必须传入。 |
Region | String | 否 | 否 | 源库所属的地域ID。 | 当InstanceType取值为LocalInstance时，您可以传入cn-hangzhou或者离自建数据库地理距离最近的地域ID，详情请参见支持的地域列表。 |
InstanceType | String | 否 | 否 | 源库的实例类型。 | 取值：
|
Password | String | 否 | 是 | 源库数据库账号的密码。 | 无 |
返回值
Fn::GetAtt
DtsJobId：任务ID。
DtsJobName：DTS作业的名称。
DtsInstanceId：DTS实例的ID。