数据结构

BackupColumnItem

备份列对象

被如下接口引用：ConfigureBackupPlan。

名称	类型	必选	描述
ColumnName	String	否	列名。 示例值：id
NewColumnName	String	否	重命名后的列名。 示例值：new_id

BackupEndpoint

备份源实例详情

被如下接口引用：ConfigureBackupPlan, CreateConnectTestJob。

名称	类型	必选	描述
DatabaseType	String	是	数据库类型。目前支持的值["mysql", "mariadb", "percona"]。注意，该值必须和备份计划的类型一致。 示例值：mysql
AccessType	String	是	实例接入类型，支持的值包括： "extranet" - 外网; "cvm" - cvm自建实例; "dcg" - 专线接入; "vpncloud" - 云vpn接入; "cdb" - 腾讯云数据库实例; "ccn" - 云联网接入。 示例值：cdb
UserName	String	是	用户名。 示例值：user_test
Password	String	是	登录密码。 示例值：user_paawd
Region	String	是	接入地域。 示例值：ap-guangzhou
Supplier	String	是	服务提供商，支持的值包括["aliyun", "aws", "others"]。 示例值：others
Ip	String	否	实例 Ip。 示例值：127.0.0.1
Port	Integer	否	实例端口号。 示例值：3306
InstanceId	String	否	云数据库实例ID，格式如：cdb-qcloudtest。 示例值：cdb-xxxxxxxx
CvmInstanceId	String	否	CVM 实例ID，格式如：ins-olgl39y8，与云服务器控制台页面显示的实例ID相同。如果是CVM自建实例，需要填写该字段。 示例值：ins-xxxxxxxx
UniqDcgId	String	否	专线网关ID，格式如：dcg-0rxtqqxb。 示例值：dcg-xxxxxxxx
UniqVpnGwId	String	否	VPN网关ID，格式如：vpngw-9ghexg7q。 示例值：vpngw-xxxxxxx
VpcId	String	否	私有网络ID，格式如：vpc-92jblxto。 示例值：vpc-xxxxxxxx
SubnetId	String	否	子网ID，格式如：subnet-3paxmkdz。 示例值：subnet-xxxxxxxx
CcnId	String	否	云联网ID，如：ccn-afp6kltc。 示例值：ccn-xxxxxxxx
EngineVersion	String	否	数据库版本，当实例为 RDS 或 AWS 实例时才有效，格式如：5.6或者5.7，默认为5.6。 示例值：5.6
DBKernel	String	否	mariadb三引擎版本。 示例值：mariadb

BackupObject

备份对象

被如下接口引用：ConfigureBackupPlan。

名称	类型	必选	描述
ObjectMode	String	是	备份对象类型，可能的取值为: "all" - 整实例; "partial" - 部分对象。 示例值：all
ObjectItems	Array of BackupObjectItem	否	备份对象详情，当 ObjectMode 为 partial, 即选择部分对象备份时，该字段不能为空。 注意：此字段可能返回 null，表示取不到有效值。

BackupObjectItem

备份对象详情

被如下接口引用：ConfigureBackupPlan。

名称	类型	必选	描述
DBName	String	否	库名。 示例值：db1
NewDBName	String	否	重命名后的库名。 示例值：new_db1
SchemaName	String	否	schema 名。 示例值：schema1
NewSchemaName	String	否	重命名后的 schema 名。 示例值：new_schema1
DbMode	String	否	库选择模式，可能的取值为： "all" - 当前对象下的所有对象; "partial" - 当前对象下的部分对象。 示例值：all
TableMode	String	否	表选择模式，可能的取值为: "all" - 当前对象下的所有对象; "partial" - 当前对象下的部分对象。 示例值：all
Tables	Array of BackupTableItem	否	表对象详情。当 TableMode 为 partial，即选择部分表备份时，此参数需要填写。 注意：此字段可能返回 null，表示取不到有效值。

BackupPeriod

备份周期描述

被如下接口引用：ConfigureBackupPlan。

