有奖捉虫:云通信与企业服务文档专题,速来> HOT

ConsistencyParams

抽样检验时的抽样参数

被如下接口引用:CreateMigrateJob, DescribeMigrateJobs, ModifyMigrateJob。

名称 类型 必选 描述
SelectRowsPerTable Integer 数据内容检测参数。表中选出用来数据对比的行,占表的总行数的百分比。取值范围是整数[1-100]
TablesSelectAll Integer 数据内容检测参数。迁移库表中,要进行数据内容检测的表,占所有表的百分比。取值范围是整数[1-100]
TablesSelectCount Integer 数据数量检测,检测表行数是否一致。迁移库表中,要进行数据数量检测的表,占所有表的百分比。取值范围是整数[1-100]

DstInfo

目的实例信息,具体内容跟迁移任务类型相关

被如下接口引用:CreateMigrateJob, DescribeMigrateJobs, ModifyMigrateJob。

名称 类型 必选 描述
Region String 目标实例地域,如ap-guangzhou
InstanceId String 目标实例ID,如cdb-jd92ijd8
Ip String 目标实例vip。已废弃,无需填写
Port Integer 目标实例vport。已废弃,无需填写
ReadOnly Integer 目前只对MySQL有效。当为整实例迁移时,1-只读,0-可读写。
User String 目标数据库账号
Password String 目标数据库密码

ErrorInfo

迁移任务错误信息及提示

被如下接口引用:DescribeMigrateJobs。

名称 类型 描述
ErrorLog String 具体的报错日志, 包含错误码和错误信息
HelpDoc String 报错对应的帮助文档Ur

MigrateDetailInfo

描述详细迁移过程

被如下接口引用:DescribeMigrateJobs。

名称 类型 描述
StepAll Integer 总步骤数
StepNow Integer 当前步骤
Progress String 总进度,如:"10"
CurrentStepProgress String 当前步骤进度,如:"1"
MasterSlaveDistance Integer 主从差距,MB;在增量同步阶段有效,目前支持产品为:redis和mysql
SecondsBehindMaster Integer 主从差距,秒;在增量同步阶段有效,目前支持产品为:mysql
StepInfo Array of MigrateStepDetailInfo 步骤信息

MigrateJobInfo

迁移任务详情

被如下接口引用:DescribeMigrateJobs。

