Class: TencentCloud::Dts::V20211206::DescribeSubscribeDetailResponse

Inherits:
Common::AbstractModel
  • Object
show all
Defined in:
lib/v20211206/models.rb

Overview

DescribeSubscribeDetail返回参数结构体

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(subscribeid = nil, subscribename = nil, product = nil, instanceid = nil, instancestatus = nil, status = nil, subsstatus = nil, modifytime = nil, createtime = nil, isolatetime = nil, expiretime = nil, offlinetime = nil, paytype = nil, autorenewflag = nil, region = nil, topic = nil, broker = nil, subscribemode = nil, protocol = nil, subscribeobjects = nil, kafkaconfig = nil, kafkaversion = nil, accesstype = nil, endpoints = nil, pipelineinfo = nil, tags = nil, errors = nil, extraattr = nil, subscribeversion = nil, consumervpcid = nil, consumersubnetid = nil, instanceclass = nil, requestid = nil) ⇒ DescribeSubscribeDetailResponse

Returns a new instance of DescribeSubscribeDetailResponse.



3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
# File 'lib/v20211206/models.rb', line 3021

def initialize(subscribeid=nil, subscribename=nil, product=nil, instanceid=nil, instancestatus=nil, status=nil, subsstatus=nil, modifytime=nil, createtime=nil, isolatetime=nil, expiretime=nil, offlinetime=nil, paytype=nil, autorenewflag=nil, region=nil, topic=nil, broker=nil, subscribemode=nil, protocol=nil, subscribeobjects=nil, kafkaconfig=nil, kafkaversion=nil, accesstype=nil, endpoints=nil, pipelineinfo=nil, tags=nil, errors=nil, extraattr=nil, subscribeversion=nil, consumervpcid=nil, consumersubnetid=nil, instanceclass=nil, requestid=nil)
  @SubscribeId = subscribeid
  @SubscribeName = subscribename
  @Product = product
  @InstanceId = instanceid
  @InstanceStatus = instancestatus
  @Status = status
  @SubsStatus = subsstatus
  @ModifyTime = modifytime
  @CreateTime = createtime
  @IsolateTime = isolatetime
  @ExpireTime = expiretime
  @OfflineTime = offlinetime
  @PayType = paytype
  @AutoRenewFlag = autorenewflag
  @Region = region
  @Topic = topic
  @Broker = broker
  @SubscribeMode = subscribemode
  @Protocol = protocol
  @SubscribeObjects = subscribeobjects
  @KafkaConfig = kafkaconfig
  @KafkaVersion = kafkaversion
  @AccessType = accesstype
  @Endpoints = endpoints
  @PipelineInfo = pipelineinfo
  @Tags = tags
  @Errors = errors
  @ExtraAttr = extraattr
  @SubscribeVersion = subscribeversion
  @ConsumerVpcId = consumervpcid
  @ConsumerSubnetId = consumersubnetid
  @InstanceClass = instanceclass
  @RequestId = requestid
end

Instance Attribute Details

#AccessTypeObject

注意:此字段可能返回 null,表示取不到有效值。 mysql选填参数:ProcessXA-是否处理XA事务,为true处理,其他不处理。 mongo选填参数:SubscribeType-订阅类型,目前只支持changeStream。