名称	类型	必选	描述
PeriodType	String	是	全量备份频率。目前仅支持"Weekly" - 每星期 示例值：Weekly
Day	Array of String	是	全量备份周期。取值范围为：["Monday","Tuesday","Wednesday","Thursday","Friday","Saturday","Sunday"]。 示例值：["Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]

BackupPlanInfo

备份计划信息

被如下接口引用：DescribeBackupPlans。

名称	类型	描述
Region	String	地域信息。 示例值：ap-guangzhou
BackupPlanId	String	备份计划 ID。 示例值：dbs-xxxxxxxx
BackupPlanName	String	备份计划名称。 示例值：name_test
Status	String	备份计划状态。可能的取值为： "notStarted" - 未启动; "checking" - 校验中; "checkPass" - 校验通过; "checkNotPass" - 校验未通过; "running" - 运行中; "fullBacking" - 全量备份中; "isolating" - 隔离中; "isolated" - 已隔离; "offlining" - 下线中; "offlined" - 已下线; "paused" - 已暂停。 示例值：running
DatabaseType	String	数据库类型。 示例值：mysql
AccessType	String	访问类型。可能的取值为： "extranet" - 外网; "cvm" - cvm 自建实例; "dcg" - 专线接入; "vpncloud" - 云vpn接入; "cdb" - 腾讯云数据库实例; "ccn" - 云联网。 示例值：extranet
SourceInfo	Array of String	源实例信息。 示例值：["cdb-testcloud"]
CreateTime	String	创建时间。 示例值：2022-05-23 11:12:13
ExpireTime	String	到期时间。 示例值：2022-05-23 11:12:13
OfflineTime	String	下线时间。 示例值：2022-05-23 11:12:13
InstanceClass	String	实例规格类型。可能的取值为：["micro", "small", "medium", "large", "xlarge"]。 示例值：micro
BackupMethod	String	备份方式。可能的取值为： "logical" - 逻辑备份; "physical" - 物理备份。 示例值：logical
Tags	Array of Tag	标签信息。 注意：此字段可能返回 null，表示取不到有效值。 示例值：[{"TagKey":"key","TagValue":"value"}]
AutoRenewFlag	Integer	自动续费标记。可能的取值为： 0 - 未开启自动续费; 1 - 已开启自动续费; 2 - 已关闭自动续费。 示例值：1
EnableIncrement	Boolean	是否开启增量备份标记。 示例值：1
PayType	String	付费类型。可能的取值为： "prePay" - 预付费类型; "postPay" - 后付费类型。 示例值：prePay
SetSourceInfo	Array of String	源端信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：["127.0.0.1"]

BackupStrategy

备份策略

被如下接口引用：ConfigureBackupPlan。

名称	类型	必选	描述
BackupStartTime	String	是	全量备份开始时间。周期性的全量备份将在当天该时间开始。 示例值：02:00
StorageStrategy	StorageStrategy	是	存储策略。
BackupPeriod	BackupPeriod	是	备份周期。
BackupMethod	String	否	备份方法。目前仅支持 "logical" - 逻辑备份。 示例值：logical
StrategyType	String	否	备份周期。支持的值包括： "period" - 周期性备份； "single" - 单次备份。 默认值为"period"。 示例值：period
EnableIncrement	Boolean	否	是否开启增量备份。可能的取值为["true", "false"]。默认值为"true"。 示例值：true

BackupTableItem

备份表对象

被如下接口引用：ConfigureBackupPlan。

名称	类型	必选	描述
TableName	String	否	表名。 示例值：t1
NewTableName	String	否	重命名后的表名。 示例值：new_t1
Columns	Array of BackupColumnItem	否	列对象。 注意：此字段可能返回 null，表示取不到有效值。

ConnectTestResult

连通性检测结果

被如下接口引用：DescribeConnectTestResult。

名称	类型	描述
TaskId	Integer	任务 ID 示例值：16794137
Status	String	任务状态 示例值：finished
IsPass	Integer	是否通过。0 表示未通过，1 表示通过。 示例值：1
Addr	String	源端地址 示例值：:0
SNatIp	String	源地址转换IP 注意：此字段可能返回 null，表示取不到有效值。 示例值：1.1.1.1
TestItems	Array of TestItem	检测结果集

StorageStrategy

备份存储策略。

被如下接口引用：ConfigureBackupPlan。

名称	类型	必选	描述
StorageType	String	否	存储类型。目前仅支持 "system" - DBS 内置存储。默认值为 "system"。 示例值：system
Encryption	String	否	加密方式。可能的取值为： "UnEncrypted" - 非加密存储; "SSE-COS" - 内置加密存储; 当该参数用作入参时，默认值为 "UnEncrypted"。 示例值：SSE-COS
BackupRetentionPeriod	Integer	否	日志保留时间，单位为天。取值范围为[7, 3650]，默认值为 30。 示例值：30

Tag

标签信息

被如下接口引用：CreateBackupPlan, DescribeBackupPlans。

名称	类型	必选	描述
TagKey	String	是	标签键。 示例值：key
TagValue	String	是	标签值。 示例值：value

TagFilter

标签过滤条件

被如下接口引用：DescribeBackupPlans。

名称	类型	必选	描述
TagKey	String	是	标签键。 示例值：key
TagValue	Array of String	是	标签值。 示例值：["v1","v2"]

TestItem

检测步骤详情

被如下接口引用：DescribeConnectTestResult。

名称	类型	描述
TestName	String	检测步骤名称 示例值：Telnet
Code	Integer	错误码 示例值：0
Message	String	错误信息 示例值：ok