名称 类型 描述
JobId String 数据迁移任务ID
示例值:dts-75sekyal
JobName String 数据迁移任务名称
示例值:test
MigrateOption MigrateOption 迁移任务配置选项
示例值:{"ConsistencyParams":{"SelectRowsPerTable":0,"TablesSelectAll":0
SrcDatabaseType String 源实例数据库类型:mysql,redis,mongodb,postgresql,mariadb,percona
示例值:mysql
SrcAccessType String 源实例接入类型,值包括:extranet(外网),cvm(cvm自建实例),dcg(专线接入的实例),vpncloud(云vpn接入的实例),cdb(腾讯云数据库实例),ccn(云联网实例)
示例值:cdb
SrcInfo SrcInfo 源实例信息,具体内容跟迁移任务类型相关
示例值:{"AccessKey":"","CcnId":"","CvmInstanceId":"","EngineVersion":""
DstDatabaseType String 目标实例数据库类型:mysql,redis,mongodb,postgresql,mariadb,percona
示例值:mysql
DstAccessType String 目标实例接入类型,目前支持:cdb(腾讯云数据库实例)
示例值:cdb
DstInfo DstInfo 目标实例信息
示例值:{"CcnId":"","CvmInstanceId":"","InstanceId":"crs-eciqrvyo","Ip":
DatabaseInfo String 需要迁移的源数据库表信息,如果需要迁移的是整个实例,该字段为[]
示例值:""
CreateTime Timestamp 任务创建(提交)时间
示例值:2022-04-14 16:35:23
StartTime Timestamp 任务开始执行时间
示例值:2022-04-14 16:48:33
EndTime Timestamp 任务执行结束时间
示例值:2022-04-14 16:48:33
Status Integer 任务状态,取值为:1-创建中(Creating),3-校验中(Checking)4-校验通过(CheckPass),5-校验不通过(CheckNotPass),7-任务运行(Running),8-准备完成(ReadyComplete),9-任务成功(Success),10-任务失败(Failed),11-撤销中(Stopping),12-完成中(Completing)
示例值:6
Detail MigrateDetailInfo 任务详情
示例值:{"CurrentStepProgress":"0","MasterSlaveDistance":-1,"Progress":"
ErrorInfo Array of ErrorInfo 任务错误信息提示,当任务发生错误时,不为null或者空值
示例值: []
Tags Array of TagItem 标签
注意:此字段可能返回 null,表示取不到有效值。
示例值:[]
SrcInfoMulti Array of SrcInfo 源实例为集群时且接入为非cdb时源实例信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:[{"AccessKey":"","CcnId":"","CvmInstanceId":"","EngineVersion":"

MigrateOption

迁移任务配置选项

被如下接口引用:CreateMigrateJob, DescribeMigrateJobs, ModifyMigrateJob。

名称 类型 必选 描述
RunMode Integer 任务运行模式,值包括:1-立即执行,2-定时执行
ExpectTime Timestamp 期望执行时间,当runMode=2时,该字段必填,时间格式:yyyy-mm-dd hh:mm:ss
MigrateType Integer 数据迁移类型,值包括:1-结构迁移,2-全量迁移,3-全量+增量迁移
MigrateObject Integer 迁移对象,1-整个实例,2-指定库表
ConsistencyType Integer 抽样数据一致性检测参数,1-未配置,2-全量检测,3-抽样检测, 4-仅校验不一致表,5-不检测
IsOverrideRoot Integer 是否用源库Root账户覆盖目标库,值包括:0-不覆盖,1-覆盖,选择库表或者结构迁移时应该为0
ExternParams String 不同数据库用到的额外参数.以JSON格式描述.
Redis可定义如下的参数:
{
"ClientOutputBufferHardLimit":512, 从机缓冲区的硬性容量限制(MB)
"ClientOutputBufferSoftLimit":512, 从机缓冲区的软性容量限制(MB)
"ClientOutputBufferPersistTime":60, 从机缓冲区的软性限制持续时间(秒)
"ReplBacklogSize":512, 环形缓冲区容量限制(MB)
"ReplTimeout":120, 复制超时时间(秒)
}
MongoDB可定义如下的参数:
{
'SrcAuthDatabase':'admin',
'SrcAuthFlag': "1",
'SrcAuthMechanism':"SCRAM-SHA-1"
}
MySQL暂不支持额外参数设置。
ConsistencyParams ConsistencyParams 仅用于“抽样数据一致性检测”,ConsistencyType配置为抽样检测时,必选

MigrateStepDetailInfo

迁移中的步骤信息

被如下接口引用:DescribeMigrateJobs。

名称 类型 描述
StepNo Integer 步骤序列
StepName String 步骤展现名称
StepId String 步骤英文标识
Status Integer 步骤状态:0-默认值,1-成功,2-失败,3-执行中,4-未执行
StartTime String 当前步骤开始的时间,格式为"yyyy-mm-dd hh:mm:ss",该字段不存在或者为空是无意义
注意:此字段可能返回 null,表示取不到有效值。

SrcInfo

源实例信息

被如下接口引用:CreateMigrateJob, DescribeMigrateJobs, ModifyMigrateJob。

名称 类型 必选 描述
AccessKey String 阿里云AccessKey。源库是阿里云RDS5.6适用
Ip String 实例的IP地址
Port Integer 实例的端口
User String 实例的用户名
Password String 实例的密码
RdsInstanceId String 阿里云RDS实例ID。源库是阿里云RDS5.6/5.6适用
CvmInstanceId String CVM实例短ID,格式如:ins-olgl39y8,与云服务器控制台页面显示的实例ID相同。如果是CVM自建实例,需要传递此字段
UniqDcgId String 专线网关ID,格式如:dcg-0rxtqqxb
VpcId String 私有网络ID,格式如:vpc-92jblxto
SubnetId String 私有网络下的子网ID,格式如:subnet-3paxmkdz
UniqVpnGwId String VPN网关ID,格式如:vpngw-9ghexg7q
InstanceId String 数据库实例ID,格式如:cdb-powiqx8q
Region String 地域英文名,如:ap-guangzhou
Supplier String 当实例为RDS实例时,填写为aliyun, 其他情况均填写others
CcnId String 云联网ID,如:ccn-afp6kltc
注意:此字段可能返回 null,表示取不到有效值。
EngineVersion String 数据库版本,当实例为RDS实例时才有效,格式如:5.6或者5.7,默认为5.6

SubsErr

查询订阅配置的错误信息

被如下接口引用:DescribeSubscribeConf。

名称 类型 描述
Message String 错误信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:error

SubscribeInfo

订阅实例信息

被如下接口引用:DescribeSubscribes。

名称 类型 必选 描述
SubscribeId String 数据订阅的实例ID
SubscribeName String 数据订阅实例的名称
ChannelId String 数据订阅实例绑定的通道ID
Product String 数据订阅绑定实例对应的产品名称
InstanceId String 数据订阅实例绑定的数据库实例ID
InstanceStatus String 数据订阅实例绑定的数据库实例状态
SubsStatus String 数据订阅实例的配置状态,unconfigure - 未配置, configuring - 配置中,configured - 已配置
ModifyTime String 上次修改时间
CreateTime String 创建时间
IsolateTime String 隔离时间
ExpireTime String 到期时间
OfflineTime String 下线时间
ConsumeStartTime String 最近一次修改的消费时间起点,如果从未修改则为零值
Region String 数据订阅实例所属地域
PayType Integer 计费方式,0 - 包年包月,1 - 按量计费
Vip String 数据订阅实例的Vip
Vport Integer 数据订阅实例的Vport
UniqVpcId String 数据订阅实例Vip所在VPC的唯一ID
UniqSubnetId String 数据订阅实例Vip所在子网的唯一ID
Status String 数据订阅实例的状态,creating - 创建中,normal - 正常运行,isolating - 隔离中,isolated - 已隔离,offlining - 下线中,offline - 已下线
SdkConsumedTime String SDK最后一条确认消息的时间戳,如果SDK一直消费,也可以作为SDK当前消费时间点
Tags Array of TagItem 标签
注意:此字段可能返回 null,表示取不到有效值。
AutoRenewFlag Integer 自动续费标识。0-不自动续费,1-自动续费
注意:此字段可能返回 null,表示取不到有效值。
SubscribeVersion String 订阅实例版本;txdts-旧版数据订阅,kafka-kafka版本数据订阅
注意:此字段可能返回 null,表示取不到有效值。

SubscribeObject

数据订阅的对象

被如下接口引用:ActivateSubscribe, DescribeSubscribeConf, ModifySubscribeObjects。

名称 类型 必选 描述
ObjectsType Integer 数据订阅对象的类型,0-数据库,1-数据库内的表
注意:此字段可能返回 null,表示取不到有效值。
DatabaseName String 订阅数据库的名称
注意:此字段可能返回 null,表示取不到有效值。
TableNames Array of String 订阅数据库中表名称数组
注意:此字段可能返回 null,表示取不到有效值。

SubscribeRegionConf

数据订阅地域售卖信息

被如下接口引用:DescribeRegionConf。

名称 类型 描述
RegionName String 地域名称,如广州
注意:此字段可能返回 null,表示取不到有效值。
Region String 地区标识,如ap-guangzhou
注意:此字段可能返回 null,表示取不到有效值。
Area String 地域名称,如华南地区
注意:此字段可能返回 null,表示取不到有效值。
IsDefaultRegion Integer 是否为默认地域,0 - 不是,1 - 是的
注意:此字段可能返回 null,表示取不到有效值。
Status Integer 当前地域的售卖情况,1 - 正常, 2-灰度,3 - 停售
注意:此字段可能返回 null,表示取不到有效值。

TagFilter

标签过滤

被如下接口引用:DescribeMigrateJobs, DescribeSubscribes。

名称 类型 必选 描述
TagKey String 标签键值
TagValue Array of String 标签值

TagItem

标签

被如下接口引用:CreateMigrateJob, CreateSubscribe, DescribeMigrateJobs, DescribeSubscribeConf, DescribeSubscribes。

名称 类型 必选 描述
TagKey String 标签键值
TagValue String 标签值
注意:此字段可能返回 null,表示取不到有效值。