Parameters:

  • SubscribeId:

    数据订阅的ID,形如subs-b6x64o31tm

  • SubscribeName:

    数据订阅实例的名称

  • Product:

    订阅的数据库类型,目前支持 cynosdbmysql(tdsql-c mysql版),mariadb,mongodb,mysql,percona,tdpg(tdsql postgresql版),tdsqlpercona(tdsql mysql版)

  • InstanceId:

    订阅的云数据库实例ID,只有订阅云数据库该值才有意义

  • InstanceStatus:

    订阅的云数据库实例状态,只有订阅云数据库该值才有意义。可能值为:running, isolated, offline

  • Status:

    订阅任务计费状态,可能值为:正常normal, 隔离中isolating, 已隔离isolated, 下线中offlining, 按量转包年包月中 post2PrePayIng

  • SubsStatus:

    订阅任务状态,可能值为:未启动notStarted, 校验中checking, 校验不通过checkNotPass, 校验通过checkPass, 启动中starting, 运行中running, 异常出错error

  • ModifyTime:

    修改时间,时间格式如:Y-m-d h:m:s

  • CreateTime:

    创建时间,时间格式如:Y-m-d h:m:s

  • IsolateTime:

    隔离时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • ExpireTime:

    包年包月任务的到期时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • OfflineTime:

    下线时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • PayType:

    付费方式,可能值为:0-包年包月,1-按量计费

  • AutoRenewFlag:

    自动续费标识。只有当 PayType=0,该值才有意义。枚举值:0-不自动续费,1-自动续费

  • Region:

    任务所在地域

  • Topic:

    Kafka topic

  • Broker:

    Kafka服务Broker地址

  • SubscribeMode:

    数据订阅的类型,当 Product 不为 mongodb 时,可能值为:all-全实例更新;dml-数据更新;ddl-结构更新;dmlAndDdl-数据更新+结构更新。当 Product 为 mongodb 时,可能值为 all-全实例更新;database-订阅单库;collection-订阅单集合

  • Protocol:

    订阅数据格式。如果为空则用的默认格式: mysql\cynosdbmysql\mariadb\percona\tdsqlpercona\tdpg是protobuf,mongo是json。当 DatabaseType 为 mysql和cynosdbmysql 时有三种可选协议:protobuf\avro\json。数据格式详情参考官网的消费demo文档

  • SubscribeObjects:

    订阅的数据库表信息

  • KafkaConfig:

    kafka配置信息

  • KafkaVersion:

    订阅内置kafka的版本信息

  • AccessType:

    源数据库接入类型,如:extranet(公网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、cdb(云数据库)、cvm(云服务器自建)、intranet(自研上云)、vpc(私有网络vpc)。注意具体可选值依赖当前链路支持能力

  • Endpoints:

    接入类型信息

  • PipelineInfo:

    mongo输出聚合设置

  • Tags:

    标签

  • Errors:

    订阅任务报错信息

  • ExtraAttr:

    为业务添加的额外信息。参数名作key,参数值作value。

  • SubscribeVersion:

    数据订阅版本, 当前支持kafka和kafkaPro(专业版)

  • ConsumerVpcId:

    消费端地址所在vpc

  • ConsumerSubnetId:

    消费端地址所在子网

  • InstanceClass:

    订阅实例规格

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



3019
3020
3021
# File 'lib/v20211206/models.rb', line 3019

def AccessType
  @AccessType
end

#AutoRenewFlagObject

注意:此字段可能返回 null,表示取不到有效值。 mysql选填参数:ProcessXA-是否处理XA事务,为true处理,其他不处理。 mongo选填参数:SubscribeType-订阅类型,目前只支持changeStream。

Parameters:

  • SubscribeId:

    数据订阅的ID,形如subs-b6x64o31tm

  • SubscribeName:

    数据订阅实例的名称

  • Product:

    订阅的数据库类型,目前支持 cynosdbmysql(tdsql-c mysql版),mariadb,mongodb,mysql,percona,tdpg(tdsql postgresql版),tdsqlpercona(tdsql mysql版)

  • InstanceId:

    订阅的云数据库实例ID,只有订阅云数据库该值才有意义

  • InstanceStatus:

    订阅的云数据库实例状态,只有订阅云数据库该值才有意义。可能值为:running, isolated, offline

  • Status:

    订阅任务计费状态,可能值为:正常normal, 隔离中isolating, 已隔离isolated, 下线中offlining, 按量转包年包月中 post2PrePayIng

  • SubsStatus:

    订阅任务状态,可能值为:未启动notStarted, 校验中checking, 校验不通过checkNotPass, 校验通过checkPass, 启动中starting, 运行中running, 异常出错error

  • ModifyTime:

    修改时间,时间格式如:Y-m-d h:m:s

  • CreateTime:

    创建时间,时间格式如:Y-m-d h:m:s

  • IsolateTime:

    隔离时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • ExpireTime:

    包年包月任务的到期时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • OfflineTime:

    下线时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • PayType:

    付费方式,可能值为:0-包年包月,1-按量计费

  • AutoRenewFlag:

    自动续费标识。只有当 PayType=0,该值才有意义。枚举值:0-不自动续费,1-自动续费

  • Region:

    任务所在地域

  • Topic:

    Kafka topic

  • Broker:

    Kafka服务Broker地址

  • SubscribeMode:

    数据订阅的类型,当 Product 不为 mongodb 时,可能值为:all-全实例更新;dml-数据更新;ddl-结构更新;dmlAndDdl-数据更新+结构更新。当 Product 为 mongodb 时,可能值为 all-全实例更新;database-订阅单库;collection-订阅单集合

  • Protocol:

    订阅数据格式。如果为空则用的默认格式: mysql\cynosdbmysql\mariadb\percona\tdsqlpercona\tdpg是protobuf,mongo是json。当 DatabaseType 为 mysql和cynosdbmysql 时有三种可选协议:protobuf\avro\json。数据格式详情参考官网的消费demo文档

  • SubscribeObjects:

    订阅的数据库表信息

  • KafkaConfig:

    kafka配置信息

  • KafkaVersion:

    订阅内置kafka的版本信息

  • AccessType:

    源数据库接入类型,如:extranet(公网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、cdb(云数据库)、cvm(云服务器自建)、intranet(自研上云)、vpc(私有网络vpc)。注意具体可选值依赖当前链路支持能力

  • Endpoints:

    接入类型信息

  • PipelineInfo:

    mongo输出聚合设置

  • Tags:

    标签

  • Errors:

    订阅任务报错信息

  • ExtraAttr:

    为业务添加的额外信息。参数名作key,参数值作value。

  • SubscribeVersion:

    数据订阅版本, 当前支持kafka和kafkaPro(专业版)

  • ConsumerVpcId:

    消费端地址所在vpc

  • ConsumerSubnetId:

    消费端地址所在子网

  • InstanceClass:

    订阅实例规格

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



3019
3020
3021
# File 'lib/v20211206/models.rb', line 3019

def AutoRenewFlag
  @AutoRenewFlag
end

#BrokerObject

注意:此字段可能返回 null,表示取不到有效值。 mysql选填参数:ProcessXA-是否处理XA事务,为true处理,其他不处理。 mongo选填参数:SubscribeType-订阅类型,目前只支持changeStream。

Parameters:

  • SubscribeId:

    数据订阅的ID,形如subs-b6x64o31tm

  • SubscribeName:

    数据订阅实例的名称

  • Product:

    订阅的数据库类型,目前支持 cynosdbmysql(tdsql-c mysql版),mariadb,mongodb,mysql,percona,tdpg(tdsql postgresql版),tdsqlpercona(tdsql mysql版)

  • InstanceId:

    订阅的云数据库实例ID,只有订阅云数据库该值才有意义

  • InstanceStatus:

    订阅的云数据库实例状态,只有订阅云数据库该值才有意义。可能值为:running, isolated, offline

  • Status:

    订阅任务计费状态,可能值为:正常normal, 隔离中isolating, 已隔离isolated, 下线中offlining, 按量转包年包月中 post2PrePayIng

  • SubsStatus:

    订阅任务状态,可能值为:未启动notStarted, 校验中checking, 校验不通过checkNotPass, 校验通过checkPass, 启动中starting, 运行中running, 异常出错error

  • ModifyTime:

    修改时间,时间格式如:Y-m-d h:m:s

  • CreateTime:

    创建时间,时间格式如:Y-m-d h:m:s

  • IsolateTime:

    隔离时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • ExpireTime:

    包年包月任务的到期时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • OfflineTime:

    下线时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • PayType:

    付费方式,可能值为:0-包年包月,1-按量计费

  • AutoRenewFlag:

    自动续费标识。只有当 PayType=0,该值才有意义。枚举值:0-不自动续费,1-自动续费

  • Region:

    任务所在地域

  • Topic:

    Kafka topic

  • Broker:

    Kafka服务Broker地址

  • SubscribeMode:

    数据订阅的类型,当 Product 不为 mongodb 时,可能值为:all-全实例更新;dml-数据更新;ddl-结构更新;dmlAndDdl-数据更新+结构更新。当 Product 为 mongodb 时,可能值为 all-全实例更新;database-订阅单库;collection-订阅单集合

  • Protocol:

    订阅数据格式。如果为空则用的默认格式: mysql\cynosdbmysql\mariadb\percona\tdsqlpercona\tdpg是protobuf,mongo是json。当 DatabaseType 为 mysql和cynosdbmysql 时有三种可选协议:protobuf\avro\json。数据格式详情参考官网的消费demo文档

  • SubscribeObjects:

    订阅的数据库表信息

  • KafkaConfig:

    kafka配置信息

  • KafkaVersion:

    订阅内置kafka的版本信息

  • AccessType:

    源数据库接入类型,如:extranet(公网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、cdb(云数据库)、cvm(云服务器自建)、intranet(自研上云)、vpc(私有网络vpc)。注意具体可选值依赖当前链路支持能力

  • Endpoints:

    接入类型信息

  • PipelineInfo:

    mongo输出聚合设置

  • Tags:

    标签

  • Errors:

    订阅任务报错信息

  • ExtraAttr:

    为业务添加的额外信息。参数名作key,参数值作value。

  • SubscribeVersion:

    数据订阅版本, 当前支持kafka和kafkaPro(专业版)

  • ConsumerVpcId:

    消费端地址所在vpc

  • ConsumerSubnetId:

    消费端地址所在子网

  • InstanceClass:

    订阅实例规格

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



3019
3020
3021
# File 'lib/v20211206/models.rb', line 3019

def Broker
  @Broker
end

#ConsumerSubnetIdObject

注意:此字段可能返回 null,表示取不到有效值。 mysql选填参数:ProcessXA-是否处理XA事务,为true处理,其他不处理。 mongo选填参数:SubscribeType-订阅类型,目前只支持changeStream。

Parameters:

  • SubscribeId:

    数据订阅的ID,形如subs-b6x64o31tm

  • SubscribeName:

    数据订阅实例的名称

  • Product:

    订阅的数据库类型,目前支持 cynosdbmysql(tdsql-c mysql版),mariadb,mongodb,mysql,percona,tdpg(tdsql postgresql版),tdsqlpercona(tdsql mysql版)

  • InstanceId:

    订阅的云数据库实例ID,只有订阅云数据库该值才有意义

  • InstanceStatus:

    订阅的云数据库实例状态,只有订阅云数据库该值才有意义。可能值为:running, isolated, offline

  • Status:

    订阅任务计费状态,可能值为:正常normal, 隔离中isolating, 已隔离isolated, 下线中offlining, 按量转包年包月中 post2PrePayIng

  • SubsStatus:

    订阅任务状态,可能值为:未启动notStarted, 校验中checking, 校验不通过checkNotPass, 校验通过checkPass, 启动中starting, 运行中running, 异常出错error

  • ModifyTime:

    修改时间,时间格式如:Y-m-d h:m:s

  • CreateTime:

    创建时间,时间格式如:Y-m-d h:m:s

  • IsolateTime:

    隔离时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • ExpireTime:

    包年包月任务的到期时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • OfflineTime:

    下线时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • PayType:

    付费方式,可能值为:0-包年包月,1-按量计费

  • AutoRenewFlag:

    自动续费标识。只有当 PayType=0,该值才有意义。枚举值:0-不自动续费,1-自动续费

  • Region:

    任务所在地域

  • Topic:

    Kafka topic

  • Broker:

    Kafka服务Broker地址

  • SubscribeMode:

    数据订阅的类型,当 Product 不为 mongodb 时,可能值为:all-全实例更新;dml-数据更新;ddl-结构更新;dmlAndDdl-数据更新+结构更新。当 Product 为 mongodb 时,可能值为 all-全实例更新;database-订阅单库;collection-订阅单集合

  • Protocol:

    订阅数据格式。如果为空则用的默认格式: mysql\cynosdbmysql\mariadb\percona\tdsqlpercona\tdpg是protobuf,mongo是json。当 DatabaseType 为 mysql和cynosdbmysql 时有三种可选协议:protobuf\avro\json。数据格式详情参考官网的消费demo文档

  • SubscribeObjects:

    订阅的数据库表信息

  • KafkaConfig:

    kafka配置信息

  • KafkaVersion:

    订阅内置kafka的版本信息

  • AccessType:

    源数据库接入类型,如:extranet(公网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、cdb(云数据库)、cvm(云服务器自建)、intranet(自研上云)、vpc(私有网络vpc)。注意具体可选值依赖当前链路支持能力

  • Endpoints:

    接入类型信息

  • PipelineInfo:

    mongo输出聚合设置

  • Tags:

    标签

  • Errors:

    订阅任务报错信息

  • ExtraAttr:

    为业务添加的额外信息。参数名作key,参数值作value。

  • SubscribeVersion:

    数据订阅版本, 当前支持kafka和kafkaPro(专业版)

  • ConsumerVpcId:

    消费端地址所在vpc

  • ConsumerSubnetId:

    消费端地址所在子网

  • InstanceClass:

    订阅实例规格

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



3019
3020
3021
# File 'lib/v20211206/models.rb', line 3019

def ConsumerSubnetId
  @ConsumerSubnetId
end

#ConsumerVpcIdObject

注意:此字段可能返回 null,表示取不到有效值。 mysql选填参数:ProcessXA-是否处理XA事务,为true处理,其他不处理。 mongo选填参数:SubscribeType-订阅类型,目前只支持changeStream。

Parameters:

  • SubscribeId:

    数据订阅的ID,形如subs-b6x64o31tm

  • SubscribeName:

    数据订阅实例的名称

  • Product:

    订阅的数据库类型,目前支持 cynosdbmysql(tdsql-c mysql版),mariadb,mongodb,mysql,percona,tdpg(tdsql postgresql版),tdsqlpercona(tdsql mysql版)

  • InstanceId:

    订阅的云数据库实例ID,只有订阅云数据库该值才有意义

  • InstanceStatus:

    订阅的云数据库实例状态,只有订阅云数据库该值才有意义。可能值为:running, isolated, offline

  • Status:

    订阅任务计费状态,可能值为:正常normal, 隔离中isolating, 已隔离isolated, 下线中offlining, 按量转包年包月中 post2PrePayIng

  • SubsStatus:

    订阅任务状态,可能值为:未启动notStarted, 校验中checking, 校验不通过checkNotPass, 校验通过checkPass, 启动中starting, 运行中running, 异常出错error

  • ModifyTime:

    修改时间,时间格式如:Y-m-d h:m:s

  • CreateTime:

    创建时间,时间格式如:Y-m-d h:m:s

  • IsolateTime:

    隔离时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • ExpireTime:

    包年包月任务的到期时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • OfflineTime:

    下线时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • PayType:

    付费方式,可能值为:0-包年包月,1-按量计费

  • AutoRenewFlag:

    自动续费标识。只有当 PayType=0,该值才有意义。枚举值:0-不自动续费,1-自动续费

  • Region:

    任务所在地域

  • Topic:

    Kafka topic

  • Broker:

    Kafka服务Broker地址

  • SubscribeMode:

    数据订阅的类型,当 Product 不为 mongodb 时,可能值为:all-全实例更新;dml-数据更新;ddl-结构更新;dmlAndDdl-数据更新+结构更新。当 Product 为 mongodb 时,可能值为 all-全实例更新;database-订阅单库;collection-订阅单集合

  • Protocol:

    订阅数据格式。如果为空则用的默认格式: mysql\cynosdbmysql\mariadb\percona\tdsqlpercona\tdpg是protobuf,mongo是json。当 DatabaseType 为 mysql和cynosdbmysql 时有三种可选协议:protobuf\avro\json。数据格式详情参考官网的消费demo文档

  • SubscribeObjects:

    订阅的数据库表信息

  • KafkaConfig:

    kafka配置信息

  • KafkaVersion:

    订阅内置kafka的版本信息

  • AccessType:

    源数据库接入类型,如:extranet(公网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、cdb(云数据库)、cvm(云服务器自建)、intranet(自研上云)、vpc(私有网络vpc)。注意具体可选值依赖当前链路支持能力

  • Endpoints:

    接入类型信息

  • PipelineInfo:

    mongo输出聚合设置

  • Tags:

    标签

  • Errors:

    订阅任务报错信息

  • ExtraAttr:

    为业务添加的额外信息。参数名作key,参数值作value。

  • SubscribeVersion:

    数据订阅版本, 当前支持kafka和kafkaPro(专业版)

  • ConsumerVpcId:

    消费端地址所在vpc

  • ConsumerSubnetId:

    消费端地址所在子网

  • InstanceClass:

    订阅实例规格

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



3019
3020
3021
# File 'lib/v20211206/models.rb', line 3019

def ConsumerVpcId
  @ConsumerVpcId
end

#CreateTimeObject

注意:此字段可能返回 null,表示取不到有效值。 mysql选填参数:ProcessXA-是否处理XA事务,为true处理,其他不处理。 mongo选填参数:SubscribeType-订阅类型,目前只支持changeStream。

Parameters:

  • SubscribeId:

    数据订阅的ID,形如subs-b6x64o31tm

  • SubscribeName:

    数据订阅实例的名称

  • Product:

    订阅的数据库类型,目前支持 cynosdbmysql(tdsql-c mysql版),mariadb,mongodb,mysql,percona,tdpg(tdsql postgresql版),tdsqlpercona(tdsql mysql版)

  • InstanceId:

    订阅的云数据库实例ID,只有订阅云数据库该值才有意义

  • InstanceStatus:

    订阅的云数据库实例状态,只有订阅云数据库该值才有意义。可能值为:running, isolated, offline

  • Status:

    订阅任务计费状态,可能值为:正常normal, 隔离中isolating, 已隔离isolated, 下线中offlining, 按量转包年包月中 post2PrePayIng

  • SubsStatus:

    订阅任务状态,可能值为:未启动notStarted, 校验中checking, 校验不通过checkNotPass, 校验通过checkPass, 启动中starting, 运行中running, 异常出错error

  • ModifyTime:

    修改时间,时间格式如:Y-m-d h:m:s

  • CreateTime:

    创建时间,时间格式如:Y-m-d h:m:s

  • IsolateTime:

    隔离时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • ExpireTime:

    包年包月任务的到期时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • OfflineTime:

    下线时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • PayType:

    付费方式,可能值为:0-包年包月,1-按量计费

  • AutoRenewFlag:

    自动续费标识。只有当 PayType=0,该值才有意义。枚举值:0-不自动续费,1-自动续费

  • Region:

    任务所在地域

  • Topic:

    Kafka topic

  • Broker:

    Kafka服务Broker地址

  • SubscribeMode:

    数据订阅的类型,当 Product 不为 mongodb 时,可能值为:all-全实例更新;dml-数据更新;ddl-结构更新;dmlAndDdl-数据更新+结构更新。当 Product 为 mongodb 时,可能值为 all-全实例更新;database-订阅单库;collection-订阅单集合

  • Protocol:

    订阅数据格式。如果为空则用的默认格式: mysql\cynosdbmysql\mariadb\percona\tdsqlpercona\tdpg是protobuf,mongo是json。当 DatabaseType 为 mysql和cynosdbmysql 时有三种可选协议:protobuf\avro\json。数据格式详情参考官网的消费demo文档

  • SubscribeObjects:

    订阅的数据库表信息

  • KafkaConfig:

    kafka配置信息

  • KafkaVersion:

    订阅内置kafka的版本信息

  • AccessType:

    源数据库接入类型,如:extranet(公网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、cdb(云数据库)、cvm(云服务器自建)、intranet(自研上云)、vpc(私有网络vpc)。注意具体可选值依赖当前链路支持能力

  • Endpoints:

    接入类型信息

  • PipelineInfo:

    mongo输出聚合设置

  • Tags:

    标签

  • Errors:

    订阅任务报错信息

  • ExtraAttr:

    为业务添加的额外信息。参数名作key,参数值作value。

  • SubscribeVersion:

    数据订阅版本, 当前支持kafka和kafkaPro(专业版)

  • ConsumerVpcId:

    消费端地址所在vpc

  • ConsumerSubnetId:

    消费端地址所在子网

  • InstanceClass:

    订阅实例规格

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



3019
3020
3021
# File 'lib/v20211206/models.rb', line 3019

def CreateTime
  @CreateTime
end

#EndpointsObject

注意:此字段可能返回 null,表示取不到有效值。 mysql选填参数:ProcessXA-是否处理XA事务,为true处理,其他不处理。 mongo选填参数:SubscribeType-订阅类型,目前只支持changeStream。

Parameters:

  • SubscribeId:

    数据订阅的ID,形如subs-b6x64o31tm

  • SubscribeName:

    数据订阅实例的名称

  • Product:

    订阅的数据库类型,目前支持 cynosdbmysql(tdsql-c mysql版),mariadb,mongodb,mysql,percona,tdpg(tdsql postgresql版),tdsqlpercona(tdsql mysql版)

  • InstanceId:

    订阅的云数据库实例ID,只有订阅云数据库该值才有意义

  • InstanceStatus:

    订阅的云数据库实例状态,只有订阅云数据库该值才有意义。可能值为:running, isolated, offline

  • Status:

    订阅任务计费状态,可能值为:正常normal, 隔离中isolating, 已隔离isolated, 下线中offlining, 按量转包年包月中 post2PrePayIng

  • SubsStatus:

    订阅任务状态,可能值为:未启动notStarted, 校验中checking, 校验不通过checkNotPass, 校验通过checkPass, 启动中starting, 运行中running, 异常出错error

  • ModifyTime:

    修改时间,时间格式如:Y-m-d h:m:s

  • CreateTime:

    创建时间,时间格式如:Y-m-d h:m:s

  • IsolateTime:

    隔离时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • ExpireTime:

    包年包月任务的到期时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • OfflineTime:

    下线时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • PayType:

    付费方式,可能值为:0-包年包月,1-按量计费

  • AutoRenewFlag:

    自动续费标识。只有当 PayType=0,该值才有意义。枚举值:0-不自动续费,1-自动续费

  • Region:

    任务所在地域

  • Topic:

    Kafka topic

  • Broker:

    Kafka服务Broker地址

  • SubscribeMode:

    数据订阅的类型,当 Product 不为 mongodb 时,可能值为:all-全实例更新;dml-数据更新;ddl-结构更新;dmlAndDdl-数据更新+结构更新。当 Product 为 mongodb 时,可能值为 all-全实例更新;database-订阅单库;collection-订阅单集合

  • Protocol:

    订阅数据格式。如果为空则用的默认格式: mysql\cynosdbmysql\mariadb\percona\tdsqlpercona\tdpg是protobuf,mongo是json。当 DatabaseType 为 mysql和cynosdbmysql 时有三种可选协议:protobuf\avro\json。数据格式详情参考官网的消费demo文档

  • SubscribeObjects:

    订阅的数据库表信息

  • KafkaConfig:

    kafka配置信息

  • KafkaVersion:

    订阅内置kafka的版本信息

  • AccessType:

    源数据库接入类型,如:extranet(公网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、cdb(云数据库)、cvm(云服务器自建)、intranet(自研上云)、vpc(私有网络vpc)。注意具体可选值依赖当前链路支持能力

  • Endpoints:

    接入类型信息

  • PipelineInfo:

    mongo输出聚合设置

  • Tags:

    标签

  • Errors:

    订阅任务报错信息

  • ExtraAttr:

    为业务添加的额外信息。参数名作key,参数值作value。

  • SubscribeVersion:

    数据订阅版本, 当前支持kafka和kafkaPro(专业版)

  • ConsumerVpcId:

    消费端地址所在vpc

  • ConsumerSubnetId:

    消费端地址所在子网

  • InstanceClass:

    订阅实例规格

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



3019
3020
3021
# File 'lib/v20211206/models.rb', line 3019

def Endpoints
  @Endpoints
end

#ErrorsObject

注意:此字段可能返回 null,表示取不到有效值。 mysql选填参数:ProcessXA-是否处理XA事务,为true处理,其他不处理。 mongo选填参数:SubscribeType-订阅类型,目前只支持changeStream。

Parameters:

  • SubscribeId:

    数据订阅的ID,形如subs-b6x64o31tm

  • SubscribeName:

    数据订阅实例的名称

  • Product:

    订阅的数据库类型,目前支持 cynosdbmysql(tdsql-c mysql版),mariadb,mongodb,mysql,percona,tdpg(tdsql postgresql版),tdsqlpercona(tdsql mysql版)

  • InstanceId:

    订阅的云数据库实例ID,只有订阅云数据库该值才有意义

  • InstanceStatus:

    订阅的云数据库实例状态,只有订阅云数据库该值才有意义。可能值为:running, isolated, offline

  • Status:

    订阅任务计费状态,可能值为:正常normal, 隔离中isolating, 已隔离isolated, 下线中offlining, 按量转包年包月中 post2PrePayIng

  • SubsStatus:

    订阅任务状态,可能值为:未启动notStarted, 校验中checking, 校验不通过checkNotPass, 校验通过checkPass, 启动中starting, 运行中running, 异常出错error

  • ModifyTime:

    修改时间,时间格式如:Y-m-d h:m:s

  • CreateTime:

    创建时间,时间格式如:Y-m-d h:m:s

  • IsolateTime:

    隔离时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • ExpireTime:

    包年包月任务的到期时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • OfflineTime:

    下线时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • PayType:

    付费方式,可能值为:0-包年包月,1-按量计费

  • AutoRenewFlag:

    自动续费标识。只有当 PayType=0,该值才有意义。枚举值:0-不自动续费,1-自动续费

  • Region:

    任务所在地域

  • Topic:

    Kafka topic

  • Broker:

    Kafka服务Broker地址

  • SubscribeMode:

    数据订阅的类型,当 Product 不为 mongodb 时,可能值为:all-全实例更新;dml-数据更新;ddl-结构更新;dmlAndDdl-数据更新+结构更新。当 Product 为 mongodb 时,可能值为 all-全实例更新;database-订阅单库;collection-订阅单集合

  • Protocol:

    订阅数据格式。如果为空则用的默认格式: mysql\cynosdbmysql\mariadb\percona\tdsqlpercona\tdpg是protobuf,mongo是json。当 DatabaseType 为 mysql和cynosdbmysql 时有三种可选协议:protobuf\avro\json。数据格式详情参考官网的消费demo文档

  • SubscribeObjects:

    订阅的数据库表信息

  • KafkaConfig:

    kafka配置信息

  • KafkaVersion:

    订阅内置kafka的版本信息

  • AccessType:

    源数据库接入类型,如:extranet(公网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、cdb(云数据库)、cvm(云服务器自建)、intranet(自研上云)、vpc(私有网络vpc)。注意具体可选值依赖当前链路支持能力

  • Endpoints:

    接入类型信息

  • PipelineInfo:

    mongo输出聚合设置

  • Tags:

    标签

  • Errors:

    订阅任务报错信息

  • ExtraAttr:

    为业务添加的额外信息。参数名作key,参数值作value。

  • SubscribeVersion:

    数据订阅版本, 当前支持kafka和kafkaPro(专业版)

  • ConsumerVpcId:

    消费端地址所在vpc

  • ConsumerSubnetId:

    消费端地址所在子网

  • InstanceClass:

    订阅实例规格

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



3019
3020
3021
# File 'lib/v20211206/models.rb', line 3019

def Errors
  @Errors
end

#ExpireTimeObject

注意:此字段可能返回 null,表示取不到有效值。 mysql选填参数:ProcessXA-是否处理XA事务,为true处理,其他不处理。 mongo选填参数:SubscribeType-订阅类型,目前只支持changeStream。

Parameters:

  • SubscribeId:

    数据订阅的ID,形如subs-b6x64o31tm

  • SubscribeName:

    数据订阅实例的名称

  • Product:

    订阅的数据库类型,目前支持 cynosdbmysql(tdsql-c mysql版),mariadb,mongodb,mysql,percona,tdpg(tdsql postgresql版),tdsqlpercona(tdsql mysql版)

  • InstanceId:

    订阅的云数据库实例ID,只有订阅云数据库该值才有意义

  • InstanceStatus:

    订阅的云数据库实例状态,只有订阅云数据库该值才有意义。可能值为:running, isolated, offline

  • Status:

    订阅任务计费状态,可能值为:正常normal, 隔离中isolating, 已隔离isolated, 下线中offlining, 按量转包年包月中 post2PrePayIng

  • SubsStatus:

    订阅任务状态,可能值为:未启动notStarted, 校验中checking, 校验不通过checkNotPass, 校验通过checkPass, 启动中starting, 运行中running, 异常出错error

  • ModifyTime:

    修改时间,时间格式如:Y-m-d h:m:s

  • CreateTime:

    创建时间,时间格式如:Y-m-d h:m:s

  • IsolateTime:

    隔离时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • ExpireTime:

    包年包月任务的到期时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • OfflineTime:

    下线时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • PayType:

    付费方式,可能值为:0-包年包月,1-按量计费

  • AutoRenewFlag:

    自动续费标识。只有当 PayType=0,该值才有意义。枚举值:0-不自动续费,1-自动续费

  • Region:

    任务所在地域

  • Topic:

    Kafka topic

  • Broker:

    Kafka服务Broker地址

  • SubscribeMode:

    数据订阅的类型,当 Product 不为 mongodb 时,可能值为:all-全实例更新;dml-数据更新;ddl-结构更新;dmlAndDdl-数据更新+结构更新。当 Product 为 mongodb 时,可能值为 all-全实例更新;database-订阅单库;collection-订阅单集合

  • Protocol:

    订阅数据格式。如果为空则用的默认格式: mysql\cynosdbmysql\mariadb\percona\tdsqlpercona\tdpg是protobuf,mongo是json。当 DatabaseType 为 mysql和cynosdbmysql 时有三种可选协议:protobuf\avro\json。数据格式详情参考官网的消费demo文档

  • SubscribeObjects:

    订阅的数据库表信息

  • KafkaConfig:

    kafka配置信息

  • KafkaVersion:

    订阅内置kafka的版本信息

  • AccessType:

    源数据库接入类型,如:extranet(公网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、cdb(云数据库)、cvm(云服务器自建)、intranet(自研上云)、vpc(私有网络vpc)。注意具体可选值依赖当前链路支持能力

  • Endpoints:

    接入类型信息

  • PipelineInfo:

    mongo输出聚合设置

  • Tags:

    标签

  • Errors:

    订阅任务报错信息

  • ExtraAttr:

    为业务添加的额外信息。参数名作key,参数值作value。

  • SubscribeVersion:

    数据订阅版本, 当前支持kafka和kafkaPro(专业版)

  • ConsumerVpcId:

    消费端地址所在vpc

  • ConsumerSubnetId:

    消费端地址所在子网

  • InstanceClass:

    订阅实例规格

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



3019
3020
3021
# File 'lib/v20211206/models.rb', line 3019

def ExpireTime
  @ExpireTime
end

#ExtraAttrObject

注意:此字段可能返回 null,表示取不到有效值。 mysql选填参数:ProcessXA-是否处理XA事务,为true处理,其他不处理。 mongo选填参数:SubscribeType-订阅类型,目前只支持changeStream。

Parameters:

  • SubscribeId:

    数据订阅的ID,形如subs-b6x64o31tm

  • SubscribeName:

    数据订阅实例的名称

  • Product:

    订阅的数据库类型,目前支持 cynosdbmysql(tdsql-c mysql版),mariadb,mongodb,mysql,percona,tdpg(tdsql postgresql版),tdsqlpercona(tdsql mysql版)

  • InstanceId:

    订阅的云数据库实例ID,只有订阅云数据库该值才有意义

  • InstanceStatus:

    订阅的云数据库实例状态,只有订阅云数据库该值才有意义。可能值为:running, isolated, offline

  • Status:

    订阅任务计费状态,可能值为:正常normal, 隔离中isolating, 已隔离isolated, 下线中offlining, 按量转包年包月中 post2PrePayIng

  • SubsStatus:

    订阅任务状态,可能值为:未启动notStarted, 校验中checking, 校验不通过checkNotPass, 校验通过checkPass, 启动中starting, 运行中running, 异常出错error

  • ModifyTime:

    修改时间,时间格式如:Y-m-d h:m:s

  • CreateTime:

    创建时间,时间格式如:Y-m-d h:m:s

  • IsolateTime:

    隔离时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • ExpireTime:

    包年包月任务的到期时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • OfflineTime:

    下线时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • PayType:

    付费方式,可能值为:0-包年包月,1-按量计费

  • AutoRenewFlag:

    自动续费标识。只有当 PayType=0,该值才有意义。枚举值:0-不自动续费,1-自动续费

  • Region:

    任务所在地域

  • Topic:

    Kafka topic

  • Broker:

    Kafka服务Broker地址

  • SubscribeMode:

    数据订阅的类型,当 Product 不为 mongodb 时,可能值为:all-全实例更新;dml-数据更新;ddl-结构更新;dmlAndDdl-数据更新+结构更新。当 Product 为 mongodb 时,可能值为 all-全实例更新;database-订阅单库;collection-订阅单集合

  • Protocol:

    订阅数据格式。如果为空则用的默认格式: mysql\cynosdbmysql\mariadb\percona\tdsqlpercona\tdpg是protobuf,mongo是json。当 DatabaseType 为 mysql和cynosdbmysql 时有三种可选协议:protobuf\avro\json。数据格式详情参考官网的消费demo文档

  • SubscribeObjects:

    订阅的数据库表信息

  • KafkaConfig:

    kafka配置信息

  • KafkaVersion:

    订阅内置kafka的版本信息

  • AccessType:

    源数据库接入类型,如:extranet(公网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、cdb(云数据库)、cvm(云服务器自建)、intranet(自研上云)、vpc(私有网络vpc)。注意具体可选值依赖当前链路支持能力

  • Endpoints:

    接入类型信息

  • PipelineInfo:

    mongo输出聚合设置

  • Tags:

    标签

  • Errors:

    订阅任务报错信息

  • ExtraAttr:

    为业务添加的额外信息。参数名作key,参数值作value。

  • SubscribeVersion:

    数据订阅版本, 当前支持kafka和kafkaPro(专业版)

  • ConsumerVpcId:

    消费端地址所在vpc

  • ConsumerSubnetId:

    消费端地址所在子网

  • InstanceClass:

    订阅实例规格

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



3019
3020
3021
# File 'lib/v20211206/models.rb', line 3019

def ExtraAttr
  @ExtraAttr
end

#InstanceClassObject

注意:此字段可能返回 null,表示取不到有效值。 mysql选填参数:ProcessXA-是否处理XA事务,为true处理,其他不处理。 mongo选填参数:SubscribeType-订阅类型,目前只支持changeStream。

Parameters:

  • SubscribeId:

    数据订阅的ID,形如subs-b6x64o31tm

  • SubscribeName:

    数据订阅实例的名称

  • Product:

    订阅的数据库类型,目前支持 cynosdbmysql(tdsql-c mysql版),mariadb,mongodb,mysql,percona,tdpg(tdsql postgresql版),tdsqlpercona(tdsql mysql版)

  • InstanceId:

    订阅的云数据库实例ID,只有订阅云数据库该值才有意义

  • InstanceStatus:

    订阅的云数据库实例状态,只有订阅云数据库该值才有意义。可能值为:running, isolated, offline

  • Status:

    订阅任务计费状态,可能值为:正常normal, 隔离中isolating, 已隔离isolated, 下线中offlining, 按量转包年包月中 post2PrePayIng

  • SubsStatus:

    订阅任务状态,可能值为:未启动notStarted, 校验中checking, 校验不通过checkNotPass, 校验通过checkPass, 启动中starting, 运行中running, 异常出错error

  • ModifyTime:

    修改时间,时间格式如:Y-m-d h:m:s

  • CreateTime:

    创建时间,时间格式如:Y-m-d h:m:s

  • IsolateTime:

    隔离时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • ExpireTime:

    包年包月任务的到期时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • OfflineTime:

    下线时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • PayType:

    付费方式,可能值为:0-包年包月,1-按量计费

  • AutoRenewFlag:

    自动续费标识。只有当 PayType=0,该值才有意义。枚举值:0-不自动续费,1-自动续费

  • Region:

    任务所在地域

  • Topic:

    Kafka topic

  • Broker:

    Kafka服务Broker地址

  • SubscribeMode:

    数据订阅的类型,当 Product 不为 mongodb 时,可能值为:all-全实例更新;dml-数据更新;ddl-结构更新;dmlAndDdl-数据更新+结构更新。当 Product 为 mongodb 时,可能值为 all-全实例更新;database-订阅单库;collection-订阅单集合

  • Protocol:

    订阅数据格式。如果为空则用的默认格式: mysql\cynosdbmysql\mariadb\percona\tdsqlpercona\tdpg是protobuf,mongo是json。当 DatabaseType 为 mysql和cynosdbmysql 时有三种可选协议:protobuf\avro\json。数据格式详情参考官网的消费demo文档

  • SubscribeObjects:

    订阅的数据库表信息

  • KafkaConfig:

    kafka配置信息

  • KafkaVersion:

    订阅内置kafka的版本信息

  • AccessType:

    源数据库接入类型,如:extranet(公网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、cdb(云数据库)、cvm(云服务器自建)、intranet(自研上云)、vpc(私有网络vpc)。注意具体可选值依赖当前链路支持能力

  • Endpoints:

    接入类型信息

  • PipelineInfo:

    mongo输出聚合设置

  • Tags:

    标签

  • Errors:

    订阅任务报错信息

  • ExtraAttr:

    为业务添加的额外信息。参数名作key,参数值作value。

  • SubscribeVersion:

    数据订阅版本, 当前支持kafka和kafkaPro(专业版)

  • ConsumerVpcId:

    消费端地址所在vpc

  • ConsumerSubnetId:

    消费端地址所在子网

  • InstanceClass:

    订阅实例规格

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



3019
3020
3021
# File 'lib/v20211206/models.rb', line 3019

def InstanceClass
  @InstanceClass
end

#InstanceIdObject

注意:此字段可能返回 null,表示取不到有效值。 mysql选填参数:ProcessXA-是否处理XA事务,为true处理,其他不处理。 mongo选填参数:SubscribeType-订阅类型,目前只支持changeStream。

Parameters:

  • SubscribeId:

    数据订阅的ID,形如subs-b6x64o31tm

  • SubscribeName:

    数据订阅实例的名称

  • Product:

    订阅的数据库类型,目前支持 cynosdbmysql(tdsql-c mysql版),mariadb,mongodb,mysql,percona,tdpg(tdsql postgresql版),tdsqlpercona(tdsql mysql版)

  • InstanceId:

    订阅的云数据库实例ID,只有订阅云数据库该值才有意义

  • InstanceStatus:

    订阅的云数据库实例状态,只有订阅云数据库该值才有意义。可能值为:running, isolated, offline

  • Status:

    订阅任务计费状态,可能值为:正常normal, 隔离中isolating, 已隔离isolated, 下线中offlining, 按量转包年包月中 post2PrePayIng

  • SubsStatus:

    订阅任务状态,可能值为:未启动notStarted, 校验中checking, 校验不通过checkNotPass, 校验通过checkPass, 启动中starting, 运行中running, 异常出错error

  • ModifyTime:

    修改时间,时间格式如:Y-m-d h:m:s

  • CreateTime:

    创建时间,时间格式如:Y-m-d h:m:s

  • IsolateTime:

    隔离时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • ExpireTime:

    包年包月任务的到期时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • OfflineTime:

    下线时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • PayType:

    付费方式,可能值为:0-包年包月,1-按量计费

  • AutoRenewFlag:

    自动续费标识。只有当 PayType=0,该值才有意义。枚举值:0-不自动续费,1-自动续费

  • Region:

    任务所在地域

  • Topic:

    Kafka topic

  • Broker:

    Kafka服务Broker地址

  • SubscribeMode:

    数据订阅的类型,当 Product 不为 mongodb 时,可能值为:all-全实例更新;dml-数据更新;ddl-结构更新;dmlAndDdl-数据更新+结构更新。当 Product 为 mongodb 时,可能值为 all-全实例更新;database-订阅单库;collection-订阅单集合

  • Protocol:

    订阅数据格式。如果为空则用的默认格式: mysql\cynosdbmysql\mariadb\percona\tdsqlpercona\tdpg是protobuf,mongo是json。当 DatabaseType 为 mysql和cynosdbmysql 时有三种可选协议:protobuf\avro\json。数据格式详情参考官网的消费demo文档

  • SubscribeObjects:

    订阅的数据库表信息

  • KafkaConfig:

    kafka配置信息

  • KafkaVersion:

    订阅内置kafka的版本信息

  • AccessType:

    源数据库接入类型,如:extranet(公网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、cdb(云数据库)、cvm(云服务器自建)、intranet(自研上云)、vpc(私有网络vpc)。注意具体可选值依赖当前链路支持能力

  • Endpoints:

    接入类型信息

  • PipelineInfo:

    mongo输出聚合设置

  • Tags:

    标签

  • Errors:

    订阅任务报错信息

  • ExtraAttr:

    为业务添加的额外信息。参数名作key,参数值作value。

  • SubscribeVersion:

    数据订阅版本, 当前支持kafka和kafkaPro(专业版)

  • ConsumerVpcId:

    消费端地址所在vpc

  • ConsumerSubnetId:

    消费端地址所在子网

  • InstanceClass:

    订阅实例规格

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



3019
3020
3021
# File 'lib/v20211206/models.rb', line 3019

def InstanceId
  @InstanceId
end

#InstanceStatusObject

注意:此字段可能返回 null,表示取不到有效值。 mysql选填参数:ProcessXA-是否处理XA事务,为true处理,其他不处理。 mongo选填参数:SubscribeType-订阅类型,目前只支持changeStream。

Parameters:

  • SubscribeId:

    数据订阅的ID,形如subs-b6x64o31tm

  • SubscribeName:

    数据订阅实例的名称

  • Product:

    订阅的数据库类型,目前支持 cynosdbmysql(tdsql-c mysql版),mariadb,mongodb,mysql,percona,tdpg(tdsql postgresql版),tdsqlpercona(tdsql mysql版)

  • InstanceId:

    订阅的云数据库实例ID,只有订阅云数据库该值才有意义

  • InstanceStatus:

    订阅的云数据库实例状态,只有订阅云数据库该值才有意义。可能值为:running, isolated, offline

  • Status:

    订阅任务计费状态,可能值为:正常normal, 隔离中isolating, 已隔离isolated, 下线中offlining, 按量转包年包月中 post2PrePayIng

  • SubsStatus:

    订阅任务状态,可能值为:未启动notStarted, 校验中checking, 校验不通过checkNotPass, 校验通过checkPass, 启动中starting, 运行中running, 异常出错error

  • ModifyTime:

    修改时间,时间格式如:Y-m-d h:m:s

  • CreateTime:

    创建时间,时间格式如:Y-m-d h:m:s

  • IsolateTime:

    隔离时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • ExpireTime:

    包年包月任务的到期时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • OfflineTime:

    下线时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • PayType:

    付费方式,可能值为:0-包年包月,1-按量计费

  • AutoRenewFlag:

    自动续费标识。只有当 PayType=0,该值才有意义。枚举值:0-不自动续费,1-自动续费

  • Region:

    任务所在地域

  • Topic:

    Kafka topic

  • Broker:

    Kafka服务Broker地址

  • SubscribeMode:

    数据订阅的类型,当 Product 不为 mongodb 时,可能值为:all-全实例更新;dml-数据更新;ddl-结构更新;dmlAndDdl-数据更新+结构更新。当 Product 为 mongodb 时,可能值为 all-全实例更新;database-订阅单库;collection-订阅单集合

  • Protocol:

    订阅数据格式。如果为空则用的默认格式: mysql\cynosdbmysql\mariadb\percona\tdsqlpercona\tdpg是protobuf,mongo是json。当 DatabaseType 为 mysql和cynosdbmysql 时有三种可选协议:protobuf\avro\json。数据格式详情参考官网的消费demo文档

  • SubscribeObjects:

    订阅的数据库表信息

  • KafkaConfig:

    kafka配置信息

  • KafkaVersion:

    订阅内置kafka的版本信息

  • AccessType:

    源数据库接入类型,如:extranet(公网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、cdb(云数据库)、cvm(云服务器自建)、intranet(自研上云)、vpc(私有网络vpc)。注意具体可选值依赖当前链路支持能力

  • Endpoints:

    接入类型信息

  • PipelineInfo:

    mongo输出聚合设置

  • Tags:

    标签

  • Errors:

    订阅任务报错信息

  • ExtraAttr:

    为业务添加的额外信息。参数名作key,参数值作value。

  • SubscribeVersion:

    数据订阅版本, 当前支持kafka和kafkaPro(专业版)

  • ConsumerVpcId:

    消费端地址所在vpc

  • ConsumerSubnetId:

    消费端地址所在子网

  • InstanceClass:

    订阅实例规格

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



3019
3020
3021
# File 'lib/v20211206/models.rb', line 3019

def InstanceStatus
  @InstanceStatus
end

#IsolateTimeObject

注意:此字段可能返回 null,表示取不到有效值。 mysql选填参数:ProcessXA-是否处理XA事务,为true处理,其他不处理。 mongo选填参数:SubscribeType-订阅类型,目前只支持changeStream。

Parameters:

  • SubscribeId:

    数据订阅的ID,形如subs-b6x64o31tm

  • SubscribeName:

    数据订阅实例的名称

  • Product:

    订阅的数据库类型,目前支持 cynosdbmysql(tdsql-c mysql版),mariadb,mongodb,mysql,percona,tdpg(tdsql postgresql版),tdsqlpercona(tdsql mysql版)

  • InstanceId:

    订阅的云数据库实例ID,只有订阅云数据库该值才有意义

  • InstanceStatus:

    订阅的云数据库实例状态,只有订阅云数据库该值才有意义。可能值为:running, isolated, offline

  • Status:

    订阅任务计费状态,可能值为:正常normal, 隔离中isolating, 已隔离isolated, 下线中offlining, 按量转包年包月中 post2PrePayIng

  • SubsStatus:

    订阅任务状态,可能值为:未启动notStarted, 校验中checking, 校验不通过checkNotPass, 校验通过checkPass, 启动中starting, 运行中running, 异常出错error

  • ModifyTime:

    修改时间,时间格式如:Y-m-d h:m:s

  • CreateTime:

    创建时间,时间格式如:Y-m-d h:m:s

  • IsolateTime:

    隔离时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • ExpireTime:

    包年包月任务的到期时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • OfflineTime:

    下线时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • PayType:

    付费方式,可能值为:0-包年包月,1-按量计费

  • AutoRenewFlag:

    自动续费标识。只有当 PayType=0,该值才有意义。枚举值:0-不自动续费,1-自动续费

  • Region:

    任务所在地域

  • Topic:

    Kafka topic

  • Broker:

    Kafka服务Broker地址

  • SubscribeMode:

    数据订阅的类型,当 Product 不为 mongodb 时,可能值为:all-全实例更新;dml-数据更新;ddl-结构更新;dmlAndDdl-数据更新+结构更新。当 Product 为 mongodb 时,可能值为 all-全实例更新;database-订阅单库;collection-订阅单集合

  • Protocol:

    订阅数据格式。如果为空则用的默认格式: mysql\cynosdbmysql\mariadb\percona\tdsqlpercona\tdpg是protobuf,mongo是json。当 DatabaseType 为 mysql和cynosdbmysql 时有三种可选协议:protobuf\avro\json。数据格式详情参考官网的消费demo文档

  • SubscribeObjects:

    订阅的数据库表信息

  • KafkaConfig:

    kafka配置信息

  • KafkaVersion:

    订阅内置kafka的版本信息

  • AccessType:

    源数据库接入类型,如:extranet(公网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、cdb(云数据库)、cvm(云服务器自建)、intranet(自研上云)、vpc(私有网络vpc)。注意具体可选值依赖当前链路支持能力

  • Endpoints:

    接入类型信息

  • PipelineInfo:

    mongo输出聚合设置

  • Tags:

    标签

  • Errors:

    订阅任务报错信息

  • ExtraAttr:

    为业务添加的额外信息。参数名作key,参数值作value。

  • SubscribeVersion:

    数据订阅版本, 当前支持kafka和kafkaPro(专业版)

  • ConsumerVpcId:

    消费端地址所在vpc

  • ConsumerSubnetId:

    消费端地址所在子网

  • InstanceClass:

    订阅实例规格

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



3019
3020
3021
# File 'lib/v20211206/models.rb', line 3019

def IsolateTime
  @IsolateTime
end

#KafkaConfigObject

注意:此字段可能返回 null,表示取不到有效值。 mysql选填参数:ProcessXA-是否处理XA事务,为true处理,其他不处理。 mongo选填参数:SubscribeType-订阅类型,目前只支持changeStream。

Parameters:

  • SubscribeId:

    数据订阅的ID,形如subs-b6x64o31tm

  • SubscribeName:

    数据订阅实例的名称

  • Product:

    订阅的数据库类型,目前支持 cynosdbmysql(tdsql-c mysql版),mariadb,mongodb,mysql,percona,tdpg(tdsql postgresql版),tdsqlpercona(tdsql mysql版)

  • InstanceId:

    订阅的云数据库实例ID,只有订阅云数据库该值才有意义

  • InstanceStatus:

    订阅的云数据库实例状态,只有订阅云数据库该值才有意义。可能值为:running, isolated, offline

  • Status:

    订阅任务计费状态,可能值为:正常normal, 隔离中isolating, 已隔离isolated, 下线中offlining, 按量转包年包月中 post2PrePayIng

  • SubsStatus:

    订阅任务状态,可能值为:未启动notStarted, 校验中checking, 校验不通过checkNotPass, 校验通过checkPass, 启动中starting, 运行中running, 异常出错error

  • ModifyTime:

    修改时间,时间格式如:Y-m-d h:m:s

  • CreateTime:

    创建时间,时间格式如:Y-m-d h:m:s

  • IsolateTime:

    隔离时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • ExpireTime:

    包年包月任务的到期时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • OfflineTime:

    下线时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • PayType:

    付费方式,可能值为:0-包年包月,1-按量计费

  • AutoRenewFlag:

    自动续费标识。只有当 PayType=0,该值才有意义。枚举值:0-不自动续费,1-自动续费

  • Region:

    任务所在地域

  • Topic:

    Kafka topic

  • Broker:

    Kafka服务Broker地址

  • SubscribeMode:

    数据订阅的类型,当 Product 不为 mongodb 时,可能值为:all-全实例更新;dml-数据更新;ddl-结构更新;dmlAndDdl-数据更新+结构更新。当 Product 为 mongodb 时,可能值为 all-全实例更新;database-订阅单库;collection-订阅单集合

  • Protocol:

    订阅数据格式。如果为空则用的默认格式: mysql\cynosdbmysql\mariadb\percona\tdsqlpercona\tdpg是protobuf,mongo是json。当 DatabaseType 为 mysql和cynosdbmysql 时有三种可选协议:protobuf\avro\json。数据格式详情参考官网的消费demo文档

  • SubscribeObjects:

    订阅的数据库表信息

  • KafkaConfig:

    kafka配置信息

  • KafkaVersion:

    订阅内置kafka的版本信息

  • AccessType:

    源数据库接入类型,如:extranet(公网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、cdb(云数据库)、cvm(云服务器自建)、intranet(自研上云)、vpc(私有网络vpc)。注意具体可选值依赖当前链路支持能力

  • Endpoints:

    接入类型信息

  • PipelineInfo:

    mongo输出聚合设置

  • Tags:

    标签

  • Errors:

    订阅任务报错信息

  • ExtraAttr:

    为业务添加的额外信息。参数名作key,参数值作value。

  • SubscribeVersion:

    数据订阅版本, 当前支持kafka和kafkaPro(专业版)

  • ConsumerVpcId:

    消费端地址所在vpc

  • ConsumerSubnetId:

    消费端地址所在子网

  • InstanceClass:

    订阅实例规格

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



3019
3020
3021
# File 'lib/v20211206/models.rb', line 3019

def KafkaConfig
  @KafkaConfig
end

#KafkaVersionObject

注意:此字段可能返回 null,表示取不到有效值。 mysql选填参数:ProcessXA-是否处理XA事务,为true处理,其他不处理。 mongo选填参数:SubscribeType-订阅类型,目前只支持changeStream。

Parameters:

  • SubscribeId:

    数据订阅的ID,形如subs-b6x64o31tm

  • SubscribeName:

    数据订阅实例的名称

  • Product:

    订阅的数据库类型,目前支持 cynosdbmysql(tdsql-c mysql版),mariadb,mongodb,mysql,percona,tdpg(tdsql postgresql版),tdsqlpercona(tdsql mysql版)

  • InstanceId:

    订阅的云数据库实例ID,只有订阅云数据库该值才有意义

  • InstanceStatus:

    订阅的云数据库实例状态,只有订阅云数据库该值才有意义。可能值为:running, isolated, offline

  • Status:

    订阅任务计费状态,可能值为:正常normal, 隔离中isolating, 已隔离isolated, 下线中offlining, 按量转包年包月中 post2PrePayIng

  • SubsStatus:

    订阅任务状态,可能值为:未启动notStarted, 校验中checking, 校验不通过checkNotPass, 校验通过checkPass, 启动中starting, 运行中running, 异常出错error

  • ModifyTime:

    修改时间,时间格式如:Y-m-d h:m:s

  • CreateTime:

    创建时间,时间格式如:Y-m-d h:m:s

  • IsolateTime:

    隔离时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • ExpireTime:

    包年包月任务的到期时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • OfflineTime:

    下线时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • PayType:

    付费方式,可能值为:0-包年包月,1-按量计费

  • AutoRenewFlag:

    自动续费标识。只有当 PayType=0,该值才有意义。枚举值:0-不自动续费,1-自动续费

  • Region:

    任务所在地域

  • Topic:

    Kafka topic

  • Broker:

    Kafka服务Broker地址

  • SubscribeMode:

    数据订阅的类型,当 Product 不为 mongodb 时,可能值为:all-全实例更新;dml-数据更新;ddl-结构更新;dmlAndDdl-数据更新+结构更新。当 Product 为 mongodb 时,可能值为 all-全实例更新;database-订阅单库;collection-订阅单集合

  • Protocol:

    订阅数据格式。如果为空则用的默认格式: mysql\cynosdbmysql\mariadb\percona\tdsqlpercona\tdpg是protobuf,mongo是json。当 DatabaseType 为 mysql和cynosdbmysql 时有三种可选协议:protobuf\avro\json。数据格式详情参考官网的消费demo文档

  • SubscribeObjects:

    订阅的数据库表信息

  • KafkaConfig:

    kafka配置信息

  • KafkaVersion:

    订阅内置kafka的版本信息

  • AccessType:

    源数据库接入类型,如:extranet(公网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、cdb(云数据库)、cvm(云服务器自建)、intranet(自研上云)、vpc(私有网络vpc)。注意具体可选值依赖当前链路支持能力

  • Endpoints:

    接入类型信息

  • PipelineInfo:

    mongo输出聚合设置

  • Tags:

    标签

  • Errors:

    订阅任务报错信息

  • ExtraAttr:

    为业务添加的额外信息。参数名作key,参数值作value。

  • SubscribeVersion:

    数据订阅版本, 当前支持kafka和kafkaPro(专业版)

  • ConsumerVpcId:

    消费端地址所在vpc

  • ConsumerSubnetId:

    消费端地址所在子网

  • InstanceClass:

    订阅实例规格

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



3019
3020
3021
# File 'lib/v20211206/models.rb', line 3019

def KafkaVersion
  @KafkaVersion
end

#ModifyTimeObject

注意:此字段可能返回 null,表示取不到有效值。 mysql选填参数:ProcessXA-是否处理XA事务,为true处理,其他不处理。 mongo选填参数:SubscribeType-订阅类型,目前只支持changeStream。

Parameters:

  • SubscribeId:

    数据订阅的ID,形如subs-b6x64o31tm

  • SubscribeName:

    数据订阅实例的名称

  • Product:

    订阅的数据库类型,目前支持 cynosdbmysql(tdsql-c mysql版),mariadb,mongodb,mysql,percona,tdpg(tdsql postgresql版),tdsqlpercona(tdsql mysql版)

  • InstanceId:

    订阅的云数据库实例ID,只有订阅云数据库该值才有意义

  • InstanceStatus:

    订阅的云数据库实例状态,只有订阅云数据库该值才有意义。可能值为:running, isolated, offline

  • Status:

    订阅任务计费状态,可能值为:正常normal, 隔离中isolating, 已隔离isolated, 下线中offlining, 按量转包年包月中 post2PrePayIng

  • SubsStatus:

    订阅任务状态,可能值为:未启动notStarted, 校验中checking, 校验不通过checkNotPass, 校验通过checkPass, 启动中starting, 运行中running, 异常出错error

  • ModifyTime:

    修改时间,时间格式如:Y-m-d h:m:s

  • CreateTime:

    创建时间,时间格式如:Y-m-d h:m:s

  • IsolateTime:

    隔离时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • ExpireTime:

    包年包月任务的到期时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • OfflineTime:

    下线时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • PayType:

    付费方式,可能值为:0-包年包月,1-按量计费

  • AutoRenewFlag:

    自动续费标识。只有当 PayType=0,该值才有意义。枚举值:0-不自动续费,1-自动续费

  • Region:

    任务所在地域

  • Topic:

    Kafka topic

  • Broker:

    Kafka服务Broker地址

  • SubscribeMode:

    数据订阅的类型,当 Product 不为 mongodb 时,可能值为:all-全实例更新;dml-数据更新;ddl-结构更新;dmlAndDdl-数据更新+结构更新。当 Product 为 mongodb 时,可能值为 all-全实例更新;database-订阅单库;collection-订阅单集合

  • Protocol:

    订阅数据格式。如果为空则用的默认格式: mysql\cynosdbmysql\mariadb\percona\tdsqlpercona\tdpg是protobuf,mongo是json。当 DatabaseType 为 mysql和cynosdbmysql 时有三种可选协议:protobuf\avro\json。数据格式详情参考官网的消费demo文档

  • SubscribeObjects:

    订阅的数据库表信息

  • KafkaConfig:

    kafka配置信息

  • KafkaVersion:

    订阅内置kafka的版本信息

  • AccessType:

    源数据库接入类型,如:extranet(公网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、cdb(云数据库)、cvm(云服务器自建)、intranet(自研上云)、vpc(私有网络vpc)。注意具体可选值依赖当前链路支持能力

  • Endpoints:

    接入类型信息

  • PipelineInfo:

    mongo输出聚合设置

  • Tags:

    标签

  • Errors:

    订阅任务报错信息

  • ExtraAttr:

    为业务添加的额外信息。参数名作key,参数值作value。

  • SubscribeVersion:

    数据订阅版本, 当前支持kafka和kafkaPro(专业版)

  • ConsumerVpcId:

    消费端地址所在vpc

  • ConsumerSubnetId:

    消费端地址所在子网

  • InstanceClass:

    订阅实例规格

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



3019
3020
3021
# File 'lib/v20211206/models.rb', line 3019

def ModifyTime
  @ModifyTime
end

#OfflineTimeObject

注意:此字段可能返回 null,表示取不到有效值。 mysql选填参数:ProcessXA-是否处理XA事务,为true处理,其他不处理。 mongo选填参数:SubscribeType-订阅类型,目前只支持changeStream。

Parameters:

  • SubscribeId:

    数据订阅的ID,形如subs-b6x64o31tm

  • SubscribeName:

    数据订阅实例的名称

  • Product:

    订阅的数据库类型,目前支持 cynosdbmysql(tdsql-c mysql版),mariadb,mongodb,mysql,percona,tdpg(tdsql postgresql版),tdsqlpercona(tdsql mysql版)

  • InstanceId:

    订阅的云数据库实例ID,只有订阅云数据库该值才有意义

  • InstanceStatus:

    订阅的云数据库实例状态,只有订阅云数据库该值才有意义。可能值为:running, isolated, offline

  • Status:

    订阅任务计费状态,可能值为:正常normal, 隔离中isolating, 已隔离isolated, 下线中offlining, 按量转包年包月中 post2PrePayIng

  • SubsStatus:

    订阅任务状态,可能值为:未启动notStarted, 校验中checking, 校验不通过checkNotPass, 校验通过checkPass, 启动中starting, 运行中running, 异常出错error

  • ModifyTime:

    修改时间,时间格式如:Y-m-d h:m:s

  • CreateTime:

    创建时间,时间格式如:Y-m-d h:m:s

  • IsolateTime:

    隔离时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • ExpireTime:

    包年包月任务的到期时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • OfflineTime:

    下线时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • PayType:

    付费方式,可能值为:0-包年包月,1-按量计费

  • AutoRenewFlag:

    自动续费标识。只有当 PayType=0,该值才有意义。枚举值:0-不自动续费,1-自动续费

  • Region:

    任务所在地域

  • Topic:

    Kafka topic

  • Broker:

    Kafka服务Broker地址

  • SubscribeMode:

    数据订阅的类型,当 Product 不为 mongodb 时,可能值为:all-全实例更新;dml-数据更新;ddl-结构更新;dmlAndDdl-数据更新+结构更新。当 Product 为 mongodb 时,可能值为 all-全实例更新;database-订阅单库;collection-订阅单集合

  • Protocol:

    订阅数据格式。如果为空则用的默认格式: mysql\cynosdbmysql\mariadb\percona\tdsqlpercona\tdpg是protobuf,mongo是json。当 DatabaseType 为 mysql和cynosdbmysql 时有三种可选协议:protobuf\avro\json。数据格式详情参考官网的消费demo文档

  • SubscribeObjects:

    订阅的数据库表信息

  • KafkaConfig:

    kafka配置信息

  • KafkaVersion:

    订阅内置kafka的版本信息

  • AccessType:

    源数据库接入类型,如:extranet(公网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、cdb(云数据库)、cvm(云服务器自建)、intranet(自研上云)、vpc(私有网络vpc)。注意具体可选值依赖当前链路支持能力

  • Endpoints:

    接入类型信息

  • PipelineInfo:

    mongo输出聚合设置

  • Tags:

    标签

  • Errors:

    订阅任务报错信息

  • ExtraAttr:

    为业务添加的额外信息。参数名作key,参数值作value。

  • SubscribeVersion:

    数据订阅版本, 当前支持kafka和kafkaPro(专业版)

  • ConsumerVpcId:

    消费端地址所在vpc

  • ConsumerSubnetId:

    消费端地址所在子网

  • InstanceClass:

    订阅实例规格

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



3019
3020
3021
# File 'lib/v20211206/models.rb', line 3019

def OfflineTime
  @OfflineTime
end

#PayTypeObject

注意:此字段可能返回 null,表示取不到有效值。 mysql选填参数:ProcessXA-是否处理XA事务,为true处理,其他不处理。 mongo选填参数:SubscribeType-订阅类型,目前只支持changeStream。

Parameters:

  • SubscribeId:

    数据订阅的ID,形如subs-b6x64o31tm

  • SubscribeName:

    数据订阅实例的名称

  • Product:

    订阅的数据库类型,目前支持 cynosdbmysql(tdsql-c mysql版),mariadb,mongodb,mysql,percona,tdpg(tdsql postgresql版),tdsqlpercona(tdsql mysql版)

  • InstanceId:

    订阅的云数据库实例ID,只有订阅云数据库该值才有意义

  • InstanceStatus:

    订阅的云数据库实例状态,只有订阅云数据库该值才有意义。可能值为:running, isolated, offline

  • Status:

    订阅任务计费状态,可能值为:正常normal, 隔离中isolating, 已隔离isolated, 下线中offlining, 按量转包年包月中 post2PrePayIng

  • SubsStatus:

    订阅任务状态,可能值为:未启动notStarted, 校验中checking, 校验不通过checkNotPass, 校验通过checkPass, 启动中starting, 运行中running, 异常出错error

  • ModifyTime:

    修改时间,时间格式如:Y-m-d h:m:s

  • CreateTime:

    创建时间,时间格式如:Y-m-d h:m:s

  • IsolateTime:

    隔离时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • ExpireTime:

    包年包月任务的到期时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • OfflineTime:

    下线时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • PayType:

    付费方式,可能值为:0-包年包月,1-按量计费

  • AutoRenewFlag:

    自动续费标识。只有当 PayType=0,该值才有意义。枚举值:0-不自动续费,1-自动续费

  • Region:

    任务所在地域

  • Topic:

    Kafka topic

  • Broker:

    Kafka服务Broker地址

  • SubscribeMode:

    数据订阅的类型,当 Product 不为 mongodb 时,可能值为:all-全实例更新;dml-数据更新;ddl-结构更新;dmlAndDdl-数据更新+结构更新。当 Product 为 mongodb 时,可能值为 all-全实例更新;database-订阅单库;collection-订阅单集合

  • Protocol:

    订阅数据格式。如果为空则用的默认格式: mysql\cynosdbmysql\mariadb\percona\tdsqlpercona\tdpg是protobuf,mongo是json。当 DatabaseType 为 mysql和cynosdbmysql 时有三种可选协议:protobuf\avro\json。数据格式详情参考官网的消费demo文档

  • SubscribeObjects:

    订阅的数据库表信息

  • KafkaConfig:

    kafka配置信息

  • KafkaVersion:

    订阅内置kafka的版本信息

  • AccessType:

    源数据库接入类型,如:extranet(公网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、cdb(云数据库)、cvm(云服务器自建)、intranet(自研上云)、vpc(私有网络vpc)。注意具体可选值依赖当前链路支持能力

  • Endpoints:

    接入类型信息

  • PipelineInfo:

    mongo输出聚合设置

  • Tags:

    标签

  • Errors:

    订阅任务报错信息

  • ExtraAttr:

    为业务添加的额外信息。参数名作key,参数值作value。

  • SubscribeVersion:

    数据订阅版本, 当前支持kafka和kafkaPro(专业版)

  • ConsumerVpcId:

    消费端地址所在vpc

  • ConsumerSubnetId:

    消费端地址所在子网

  • InstanceClass:

    订阅实例规格

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



3019
3020
3021
# File 'lib/v20211206/models.rb', line 3019

def PayType
  @PayType
end

#PipelineInfoObject

注意:此字段可能返回 null,表示取不到有效值。 mysql选填参数:ProcessXA-是否处理XA事务,为true处理,其他不处理。 mongo选填参数:SubscribeType-订阅类型,目前只支持changeStream。

Parameters:

  • SubscribeId:

    数据订阅的ID,形如subs-b6x64o31tm

  • SubscribeName:

    数据订阅实例的名称

  • Product:

    订阅的数据库类型,目前支持 cynosdbmysql(tdsql-c mysql版),mariadb,mongodb,mysql,percona,tdpg(tdsql postgresql版),tdsqlpercona(tdsql mysql版)

  • InstanceId:

    订阅的云数据库实例ID,只有订阅云数据库该值才有意义

  • InstanceStatus:

    订阅的云数据库实例状态,只有订阅云数据库该值才有意义。可能值为:running, isolated, offline

  • Status:

    订阅任务计费状态,可能值为:正常normal, 隔离中isolating, 已隔离isolated, 下线中offlining, 按量转包年包月中 post2PrePayIng

  • SubsStatus:

    订阅任务状态,可能值为:未启动notStarted, 校验中checking, 校验不通过checkNotPass, 校验通过checkPass, 启动中starting, 运行中running, 异常出错error

  • ModifyTime:

    修改时间,时间格式如:Y-m-d h:m:s

  • CreateTime:

    创建时间,时间格式如:Y-m-d h:m:s

  • IsolateTime:

    隔离时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • ExpireTime:

    包年包月任务的到期时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • OfflineTime:

    下线时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • PayType:

    付费方式,可能值为:0-包年包月,1-按量计费

  • AutoRenewFlag:

    自动续费标识。只有当 PayType=0,该值才有意义。枚举值:0-不自动续费,1-自动续费

  • Region:

    任务所在地域

  • Topic:

    Kafka topic

  • Broker:

    Kafka服务Broker地址

  • SubscribeMode:

    数据订阅的类型,当 Product 不为 mongodb 时,可能值为:all-全实例更新;dml-数据更新;ddl-结构更新;dmlAndDdl-数据更新+结构更新。当 Product 为 mongodb 时,可能值为 all-全实例更新;database-订阅单库;collection-订阅单集合

  • Protocol:

    订阅数据格式。如果为空则用的默认格式: mysql\cynosdbmysql\mariadb\percona\tdsqlpercona\tdpg是protobuf,mongo是json。当 DatabaseType 为 mysql和cynosdbmysql 时有三种可选协议:protobuf\avro\json。数据格式详情参考官网的消费demo文档

  • SubscribeObjects:

    订阅的数据库表信息

  • KafkaConfig:

    kafka配置信息

  • KafkaVersion:

    订阅内置kafka的版本信息

  • AccessType:

    源数据库接入类型,如:extranet(公网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、cdb(云数据库)、cvm(云服务器自建)、intranet(自研上云)、vpc(私有网络vpc)。注意具体可选值依赖当前链路支持能力

  • Endpoints:

    接入类型信息

  • PipelineInfo:

    mongo输出聚合设置

  • Tags:

    标签

  • Errors:

    订阅任务报错信息

  • ExtraAttr:

    为业务添加的额外信息。参数名作key,参数值作value。

  • SubscribeVersion:

    数据订阅版本, 当前支持kafka和kafkaPro(专业版)

  • ConsumerVpcId:

    消费端地址所在vpc

  • ConsumerSubnetId:

    消费端地址所在子网

  • InstanceClass:

    订阅实例规格

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



3019
3020
3021
# File 'lib/v20211206/models.rb', line 3019

def PipelineInfo
  @PipelineInfo
end

#ProductObject

注意:此字段可能返回 null,表示取不到有效值。 mysql选填参数:ProcessXA-是否处理XA事务,为true处理,其他不处理。 mongo选填参数:SubscribeType-订阅类型,目前只支持changeStream。

Parameters:

  • SubscribeId:

    数据订阅的ID,形如subs-b6x64o31tm

  • SubscribeName:

    数据订阅实例的名称

  • Product:

    订阅的数据库类型,目前支持 cynosdbmysql(tdsql-c mysql版),mariadb,mongodb,mysql,percona,tdpg(tdsql postgresql版),tdsqlpercona(tdsql mysql版)

  • InstanceId:

    订阅的云数据库实例ID,只有订阅云数据库该值才有意义

  • InstanceStatus:

    订阅的云数据库实例状态,只有订阅云数据库该值才有意义。可能值为:running, isolated, offline

  • Status:

    订阅任务计费状态,可能值为:正常normal, 隔离中isolating, 已隔离isolated, 下线中offlining, 按量转包年包月中 post2PrePayIng

  • SubsStatus:

    订阅任务状态,可能值为:未启动notStarted, 校验中checking, 校验不通过checkNotPass, 校验通过checkPass, 启动中starting, 运行中running, 异常出错error

  • ModifyTime:

    修改时间,时间格式如:Y-m-d h:m:s

  • CreateTime:

    创建时间,时间格式如:Y-m-d h:m:s

  • IsolateTime:

    隔离时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • ExpireTime:

    包年包月任务的到期时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • OfflineTime:

    下线时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • PayType:

    付费方式,可能值为:0-包年包月,1-按量计费

  • AutoRenewFlag:

    自动续费标识。只有当 PayType=0,该值才有意义。枚举值:0-不自动续费,1-自动续费

  • Region:

    任务所在地域

  • Topic:

    Kafka topic

  • Broker:

    Kafka服务Broker地址

  • SubscribeMode:

    数据订阅的类型,当 Product 不为 mongodb 时,可能值为:all-全实例更新;dml-数据更新;ddl-结构更新;dmlAndDdl-数据更新+结构更新。当 Product 为 mongodb 时,可能值为 all-全实例更新;database-订阅单库;collection-订阅单集合

  • Protocol:

    订阅数据格式。如果为空则用的默认格式: mysql\cynosdbmysql\mariadb\percona\tdsqlpercona\tdpg是protobuf,mongo是json。当 DatabaseType 为 mysql和cynosdbmysql 时有三种可选协议:protobuf\avro\json。数据格式详情参考官网的消费demo文档

  • SubscribeObjects:

    订阅的数据库表信息

  • KafkaConfig:

    kafka配置信息

  • KafkaVersion:

    订阅内置kafka的版本信息

  • AccessType:

    源数据库接入类型,如:extranet(公网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、cdb(云数据库)、cvm(云服务器自建)、intranet(自研上云)、vpc(私有网络vpc)。注意具体可选值依赖当前链路支持能力

  • Endpoints:

    接入类型信息

  • PipelineInfo:

    mongo输出聚合设置

  • Tags:

    标签

  • Errors:

    订阅任务报错信息

  • ExtraAttr:

    为业务添加的额外信息。参数名作key,参数值作value。

  • SubscribeVersion:

    数据订阅版本, 当前支持kafka和kafkaPro(专业版)

  • ConsumerVpcId:

    消费端地址所在vpc

  • ConsumerSubnetId:

    消费端地址所在子网

  • InstanceClass:

    订阅实例规格

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



3019
3020
3021
# File 'lib/v20211206/models.rb', line 3019

def Product
  @Product
end

#ProtocolObject

注意:此字段可能返回 null,表示取不到有效值。 mysql选填参数:ProcessXA-是否处理XA事务,为true处理,其他不处理。 mongo选填参数:SubscribeType-订阅类型,目前只支持changeStream。

Parameters:

  • SubscribeId:

    数据订阅的ID,形如subs-b6x64o31tm

  • SubscribeName:

    数据订阅实例的名称

  • Product:

    订阅的数据库类型,目前支持 cynosdbmysql(tdsql-c mysql版),mariadb,mongodb,mysql,percona,tdpg(tdsql postgresql版),tdsqlpercona(tdsql mysql版)

  • InstanceId:

    订阅的云数据库实例ID,只有订阅云数据库该值才有意义

  • InstanceStatus:

    订阅的云数据库实例状态,只有订阅云数据库该值才有意义。可能值为:running, isolated, offline

  • Status:

    订阅任务计费状态,可能值为:正常normal, 隔离中isolating, 已隔离isolated, 下线中offlining, 按量转包年包月中 post2PrePayIng

  • SubsStatus:

    订阅任务状态,可能值为:未启动notStarted, 校验中checking, 校验不通过checkNotPass, 校验通过checkPass, 启动中starting, 运行中running, 异常出错error

  • ModifyTime:

    修改时间,时间格式如:Y-m-d h:m:s

  • CreateTime:

    创建时间,时间格式如:Y-m-d h:m:s

  • IsolateTime:

    隔离时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • ExpireTime:

    包年包月任务的到期时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • OfflineTime:

    下线时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • PayType:

    付费方式,可能值为:0-包年包月,1-按量计费

  • AutoRenewFlag:

    自动续费标识。只有当 PayType=0,该值才有意义。枚举值:0-不自动续费,1-自动续费

  • Region:

    任务所在地域

  • Topic:

    Kafka topic

  • Broker:

    Kafka服务Broker地址

  • SubscribeMode:

    数据订阅的类型,当 Product 不为 mongodb 时,可能值为:all-全实例更新;dml-数据更新;ddl-结构更新;dmlAndDdl-数据更新+结构更新。当 Product 为 mongodb 时,可能值为 all-全实例更新;database-订阅单库;collection-订阅单集合

  • Protocol:

    订阅数据格式。如果为空则用的默认格式: mysql\cynosdbmysql\mariadb\percona\tdsqlpercona\tdpg是protobuf,mongo是json。当 DatabaseType 为 mysql和cynosdbmysql 时有三种可选协议:protobuf\avro\json。数据格式详情参考官网的消费demo文档

  • SubscribeObjects:

    订阅的数据库表信息

  • KafkaConfig:

    kafka配置信息

  • KafkaVersion:

    订阅内置kafka的版本信息

  • AccessType:

    源数据库接入类型,如:extranet(公网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、cdb(云数据库)、cvm(云服务器自建)、intranet(自研上云)、vpc(私有网络vpc)。注意具体可选值依赖当前链路支持能力

  • Endpoints:

    接入类型信息

  • PipelineInfo:

    mongo输出聚合设置

  • Tags:

    标签

  • Errors:

    订阅任务报错信息

  • ExtraAttr:

    为业务添加的额外信息。参数名作key,参数值作value。

  • SubscribeVersion:

    数据订阅版本, 当前支持kafka和kafkaPro(专业版)

  • ConsumerVpcId:

    消费端地址所在vpc

  • ConsumerSubnetId:

    消费端地址所在子网

  • InstanceClass:

    订阅实例规格

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



3019
3020
3021
# File 'lib/v20211206/models.rb', line 3019

def Protocol
  @Protocol
end

#RegionObject

注意:此字段可能返回 null,表示取不到有效值。 mysql选填参数:ProcessXA-是否处理XA事务,为true处理,其他不处理。 mongo选填参数:SubscribeType-订阅类型,目前只支持changeStream。

Parameters:

  • SubscribeId:

    数据订阅的ID,形如subs-b6x64o31tm

  • SubscribeName:

    数据订阅实例的名称

  • Product:

    订阅的数据库类型,目前支持 cynosdbmysql(tdsql-c mysql版),mariadb,mongodb,mysql,percona,tdpg(tdsql postgresql版),tdsqlpercona(tdsql mysql版)

  • InstanceId:

    订阅的云数据库实例ID,只有订阅云数据库该值才有意义

  • InstanceStatus:

    订阅的云数据库实例状态,只有订阅云数据库该值才有意义。可能值为:running, isolated, offline

  • Status:

    订阅任务计费状态,可能值为:正常normal, 隔离中isolating, 已隔离isolated, 下线中offlining, 按量转包年包月中 post2PrePayIng

  • SubsStatus:

    订阅任务状态,可能值为:未启动notStarted, 校验中checking, 校验不通过checkNotPass, 校验通过checkPass, 启动中starting, 运行中running, 异常出错error

  • ModifyTime:

    修改时间,时间格式如:Y-m-d h:m:s

  • CreateTime:

    创建时间,时间格式如:Y-m-d h:m:s

  • IsolateTime:

    隔离时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • ExpireTime:

    包年包月任务的到期时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • OfflineTime:

    下线时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • PayType:

    付费方式,可能值为:0-包年包月,1-按量计费

  • AutoRenewFlag:

    自动续费标识。只有当 PayType=0,该值才有意义。枚举值:0-不自动续费,1-自动续费

  • Region:

    任务所在地域

  • Topic:

    Kafka topic

  • Broker:

    Kafka服务Broker地址

  • SubscribeMode:

    数据订阅的类型,当 Product 不为 mongodb 时,可能值为:all-全实例更新;dml-数据更新;ddl-结构更新;dmlAndDdl-数据更新+结构更新。当 Product 为 mongodb 时,可能值为 all-全实例更新;database-订阅单库;collection-订阅单集合

  • Protocol:

    订阅数据格式。如果为空则用的默认格式: mysql\cynosdbmysql\mariadb\percona\tdsqlpercona\tdpg是protobuf,mongo是json。当 DatabaseType 为 mysql和cynosdbmysql 时有三种可选协议:protobuf\avro\json。数据格式详情参考官网的消费demo文档

  • SubscribeObjects:

    订阅的数据库表信息

  • KafkaConfig:

    kafka配置信息

  • KafkaVersion:

    订阅内置kafka的版本信息

  • AccessType:

    源数据库接入类型,如:extranet(公网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、cdb(云数据库)、cvm(云服务器自建)、intranet(自研上云)、vpc(私有网络vpc)。注意具体可选值依赖当前链路支持能力

  • Endpoints:

    接入类型信息

  • PipelineInfo:

    mongo输出聚合设置

  • Tags:

    标签

  • Errors:

    订阅任务报错信息

  • ExtraAttr:

    为业务添加的额外信息。参数名作key,参数值作value。

  • SubscribeVersion:

    数据订阅版本, 当前支持kafka和kafkaPro(专业版)

  • ConsumerVpcId:

    消费端地址所在vpc

  • ConsumerSubnetId:

    消费端地址所在子网

  • InstanceClass:

    订阅实例规格

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



3019
3020
3021
# File 'lib/v20211206/models.rb', line 3019

def Region
  @Region
end

#RequestIdObject

注意:此字段可能返回 null,表示取不到有效值。 mysql选填参数:ProcessXA-是否处理XA事务,为true处理,其他不处理。 mongo选填参数:SubscribeType-订阅类型,目前只支持changeStream。

Parameters:

  • SubscribeId:

    数据订阅的ID,形如subs-b6x64o31tm

  • SubscribeName:

    数据订阅实例的名称

  • Product:

    订阅的数据库类型,目前支持 cynosdbmysql(tdsql-c mysql版),mariadb,mongodb,mysql,percona,tdpg(tdsql postgresql版),tdsqlpercona(tdsql mysql版)

  • InstanceId:

    订阅的云数据库实例ID,只有订阅云数据库该值才有意义

  • InstanceStatus:

    订阅的云数据库实例状态,只有订阅云数据库该值才有意义。可能值为:running, isolated, offline

  • Status:

    订阅任务计费状态,可能值为:正常normal, 隔离中isolating, 已隔离isolated, 下线中offlining, 按量转包年包月中 post2PrePayIng

  • SubsStatus:

    订阅任务状态,可能值为:未启动notStarted, 校验中checking, 校验不通过checkNotPass, 校验通过checkPass, 启动中starting, 运行中running, 异常出错error

  • ModifyTime:

    修改时间,时间格式如:Y-m-d h:m:s

  • CreateTime:

    创建时间,时间格式如:Y-m-d h:m:s

  • IsolateTime:

    隔离时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • ExpireTime:

    包年包月任务的到期时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • OfflineTime:

    下线时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • PayType:

    付费方式,可能值为:0-包年包月,1-按量计费

  • AutoRenewFlag:

    自动续费标识。只有当 PayType=0,该值才有意义。枚举值:0-不自动续费,1-自动续费

  • Region:

    任务所在地域

  • Topic:

    Kafka topic

  • Broker:

    Kafka服务Broker地址

  • SubscribeMode:

    数据订阅的类型,当 Product 不为 mongodb 时,可能值为:all-全实例更新;dml-数据更新;ddl-结构更新;dmlAndDdl-数据更新+结构更新。当 Product 为 mongodb 时,可能值为 all-全实例更新;database-订阅单库;collection-订阅单集合

  • Protocol:

    订阅数据格式。如果为空则用的默认格式: mysql\cynosdbmysql\mariadb\percona\tdsqlpercona\tdpg是protobuf,mongo是json。当 DatabaseType 为 mysql和cynosdbmysql 时有三种可选协议:protobuf\avro\json。数据格式详情参考官网的消费demo文档

  • SubscribeObjects:

    订阅的数据库表信息

  • KafkaConfig:

    kafka配置信息

  • KafkaVersion:

    订阅内置kafka的版本信息

  • AccessType:

    源数据库接入类型,如:extranet(公网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、cdb(云数据库)、cvm(云服务器自建)、intranet(自研上云)、vpc(私有网络vpc)。注意具体可选值依赖当前链路支持能力

  • Endpoints:

    接入类型信息

  • PipelineInfo:

    mongo输出聚合设置

  • Tags:

    标签

  • Errors:

    订阅任务报错信息

  • ExtraAttr:

    为业务添加的额外信息。参数名作key,参数值作value。

  • SubscribeVersion:

    数据订阅版本, 当前支持kafka和kafkaPro(专业版)

  • ConsumerVpcId:

    消费端地址所在vpc

  • ConsumerSubnetId:

    消费端地址所在子网

  • InstanceClass:

    订阅实例规格

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



3019
3020
3021
# File 'lib/v20211206/models.rb', line 3019

def RequestId
  @RequestId
end

#StatusObject

注意:此字段可能返回 null,表示取不到有效值。 mysql选填参数:ProcessXA-是否处理XA事务,为true处理,其他不处理。 mongo选填参数:SubscribeType-订阅类型,目前只支持changeStream。

Parameters:

  • SubscribeId:

    数据订阅的ID,形如subs-b6x64o31tm

  • SubscribeName:

    数据订阅实例的名称

  • Product:

    订阅的数据库类型,目前支持 cynosdbmysql(tdsql-c mysql版),mariadb,mongodb,mysql,percona,tdpg(tdsql postgresql版),tdsqlpercona(tdsql mysql版)

  • InstanceId:

    订阅的云数据库实例ID,只有订阅云数据库该值才有意义

  • InstanceStatus:

    订阅的云数据库实例状态,只有订阅云数据库该值才有意义。可能值为:running, isolated, offline

  • Status:

    订阅任务计费状态,可能值为:正常normal, 隔离中isolating, 已隔离isolated, 下线中offlining, 按量转包年包月中 post2PrePayIng

  • SubsStatus:

    订阅任务状态,可能值为:未启动notStarted, 校验中checking, 校验不通过checkNotPass, 校验通过checkPass, 启动中starting, 运行中running, 异常出错error

  • ModifyTime:

    修改时间,时间格式如:Y-m-d h:m:s

  • CreateTime:

    创建时间,时间格式如:Y-m-d h:m:s

  • IsolateTime:

    隔离时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • ExpireTime:

    包年包月任务的到期时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • OfflineTime:

    下线时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • PayType:

    付费方式,可能值为:0-包年包月,1-按量计费

  • AutoRenewFlag:

    自动续费标识。只有当 PayType=0,该值才有意义。枚举值:0-不自动续费,1-自动续费

  • Region:

    任务所在地域

  • Topic:

    Kafka topic

  • Broker:

    Kafka服务Broker地址

  • SubscribeMode:

    数据订阅的类型,当 Product 不为 mongodb 时,可能值为:all-全实例更新;dml-数据更新;ddl-结构更新;dmlAndDdl-数据更新+结构更新。当 Product 为 mongodb 时,可能值为 all-全实例更新;database-订阅单库;collection-订阅单集合

  • Protocol:

    订阅数据格式。如果为空则用的默认格式: mysql\cynosdbmysql\mariadb\percona\tdsqlpercona\tdpg是protobuf,mongo是json。当 DatabaseType 为 mysql和cynosdbmysql 时有三种可选协议:protobuf\avro\json。数据格式详情参考官网的消费demo文档

  • SubscribeObjects:

    订阅的数据库表信息

  • KafkaConfig:

    kafka配置信息

  • KafkaVersion:

    订阅内置kafka的版本信息

  • AccessType:

    源数据库接入类型,如:extranet(公网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、cdb(云数据库)、cvm(云服务器自建)、intranet(自研上云)、vpc(私有网络vpc)。注意具体可选值依赖当前链路支持能力

  • Endpoints:

    接入类型信息

  • PipelineInfo:

    mongo输出聚合设置

  • Tags:

    标签

  • Errors:

    订阅任务报错信息

  • ExtraAttr:

    为业务添加的额外信息。参数名作key,参数值作value。

  • SubscribeVersion:

    数据订阅版本, 当前支持kafka和kafkaPro(专业版)

  • ConsumerVpcId:

    消费端地址所在vpc

  • ConsumerSubnetId:

    消费端地址所在子网

  • InstanceClass:

    订阅实例规格

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



3019
3020
3021
# File 'lib/v20211206/models.rb', line 3019

def Status
  @Status
end

#SubscribeIdObject

注意:此字段可能返回 null,表示取不到有效值。 mysql选填参数:ProcessXA-是否处理XA事务,为true处理,其他不处理。 mongo选填参数:SubscribeType-订阅类型,目前只支持changeStream。

Parameters:

  • SubscribeId:

    数据订阅的ID,形如subs-b6x64o31tm

  • SubscribeName:

    数据订阅实例的名称

  • Product:

    订阅的数据库类型,目前支持 cynosdbmysql(tdsql-c mysql版),mariadb,mongodb,mysql,percona,tdpg(tdsql postgresql版),tdsqlpercona(tdsql mysql版)

  • InstanceId:

    订阅的云数据库实例ID,只有订阅云数据库该值才有意义

  • InstanceStatus:

    订阅的云数据库实例状态,只有订阅云数据库该值才有意义。可能值为:running, isolated, offline

  • Status:

    订阅任务计费状态,可能值为:正常normal, 隔离中isolating, 已隔离isolated, 下线中offlining, 按量转包年包月中 post2PrePayIng

  • SubsStatus:

    订阅任务状态,可能值为:未启动notStarted, 校验中checking, 校验不通过checkNotPass, 校验通过checkPass, 启动中starting, 运行中running, 异常出错error

  • ModifyTime:

    修改时间,时间格式如:Y-m-d h:m:s

  • CreateTime:

    创建时间,时间格式如:Y-m-d h:m:s

  • IsolateTime:

    隔离时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • ExpireTime:

    包年包月任务的到期时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • OfflineTime:

    下线时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • PayType:

    付费方式,可能值为:0-包年包月,1-按量计费

  • AutoRenewFlag:

    自动续费标识。只有当 PayType=0,该值才有意义。枚举值:0-不自动续费,1-自动续费

  • Region:

    任务所在地域

  • Topic:

    Kafka topic

  • Broker:

    Kafka服务Broker地址

  • SubscribeMode:

    数据订阅的类型,当 Product 不为 mongodb 时,可能值为:all-全实例更新;dml-数据更新;ddl-结构更新;dmlAndDdl-数据更新+结构更新。当 Product 为 mongodb 时,可能值为 all-全实例更新;database-订阅单库;collection-订阅单集合

  • Protocol:

    订阅数据格式。如果为空则用的默认格式: mysql\cynosdbmysql\mariadb\percona\tdsqlpercona\tdpg是protobuf,mongo是json。当 DatabaseType 为 mysql和cynosdbmysql 时有三种可选协议:protobuf\avro\json。数据格式详情参考官网的消费demo文档

  • SubscribeObjects:

    订阅的数据库表信息

  • KafkaConfig:

    kafka配置信息

  • KafkaVersion:

    订阅内置kafka的版本信息

  • AccessType:

    源数据库接入类型,如:extranet(公网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、cdb(云数据库)、cvm(云服务器自建)、intranet(自研上云)、vpc(私有网络vpc)。注意具体可选值依赖当前链路支持能力

  • Endpoints:

    接入类型信息

  • PipelineInfo:

    mongo输出聚合设置

  • Tags:

    标签

  • Errors:

    订阅任务报错信息

  • ExtraAttr:

    为业务添加的额外信息。参数名作key,参数值作value。

  • SubscribeVersion:

    数据订阅版本, 当前支持kafka和kafkaPro(专业版)

  • ConsumerVpcId:

    消费端地址所在vpc

  • ConsumerSubnetId:

    消费端地址所在子网

  • InstanceClass:

    订阅实例规格

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



3019
3020
3021
# File 'lib/v20211206/models.rb', line 3019

def SubscribeId
  @SubscribeId
end

#SubscribeModeObject

注意:此字段可能返回 null,表示取不到有效值。 mysql选填参数:ProcessXA-是否处理XA事务,为true处理,其他不处理。 mongo选填参数:SubscribeType-订阅类型,目前只支持changeStream。

Parameters:

  • SubscribeId:

    数据订阅的ID,形如subs-b6x64o31tm

  • SubscribeName:

    数据订阅实例的名称

  • Product:

    订阅的数据库类型,目前支持 cynosdbmysql(tdsql-c mysql版),mariadb,mongodb,mysql,percona,tdpg(tdsql postgresql版),tdsqlpercona(tdsql mysql版)

  • InstanceId:

    订阅的云数据库实例ID,只有订阅云数据库该值才有意义

  • InstanceStatus:

    订阅的云数据库实例状态,只有订阅云数据库该值才有意义。可能值为:running, isolated, offline

  • Status:

    订阅任务计费状态,可能值为:正常normal, 隔离中isolating, 已隔离isolated, 下线中offlining, 按量转包年包月中 post2PrePayIng

  • SubsStatus:

    订阅任务状态,可能值为:未启动notStarted, 校验中checking, 校验不通过checkNotPass, 校验通过checkPass, 启动中starting, 运行中running, 异常出错error

  • ModifyTime:

    修改时间,时间格式如:Y-m-d h:m:s

  • CreateTime:

    创建时间,时间格式如:Y-m-d h:m:s

  • IsolateTime:

    隔离时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • ExpireTime:

    包年包月任务的到期时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • OfflineTime:

    下线时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • PayType:

    付费方式,可能值为:0-包年包月,1-按量计费

  • AutoRenewFlag:

    自动续费标识。只有当 PayType=0,该值才有意义。枚举值:0-不自动续费,1-自动续费

  • Region:

    任务所在地域

  • Topic:

    Kafka topic

  • Broker:

    Kafka服务Broker地址

  • SubscribeMode:

    数据订阅的类型,当 Product 不为 mongodb 时,可能值为:all-全实例更新;dml-数据更新;ddl-结构更新;dmlAndDdl-数据更新+结构更新。当 Product 为 mongodb 时,可能值为 all-全实例更新;database-订阅单库;collection-订阅单集合

  • Protocol:

    订阅数据格式。如果为空则用的默认格式: mysql\cynosdbmysql\mariadb\percona\tdsqlpercona\tdpg是protobuf,mongo是json。当 DatabaseType 为 mysql和cynosdbmysql 时有三种可选协议:protobuf\avro\json。数据格式详情参考官网的消费demo文档

  • SubscribeObjects:

    订阅的数据库表信息

  • KafkaConfig:

    kafka配置信息

  • KafkaVersion:

    订阅内置kafka的版本信息

  • AccessType:

    源数据库接入类型,如:extranet(公网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、cdb(云数据库)、cvm(云服务器自建)、intranet(自研上云)、vpc(私有网络vpc)。注意具体可选值依赖当前链路支持能力

  • Endpoints:

    接入类型信息

  • PipelineInfo:

    mongo输出聚合设置

  • Tags:

    标签

  • Errors:

    订阅任务报错信息

  • ExtraAttr:

    为业务添加的额外信息。参数名作key,参数值作value。

  • SubscribeVersion:

    数据订阅版本, 当前支持kafka和kafkaPro(专业版)

  • ConsumerVpcId:

    消费端地址所在vpc

  • ConsumerSubnetId:

    消费端地址所在子网

  • InstanceClass:

    订阅实例规格

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



3019
3020
3021
# File 'lib/v20211206/models.rb', line 3019

def SubscribeMode
  @SubscribeMode
end

#SubscribeNameObject

注意:此字段可能返回 null,表示取不到有效值。 mysql选填参数:ProcessXA-是否处理XA事务,为true处理,其他不处理。 mongo选填参数:SubscribeType-订阅类型,目前只支持changeStream。

Parameters:

  • SubscribeId:

    数据订阅的ID,形如subs-b6x64o31tm

  • SubscribeName:

    数据订阅实例的名称

  • Product:

    订阅的数据库类型,目前支持 cynosdbmysql(tdsql-c mysql版),mariadb,mongodb,mysql,percona,tdpg(tdsql postgresql版),tdsqlpercona(tdsql mysql版)

  • InstanceId:

    订阅的云数据库实例ID,只有订阅云数据库该值才有意义

  • InstanceStatus:

    订阅的云数据库实例状态,只有订阅云数据库该值才有意义。可能值为:running, isolated, offline

  • Status:

    订阅任务计费状态,可能值为:正常normal, 隔离中isolating, 已隔离isolated, 下线中offlining, 按量转包年包月中 post2PrePayIng

  • SubsStatus:

    订阅任务状态,可能值为:未启动notStarted, 校验中checking, 校验不通过checkNotPass, 校验通过checkPass, 启动中starting, 运行中running, 异常出错error

  • ModifyTime:

    修改时间,时间格式如:Y-m-d h:m:s

  • CreateTime:

    创建时间,时间格式如:Y-m-d h:m:s

  • IsolateTime:

    隔离时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • ExpireTime:

    包年包月任务的到期时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • OfflineTime:

    下线时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • PayType:

    付费方式,可能值为:0-包年包月,1-按量计费

  • AutoRenewFlag:

    自动续费标识。只有当 PayType=0,该值才有意义。枚举值:0-不自动续费,1-自动续费

  • Region:

    任务所在地域

  • Topic:

    Kafka topic

  • Broker:

    Kafka服务Broker地址

  • SubscribeMode:

    数据订阅的类型,当 Product 不为 mongodb 时,可能值为:all-全实例更新;dml-数据更新;ddl-结构更新;dmlAndDdl-数据更新+结构更新。当 Product 为 mongodb 时,可能值为 all-全实例更新;database-订阅单库;collection-订阅单集合

  • Protocol:

    订阅数据格式。如果为空则用的默认格式: mysql\cynosdbmysql\mariadb\percona\tdsqlpercona\tdpg是protobuf,mongo是json。当 DatabaseType 为 mysql和cynosdbmysql 时有三种可选协议:protobuf\avro\json。数据格式详情参考官网的消费demo文档

  • SubscribeObjects:

    订阅的数据库表信息

  • KafkaConfig:

    kafka配置信息

  • KafkaVersion:

    订阅内置kafka的版本信息

  • AccessType:

    源数据库接入类型,如:extranet(公网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、cdb(云数据库)、cvm(云服务器自建)、intranet(自研上云)、vpc(私有网络vpc)。注意具体可选值依赖当前链路支持能力

  • Endpoints:

    接入类型信息

  • PipelineInfo:

    mongo输出聚合设置

  • Tags:

    标签

  • Errors:

    订阅任务报错信息

  • ExtraAttr:

    为业务添加的额外信息。参数名作key,参数值作value。

  • SubscribeVersion:

    数据订阅版本, 当前支持kafka和kafkaPro(专业版)

  • ConsumerVpcId:

    消费端地址所在vpc

  • ConsumerSubnetId:

    消费端地址所在子网

  • InstanceClass:

    订阅实例规格

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



3019
3020
3021
# File 'lib/v20211206/models.rb', line 3019

def SubscribeName
  @SubscribeName
end

#SubscribeObjectsObject

注意:此字段可能返回 null,表示取不到有效值。 mysql选填参数:ProcessXA-是否处理XA事务,为true处理,其他不处理。 mongo选填参数:SubscribeType-订阅类型,目前只支持changeStream。

Parameters:

  • SubscribeId:

    数据订阅的ID,形如subs-b6x64o31tm

  • SubscribeName:

    数据订阅实例的名称

  • Product:

    订阅的数据库类型,目前支持 cynosdbmysql(tdsql-c mysql版),mariadb,mongodb,mysql,percona,tdpg(tdsql postgresql版),tdsqlpercona(tdsql mysql版)

  • InstanceId:

    订阅的云数据库实例ID,只有订阅云数据库该值才有意义

  • InstanceStatus:

    订阅的云数据库实例状态,只有订阅云数据库该值才有意义。可能值为:running, isolated, offline

  • Status:

    订阅任务计费状态,可能值为:正常normal, 隔离中isolating, 已隔离isolated, 下线中offlining, 按量转包年包月中 post2PrePayIng

  • SubsStatus:

    订阅任务状态,可能值为:未启动notStarted, 校验中checking, 校验不通过checkNotPass, 校验通过checkPass, 启动中starting, 运行中running, 异常出错error

  • ModifyTime:

    修改时间,时间格式如:Y-m-d h:m:s

  • CreateTime:

    创建时间,时间格式如:Y-m-d h:m:s

  • IsolateTime:

    隔离时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • ExpireTime:

    包年包月任务的到期时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • OfflineTime:

    下线时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • PayType:

    付费方式,可能值为:0-包年包月,1-按量计费

  • AutoRenewFlag:

    自动续费标识。只有当 PayType=0,该值才有意义。枚举值:0-不自动续费,1-自动续费

  • Region:

    任务所在地域

  • Topic:

    Kafka topic

  • Broker:

    Kafka服务Broker地址

  • SubscribeMode:

    数据订阅的类型,当 Product 不为 mongodb 时,可能值为:all-全实例更新;dml-数据更新;ddl-结构更新;dmlAndDdl-数据更新+结构更新。当 Product 为 mongodb 时,可能值为 all-全实例更新;database-订阅单库;collection-订阅单集合

  • Protocol:

    订阅数据格式。如果为空则用的默认格式: mysql\cynosdbmysql\mariadb\percona\tdsqlpercona\tdpg是protobuf,mongo是json。当 DatabaseType 为 mysql和cynosdbmysql 时有三种可选协议:protobuf\avro\json。数据格式详情参考官网的消费demo文档

  • SubscribeObjects:

    订阅的数据库表信息

  • KafkaConfig:

    kafka配置信息

  • KafkaVersion:

    订阅内置kafka的版本信息

  • AccessType:

    源数据库接入类型,如:extranet(公网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、cdb(云数据库)、cvm(云服务器自建)、intranet(自研上云)、vpc(私有网络vpc)。注意具体可选值依赖当前链路支持能力

  • Endpoints:

    接入类型信息

  • PipelineInfo:

    mongo输出聚合设置

  • Tags:

    标签

  • Errors:

    订阅任务报错信息

  • ExtraAttr:

    为业务添加的额外信息。参数名作key,参数值作value。

  • SubscribeVersion:

    数据订阅版本, 当前支持kafka和kafkaPro(专业版)

  • ConsumerVpcId:

    消费端地址所在vpc

  • ConsumerSubnetId:

    消费端地址所在子网

  • InstanceClass:

    订阅实例规格

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



3019
3020
3021
# File 'lib/v20211206/models.rb', line 3019

def SubscribeObjects
  @SubscribeObjects
end

#SubscribeVersionObject

注意:此字段可能返回 null,表示取不到有效值。 mysql选填参数:ProcessXA-是否处理XA事务,为true处理,其他不处理。 mongo选填参数:SubscribeType-订阅类型,目前只支持changeStream。

Parameters:

  • SubscribeId:

    数据订阅的ID,形如subs-b6x64o31tm

  • SubscribeName:

    数据订阅实例的名称

  • Product:

    订阅的数据库类型,目前支持 cynosdbmysql(tdsql-c mysql版),mariadb,mongodb,mysql,percona,tdpg(tdsql postgresql版),tdsqlpercona(tdsql mysql版)

  • InstanceId:

    订阅的云数据库实例ID,只有订阅云数据库该值才有意义

  • InstanceStatus:

    订阅的云数据库实例状态,只有订阅云数据库该值才有意义。可能值为:running, isolated, offline

  • Status:

    订阅任务计费状态,可能值为:正常normal, 隔离中isolating, 已隔离isolated, 下线中offlining, 按量转包年包月中 post2PrePayIng

  • SubsStatus:

    订阅任务状态,可能值为:未启动notStarted, 校验中checking, 校验不通过checkNotPass, 校验通过checkPass, 启动中starting, 运行中running, 异常出错error

  • ModifyTime:

    修改时间,时间格式如:Y-m-d h:m:s

  • CreateTime:

    创建时间,时间格式如:Y-m-d h:m:s

  • IsolateTime:

    隔离时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • ExpireTime:

    包年包月任务的到期时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • OfflineTime:

    下线时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • PayType:

    付费方式,可能值为:0-包年包月,1-按量计费

  • AutoRenewFlag:

    自动续费标识。只有当 PayType=0,该值才有意义。枚举值:0-不自动续费,1-自动续费

  • Region:

    任务所在地域

  • Topic:

    Kafka topic

  • Broker:

    Kafka服务Broker地址

  • SubscribeMode:

    数据订阅的类型,当 Product 不为 mongodb 时,可能值为:all-全实例更新;dml-数据更新;ddl-结构更新;dmlAndDdl-数据更新+结构更新。当 Product 为 mongodb 时,可能值为 all-全实例更新;database-订阅单库;collection-订阅单集合

  • Protocol:

    订阅数据格式。如果为空则用的默认格式: mysql\cynosdbmysql\mariadb\percona\tdsqlpercona\tdpg是protobuf,mongo是json。当 DatabaseType 为 mysql和cynosdbmysql 时有三种可选协议:protobuf\avro\json。数据格式详情参考官网的消费demo文档

  • SubscribeObjects:

    订阅的数据库表信息

  • KafkaConfig:

    kafka配置信息

  • KafkaVersion:

    订阅内置kafka的版本信息

  • AccessType:

    源数据库接入类型,如:extranet(公网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、cdb(云数据库)、cvm(云服务器自建)、intranet(自研上云)、vpc(私有网络vpc)。注意具体可选值依赖当前链路支持能力

  • Endpoints:

    接入类型信息

  • PipelineInfo:

    mongo输出聚合设置

  • Tags:

    标签

  • Errors:

    订阅任务报错信息

  • ExtraAttr:

    为业务添加的额外信息。参数名作key,参数值作value。

  • SubscribeVersion:

    数据订阅版本, 当前支持kafka和kafkaPro(专业版)

  • ConsumerVpcId:

    消费端地址所在vpc

  • ConsumerSubnetId:

    消费端地址所在子网

  • InstanceClass:

    订阅实例规格

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



3019
3020
3021
# File 'lib/v20211206/models.rb', line 3019

def SubscribeVersion
  @SubscribeVersion
end

#SubsStatusObject

注意:此字段可能返回 null,表示取不到有效值。 mysql选填参数:ProcessXA-是否处理XA事务,为true处理,其他不处理。 mongo选填参数:SubscribeType-订阅类型,目前只支持changeStream。

Parameters:

  • SubscribeId:

    数据订阅的ID,形如subs-b6x64o31tm

  • SubscribeName:

    数据订阅实例的名称

  • Product:

    订阅的数据库类型,目前支持 cynosdbmysql(tdsql-c mysql版),mariadb,mongodb,mysql,percona,tdpg(tdsql postgresql版),tdsqlpercona(tdsql mysql版)

  • InstanceId:

    订阅的云数据库实例ID,只有订阅云数据库该值才有意义

  • InstanceStatus:

    订阅的云数据库实例状态,只有订阅云数据库该值才有意义。可能值为:running, isolated, offline

  • Status:

    订阅任务计费状态,可能值为:正常normal, 隔离中isolating, 已隔离isolated, 下线中offlining, 按量转包年包月中 post2PrePayIng

  • SubsStatus:

    订阅任务状态,可能值为:未启动notStarted, 校验中checking, 校验不通过checkNotPass, 校验通过checkPass, 启动中starting, 运行中running, 异常出错error

  • ModifyTime:

    修改时间,时间格式如:Y-m-d h:m:s

  • CreateTime:

    创建时间,时间格式如:Y-m-d h:m:s

  • IsolateTime:

    隔离时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • ExpireTime:

    包年包月任务的到期时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • OfflineTime:

    下线时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • PayType:

    付费方式,可能值为:0-包年包月,1-按量计费

  • AutoRenewFlag:

    自动续费标识。只有当 PayType=0,该值才有意义。枚举值:0-不自动续费,1-自动续费

  • Region:

    任务所在地域

  • Topic:

    Kafka topic

  • Broker:

    Kafka服务Broker地址

  • SubscribeMode:

    数据订阅的类型,当 Product 不为 mongodb 时,可能值为:all-全实例更新;dml-数据更新;ddl-结构更新;dmlAndDdl-数据更新+结构更新。当 Product 为 mongodb 时,可能值为 all-全实例更新;database-订阅单库;collection-订阅单集合

  • Protocol:

    订阅数据格式。如果为空则用的默认格式: mysql\cynosdbmysql\mariadb\percona\tdsqlpercona\tdpg是protobuf,mongo是json。当 DatabaseType 为 mysql和cynosdbmysql 时有三种可选协议:protobuf\avro\json。数据格式详情参考官网的消费demo文档

  • SubscribeObjects:

    订阅的数据库表信息

  • KafkaConfig:

    kafka配置信息

  • KafkaVersion:

    订阅内置kafka的版本信息

  • AccessType:

    源数据库接入类型,如:extranet(公网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、cdb(云数据库)、cvm(云服务器自建)、intranet(自研上云)、vpc(私有网络vpc)。注意具体可选值依赖当前链路支持能力

  • Endpoints:

    接入类型信息

  • PipelineInfo:

    mongo输出聚合设置

  • Tags:

    标签

  • Errors:

    订阅任务报错信息

  • ExtraAttr:

    为业务添加的额外信息。参数名作key,参数值作value。

  • SubscribeVersion:

    数据订阅版本, 当前支持kafka和kafkaPro(专业版)

  • ConsumerVpcId:

    消费端地址所在vpc

  • ConsumerSubnetId:

    消费端地址所在子网

  • InstanceClass:

    订阅实例规格

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



3019
3020
3021
# File 'lib/v20211206/models.rb', line 3019

def SubsStatus
  @SubsStatus
end

#TagsObject

注意:此字段可能返回 null,表示取不到有效值。 mysql选填参数:ProcessXA-是否处理XA事务,为true处理,其他不处理。 mongo选填参数:SubscribeType-订阅类型,目前只支持changeStream。

Parameters:

  • SubscribeId:

    数据订阅的ID,形如subs-b6x64o31tm

  • SubscribeName:

    数据订阅实例的名称

  • Product:

    订阅的数据库类型,目前支持 cynosdbmysql(tdsql-c mysql版),mariadb,mongodb,mysql,percona,tdpg(tdsql postgresql版),tdsqlpercona(tdsql mysql版)

  • InstanceId:

    订阅的云数据库实例ID,只有订阅云数据库该值才有意义

  • InstanceStatus:

    订阅的云数据库实例状态,只有订阅云数据库该值才有意义。可能值为:running, isolated, offline

  • Status:

    订阅任务计费状态,可能值为:正常normal, 隔离中isolating, 已隔离isolated, 下线中offlining, 按量转包年包月中 post2PrePayIng

  • SubsStatus:

    订阅任务状态,可能值为:未启动notStarted, 校验中checking, 校验不通过checkNotPass, 校验通过checkPass, 启动中starting, 运行中running, 异常出错error

  • ModifyTime:

    修改时间,时间格式如:Y-m-d h:m:s

  • CreateTime:

    创建时间,时间格式如:Y-m-d h:m:s

  • IsolateTime:

    隔离时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • ExpireTime:

    包年包月任务的到期时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • OfflineTime:

    下线时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • PayType:

    付费方式,可能值为:0-包年包月,1-按量计费

  • AutoRenewFlag:

    自动续费标识。只有当 PayType=0,该值才有意义。枚举值:0-不自动续费,1-自动续费

  • Region:

    任务所在地域

  • Topic:

    Kafka topic

  • Broker:

    Kafka服务Broker地址

  • SubscribeMode:

    数据订阅的类型,当 Product 不为 mongodb 时,可能值为:all-全实例更新;dml-数据更新;ddl-结构更新;dmlAndDdl-数据更新+结构更新。当 Product 为 mongodb 时,可能值为 all-全实例更新;database-订阅单库;collection-订阅单集合

  • Protocol:

    订阅数据格式。如果为空则用的默认格式: mysql\cynosdbmysql\mariadb\percona\tdsqlpercona\tdpg是protobuf,mongo是json。当 DatabaseType 为 mysql和cynosdbmysql 时有三种可选协议:protobuf\avro\json。数据格式详情参考官网的消费demo文档

  • SubscribeObjects:

    订阅的数据库表信息

  • KafkaConfig:

    kafka配置信息

  • KafkaVersion:

    订阅内置kafka的版本信息

  • AccessType:

    源数据库接入类型,如:extranet(公网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、cdb(云数据库)、cvm(云服务器自建)、intranet(自研上云)、vpc(私有网络vpc)。注意具体可选值依赖当前链路支持能力

  • Endpoints:

    接入类型信息

  • PipelineInfo:

    mongo输出聚合设置

  • Tags:

    标签

  • Errors:

    订阅任务报错信息

  • ExtraAttr:

    为业务添加的额外信息。参数名作key,参数值作value。

  • SubscribeVersion:

    数据订阅版本, 当前支持kafka和kafkaPro(专业版)

  • ConsumerVpcId:

    消费端地址所在vpc

  • ConsumerSubnetId:

    消费端地址所在子网

  • InstanceClass:

    订阅实例规格

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



3019
3020
3021
# File 'lib/v20211206/models.rb', line 3019

def Tags
  @Tags
end

#TopicObject

注意:此字段可能返回 null,表示取不到有效值。 mysql选填参数:ProcessXA-是否处理XA事务,为true处理,其他不处理。 mongo选填参数:SubscribeType-订阅类型,目前只支持changeStream。

Parameters:

  • SubscribeId:

    数据订阅的ID,形如subs-b6x64o31tm

  • SubscribeName:

    数据订阅实例的名称

  • Product:

    订阅的数据库类型,目前支持 cynosdbmysql(tdsql-c mysql版),mariadb,mongodb,mysql,percona,tdpg(tdsql postgresql版),tdsqlpercona(tdsql mysql版)

  • InstanceId:

    订阅的云数据库实例ID,只有订阅云数据库该值才有意义

  • InstanceStatus:

    订阅的云数据库实例状态,只有订阅云数据库该值才有意义。可能值为:running, isolated, offline

  • Status:

    订阅任务计费状态,可能值为:正常normal, 隔离中isolating, 已隔离isolated, 下线中offlining, 按量转包年包月中 post2PrePayIng

  • SubsStatus:

    订阅任务状态,可能值为:未启动notStarted, 校验中checking, 校验不通过checkNotPass, 校验通过checkPass, 启动中starting, 运行中running, 异常出错error

  • ModifyTime:

    修改时间,时间格式如:Y-m-d h:m:s

  • CreateTime:

    创建时间,时间格式如:Y-m-d h:m:s

  • IsolateTime:

    隔离时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • ExpireTime:

    包年包月任务的到期时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • OfflineTime:

    下线时间,时间格式如:Y-m-d h:m:s。默认:0000-00-00 00:00:00

  • PayType:

    付费方式,可能值为:0-包年包月,1-按量计费

  • AutoRenewFlag:

    自动续费标识。只有当 PayType=0,该值才有意义。枚举值:0-不自动续费,1-自动续费

  • Region:

    任务所在地域

  • Topic:

    Kafka topic

  • Broker:

    Kafka服务Broker地址

  • SubscribeMode:

    数据订阅的类型,当 Product 不为 mongodb 时,可能值为:all-全实例更新;dml-数据更新;ddl-结构更新;dmlAndDdl-数据更新+结构更新。当 Product 为 mongodb 时,可能值为 all-全实例更新;database-订阅单库;collection-订阅单集合

  • Protocol:

    订阅数据格式。如果为空则用的默认格式: mysql\cynosdbmysql\mariadb\percona\tdsqlpercona\tdpg是protobuf,mongo是json。当 DatabaseType 为 mysql和cynosdbmysql 时有三种可选协议:protobuf\avro\json。数据格式详情参考官网的消费demo文档

  • SubscribeObjects:

    订阅的数据库表信息

  • KafkaConfig:

    kafka配置信息

  • KafkaVersion:

    订阅内置kafka的版本信息

  • AccessType:

    源数据库接入类型,如:extranet(公网)、vpncloud(vpn接入)、dcg(专线接入)、ccn(云联网)、cdb(云数据库)、cvm(云服务器自建)、intranet(自研上云)、vpc(私有网络vpc)。注意具体可选值依赖当前链路支持能力

  • Endpoints:

    接入类型信息

  • PipelineInfo:

    mongo输出聚合设置

  • Tags:

    标签

  • Errors:

    订阅任务报错信息

  • ExtraAttr:

    为业务添加的额外信息。参数名作key,参数值作value。

  • SubscribeVersion:

    数据订阅版本, 当前支持kafka和kafkaPro(专业版)

  • ConsumerVpcId:

    消费端地址所在vpc

  • ConsumerSubnetId:

    消费端地址所在子网

  • InstanceClass:

    订阅实例规格

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



3019
3020
3021
# File 'lib/v20211206/models.rb', line 3019

def Topic
  @Topic
end

Instance Method Details

#deserialize(params) ⇒ Object



3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
# File 'lib/v20211206/models.rb', line 3057

def deserialize(params)
  @SubscribeId = params['SubscribeId']
  @SubscribeName = params['SubscribeName']
  @Product = params['Product']
  @InstanceId = params['InstanceId']
  @InstanceStatus = params['InstanceStatus']
  @Status = params['Status']
  @SubsStatus = params['SubsStatus']
  @ModifyTime = params['ModifyTime']
  @CreateTime = params['CreateTime']
  @IsolateTime = params['IsolateTime']
  @ExpireTime = params['ExpireTime']
  @OfflineTime = params['OfflineTime']
  @PayType = params['PayType']
  @AutoRenewFlag = params['AutoRenewFlag']
  @Region = params['Region']
  @Topic = params['Topic']
  @Broker = params['Broker']
  @SubscribeMode = params['SubscribeMode']
  @Protocol = params['Protocol']
  unless params['SubscribeObjects'].nil?
    @SubscribeObjects = []
    params['SubscribeObjects'].each do |i|
      subscribeobject_tmp = SubscribeObject.new
      subscribeobject_tmp.deserialize(i)
      @SubscribeObjects << subscribeobject_tmp
    end
  end
  unless params['KafkaConfig'].nil?
    @KafkaConfig = SubscribeKafkaConfig.new
    @KafkaConfig.deserialize(params['KafkaConfig'])
  end
  @KafkaVersion = params['KafkaVersion']
  @AccessType = params['AccessType']
  unless params['Endpoints'].nil?
    @Endpoints = []
    params['Endpoints'].each do |i|
      endpointitem_tmp = EndpointItem.new
      endpointitem_tmp.deserialize(i)
      @Endpoints << endpointitem_tmp
    end
  end
  unless params['PipelineInfo'].nil?
    @PipelineInfo = []
    params['PipelineInfo'].each do |i|
      pipelineinfo_tmp = PipelineInfo.new
      pipelineinfo_tmp.deserialize(i)
      @PipelineInfo << pipelineinfo_tmp
    end
  end
  unless params['Tags'].nil?
    @Tags = []
    params['Tags'].each do |i|
      tagitem_tmp = TagItem.new
      tagitem_tmp.deserialize(i)
      @Tags << tagitem_tmp
    end
  end
  unless params['Errors'].nil?
    @Errors = []
    params['Errors'].each do |i|
      subserr_tmp = SubsErr.new
      subserr_tmp.deserialize(i)
      @Errors << subserr_tmp
    end
  end
  unless params['ExtraAttr'].nil?
    @ExtraAttr = []
    params['ExtraAttr'].each do |i|
      keyvaluepairoption_tmp = KeyValuePairOption.new
      keyvaluepairoption_tmp.deserialize(i)
      @ExtraAttr << keyvaluepairoption_tmp
    end
  end
  @SubscribeVersion = params['SubscribeVersion']
  @ConsumerVpcId = params['ConsumerVpcId']
  @ConsumerSubnetId = params['ConsumerSubnetId']
  @InstanceClass = params['InstanceClass']
  @RequestId = params['RequestId']
end