Documentation
¶
Index ¶
- type Agent
- type AgentAttributes
- type AgentBackupSchedule
- type AgentDataSource
- type AgentPlan
- type AgentReg
- type AgentTasks
- type BackupBriefInfo
- type BackupFile
- type BackupObjects
- type BackupPlan
- type BackupPlanAttributes
- type BackupSchedule
- type BinlogBackup
- type Charge
- type ChargeSpec
- type CreateBackupPlan
- type DataSourceEntry
- type EngineRelatedConfig
- type Filter
- type InitBackupPlan
- type LogicalBackups
- type ModifyBackupObjects
- type ModifyBackupPolicy
- type ModifySourceEndpoint
- type ModifyTask
- type PhysicalBackups
- type PrecheckPlan
- type ReportPrecheck
- type ReportTask
- type ResourceInfo
- type RestoreFullBackup
- type RestoreSourceEndpoint
- type RestoreTask
- type RestoreTimePoint
- type ShouldDelBackups
- type Sort
- type SourceEndpoint
- type Tag
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AgentAttributes ¶
type AgentAttributes struct {
/* agent Id (Optional) */
AgentId string `json:"agentId"`
/* 主机名称 (Optional) */
HostName string `json:"hostName"`
/* 主机IP (Optional) */
Ip string `json:"ip"`
/* agent 的状态 (Optional) */
AgentStatus string `json:"agentStatus"`
/* 该Agent管理的数据源的具体信息,同一个Agent可以支持多种不同的数据源类型 (Optional) */
DataSource []DataSourceEntry `json:"dataSource"`
}
type AgentBackupSchedule ¶
type AgentDataSource ¶
type AgentDataSource struct {
/* (Optional) */
Id string `json:"id"`
/* (Optional) */
DsType string `json:"dsType"`
/* 源数据库的端口 (Optional) */
Port int `json:"port"`
/* 源数据库的账号 (Optional) */
AccountName string `json:"accountName"`
/* 源数据库的密码 (Optional) */
Password string `json:"password"`
/* (Optional) */
CnfPath string `json:"cnfPath"`
}
type AgentPlan ¶
type AgentPlan struct {
/* (Optional) */
Id string `json:"id"`
/* 备份方式 (Optional) */
BackupType string `json:"backupType"`
/* (Optional) */
Schedule AgentBackupSchedule `json:"schedule"`
/* (Optional) */
Datasource AgentDataSource `json:"datasource"`
/* (Optional) */
Databases []string `json:"databases"`
/* (Optional) */
Tables []string `json:"tables"`
/* (Optional) */
UseBinlog bool `json:"useBinlog"`
}
type AgentTasks ¶
type BackupBriefInfo ¶
type BackupFile ¶
type BackupFile struct {
/* */
PlanId string `json:"planId"`
/* */
BackupType string `json:"backupType"`
/* */
DataSourceId string `json:"dataSourceId"`
/* 0代表自动备份 1代表的是手动触发备份 */
IsManual int `json:"isManual"`
/* */
Filename string `json:"filename"`
/* */
ExtInfo string `json:"extInfo"`
/* */
Path string `json:"path"`
/* */
Size int64 `json:"size"`
/* (Optional) */
SrcSize int64 `json:"srcSize"`
/* */
StorageType string `json:"storageType"`
/* */
TaskId string `json:"taskId"`
/* (Optional) */
BinlogStartTime string `json:"binlogStartTime"`
/* (Optional) */
BinlogEndTime string `json:"binlogEndTime"`
/* (Optional) */
BinlogStartPos int `json:"binlogStartPos"`
/* (Optional) */
BinlogEndPos int `json:"binlogEndPos"`
/* (Optional) */
Version string `json:"version"`
}
type BackupObjects ¶
type BackupPlan ¶
type BackupPlan struct {
/* 备份计划名称 (Optional) */
BackupPlanName string `json:"backupPlanName"`
/* 备份计划Id (Optional) */
BackupPlanId string `json:"backupPlanId"`
/* 备份计划状态 (Optional) */
BackupPlanStatus string `json:"backupPlanStatus"`
/* 源实例引擎类型 (Optional) */
SourceEngine string `json:"sourceEngine"`
/* 备份计划创建时间, UTC 时间格式 (Optional) */
CreateTime string `json:"createTime"`
/* 计费信息 (Optional) */
Charge Charge `json:"charge"`
}
type BackupPlanAttributes ¶
type BackupPlanAttributes struct {
/* 备份计划名称 (Optional) */
BackupPlanName string `json:"backupPlanName"`
/* 备份计划Id (Optional) */
BackupPlanId string `json:"backupPlanId"`
/* 备份计划状态 (Optional) */
BackupPlanStatus string `json:"backupPlanStatus"`
/* 备份计划状态原因,仅状态为ERROR时返回;其他状态时返回空字符串 (Optional) */
ErrorMessages string `json:"errorMessages"`
/* 源实例引擎类型 (Optional) */
SourceEngine string `json:"sourceEngine"`
/* DBS服务包类型是枚举值, dbs.common.package 表示基础服务包,不含备份流量 (Optional) */
ServicePackage string `json:"servicePackage"`
/* 备份计划创建时间, UTC 时间格式 (Optional) */
CreateTime string `json:"createTime"`
/* 计费信息 (Optional) */
Charge Charge `json:"charge"`
/* 备份方式 (Optional) */
BackupType string `json:"backupType"`
/* 是否开启日志备份;true:开启;false:关闭 (Optional) */
EnableBackupLogs bool `json:"enableBackupLogs"`
/* 日志备份保存天数,支持7-3650 天,默认7天 (Optional) */
LogBackupRetentionPeriod int `json:"logBackupRetentionPeriod"`
/* 全量备份保存天数,支持7-3650 天,默认7天 (Optional) */
FullBackupRetentionPeriod int `json:"fullBackupRetentionPeriod"`
/* 全量备份的备份周期 (Optional) */
FullBackupSchedule BackupSchedule `json:"fullBackupSchedule"`
/* 备份目标的详细信息 (Optional) */
SourceEndpoint SourceEndpoint `json:"sourceEndpoint"`
/* 逻辑备份中要备份的对象的信息,物理备份无须该信息 (Optional) */
BackupObjects BackupObjects `json:"backupObjects"`
}
type BackupSchedule ¶
type BinlogBackup ¶
type BinlogBackup struct {
/* binlog日志备份ID (Optional) */
BackupId string `json:"backupId"`
/* binlog日志大小,单位Byte (Optional) */
SizeByte int64 `json:"sizeByte"`
/* 是否手动触发的备份任务 0代表自动触发的备份 1代表手动触发的 (Optional) */
IsManual int `json:"isManual"`
/* binlog开始时间,UTC时间格式:YYYY-MM-DDTHH:mm:ssZ (Optional) */
BinlogStartTime string `json:"binlogStartTime"`
/* binlog结束时间,UTC时间格式:YYYY-MM-DDTHH:mm:ssZ (Optional) */
BinlogEndTime string `json:"binlogEndTime"`
/* 备份状态 成功-COMPLETED 运行中-BUILDING 失败-ERROR (Optional) */
Status string `json:"status"`
/* 备份任务状态原因,仅备份状态为 ERROR 时返回;其他状态返回空字符串 (Optional) */
ErrorMessages string `json:"errorMessages"`
/* 源数据库的连接地址,可以为IP或者域名 (Optional) */
Ip string `json:"ip"`
/* 源数据库的端口 (Optional) */
Port int `json:"port"`
}
type Charge ¶
type Charge struct {
/* 计费模式枚举值prepaid_by_duration表示预付费,postpaid_by_usage表示按用量后付费,postpaid_by_duration表示按配置后付费,默认为postpaid_by_duration (Optional) */
ChargeMode string `json:"chargeMode"`
/* 计费状态,取值为 normal表示正常,overdue表示预付费已到期,arrear表示欠费 (Optional) */
ChargeStatus string `json:"chargeStatus"`
/* 计费开始时间,遵循ISO8601标准,使用UTC时间,格式为:YYYY-MM-DDTHH:mm:ssZ (Optional) */
ChargeStartTime string `json:"chargeStartTime"`
/* 过期时间,预付费资源的到期时间,遵循ISO8601标准,使用UTC时间,格式为:YYYY-MM-DDTHH:mm:ssZ,后付费资源此字段内容为空 (Optional) */
ChargeExpiredTime string `json:"chargeExpiredTime"`
/* 预期释放时间,资源的预期释放时间,预付费/后付费资源均有此值,遵循ISO8601标准,使用UTC时间,格式为:YYYY-MM-DDTHH:mm:ssZ (Optional) */
ChargeRetireTime string `json:"chargeRetireTime"`
}
type ChargeSpec ¶
type ChargeSpec struct {
/* 计费模式,取值为:prepaid_by_duration,postpaid_by_usage或postpaid_by_duration,prepaid_by_duration表示预付费,postpaid_by_usage表示按用量后付费,postpaid_by_duration表示按配置后付费,默认为postpaid_by_duration.请参阅具体产品线帮助文档确认该产品线支持的计费类型 (Optional) */
ChargeMode *string `json:"chargeMode"`
/* 预付费计费单位,预付费必填,当chargeMode为prepaid_by_duration时有效,取值为:month、year,默认为month (Optional) */
ChargeUnit *string `json:"chargeUnit"`
/* 预付费计费时长,预付费必填,当chargeMode取值为prepaid_by_duration时有效。当chargeUnit为month时取值为:1~9,当chargeUnit为year时取值为:1、2、3 (Optional) */
ChargeDuration *int `json:"chargeDuration"`
}
type CreateBackupPlan ¶
type CreateBackupPlan struct {
/* 备份计划名称,支持中文、数字、大小写字母、英文下划线“_”、减号“-”,且不少于2字符不超过64字符 */
Name string `json:"name"`
/* DBS服务包类型是枚举值, dbs.common.package 表示基础服务包,不含备份流量 */
ServicePackage string `json:"servicePackage"`
/* 购买规格 */
ChargeSpec ChargeSpec `json:"chargeSpec"`
}
type DataSourceEntry ¶
type DataSourceEntry struct {
/* 引擎类型 MySQL5 MySQL8 MariaDB Percona (Optional) */
SourceEngine string `json:"sourceEngine"`
/* 源数据库的网络类型 PublicAccess 和 RDS (Optional) */
NetworkType string `json:"networkType"`
/* 源数据库的端口 (Optional) */
Port int `json:"port"`
/* 数据库的账号 (Optional) */
AccountNames []string `json:"accountNames"`
/* 不同数据库引擎独有的配置参数 (Optional) */
EngineRelatedConfig EngineRelatedConfig `json:"engineRelatedConfig"`
}
type EngineRelatedConfig ¶
type EngineRelatedConfig struct {
/* MySQL数据库配置文件路径 */
MyconfPath string `json:"myconfPath"`
}
type InitBackupPlan ¶
type InitBackupPlan struct {
/* 引擎类型 MySQL5 MySQL8 MariaDB Percona */
SourceEngine string `json:"sourceEngine"`
/* 备份方式,支持物理备份或逻辑备份 */
BackupType string `json:"backupType"`
/* 是否开启日志备份;true:开启;false:关闭 (Optional) */
EnableBackupLogs bool `json:"enableBackupLogs"`
/* 日志备份保存天数,支持7-3650 天,默认7天 (Optional) */
LogBackupRetentionPeriod int `json:"logBackupRetentionPeriod"`
/* 全量备份保存天数,支持7-3650 天,默认7天 (Optional) */
FullBackupRetentionPeriod int `json:"fullBackupRetentionPeriod"`
/* 全量备份的备份周期 */
FullBackupSchedule BackupSchedule `json:"fullBackupSchedule"`
/* 备份目标的详细信息 */
SourceEndpoint SourceEndpoint `json:"sourceEndpoint"`
/* 逻辑备份中要备份的对象的信息,物理备份无须该信息 (Optional) */
BackupObjects BackupObjects `json:"backupObjects"`
/* 是否开启日志备份;true:开启;false:关闭 */
CreateNewEndpoint bool `json:"createNewEndpoint"`
}
type LogicalBackups ¶
type LogicalBackups struct {
/* 全量备份ID (Optional) */
BackupId string `json:"backupId"`
/* 备份开始时间,UTC时间格式:YYYY-MM-DDTHH:mm:ssZ (Optional) */
BackupStartTime string `json:"backupStartTime"`
/* 备份结束时间,UTC时间格式:YYYY-MM-DDTHH:mm:ssZ (Optional) */
BackupEndTime string `json:"backupEndTime"`
/* 备份到期时间,UTC时间格式:YYYY-MM-DDTHH:mm:ssZ (Optional) */
BackupExpiretime string `json:"backupExpiretime"`
/* 要备份的对象名称, 如果不填、为空或为星号,表示对整个数据库进行备份 (Optional) */
Database string `json:"database"`
/* 该全量备份中包含的备份对象,仅当备份为逻辑备份时返回 (Optional) */
Objects []string `json:"objects"`
/* 备份大小,单位:Byte (Optional) */
SizeByte int64 `json:"sizeByte"`
/* 是否手动触发的备份任务 0代表自动触发的备份 1代表手动触发的 (Optional) */
IsManual int `json:"isManual"`
/* 备份状态 成功-COMPLETED 运行中-BUILDING 失败-ERROR (Optional) */
Status string `json:"status"`
/* 错误信息,仅sucess为false时返回 (Optional) */
ErrorMessages string `json:"errorMessages"`
/* 源数据库的连接地址,可以为IP或者域名 (Optional) */
Ip string `json:"ip"`
/* 源数据库的端口 (Optional) */
Port int `json:"port"`
}
type ModifyBackupObjects ¶
type ModifyBackupPolicy ¶
type ModifyBackupPolicy struct {
/* 周期类型,目前仅支持weekly (Optional) */
FullBackupPeriod string `json:"fullBackupPeriod"`
/* 进行全量备份的日期, 备份周期为 weekly 时可以取 0-6 分别对应的是周日到周六 (Optional) */
FullBackupDays []int `json:"fullBackupDays"`
/* 全量备份的开始时间,精确到分,UTC时间格式,例如:23:30Z (Optional) */
FullBackupStartTime string `json:"fullBackupStartTime"`
/* 全量备份保存天数,支持7-3650 天,默认7天 (Optional) */
FullBackupRetentionPeriod int `json:"fullBackupRetentionPeriod"`
/* 日志备份保存天数,支持7-3650 天,默认7天 (Optional) */
LogBackupRetentionPeriod int `json:"logBackupRetentionPeriod"`
/* 是否开启日志备份;true:开启;false:关闭 (Optional) */
EnableBackupLogs bool `json:"enableBackupLogs"`
}
type ModifySourceEndpoint ¶
type ModifySourceEndpoint struct {
/* 源数据库的账号 (Optional) */
AccountName string `json:"accountName"`
/* 源数据库的密码 (Optional) */
Password string `json:"password"`
/* 不同数据库引擎独有的配置参数 (Optional) */
EngineRelatedConfig EngineRelatedConfig `json:"engineRelatedConfig"`
}
type ModifyTask ¶
type PhysicalBackups ¶
type PhysicalBackups struct {
/* 全量备份ID (Optional) */
BackupId string `json:"backupId"`
/* 备份开始时间,UTC时间格式:YYYY-MM-DDTHH:mm:ssZ (Optional) */
BackupStartTime string `json:"backupStartTime"`
/* 备份结束时间,UTC时间格式:YYYY-MM-DDTHH:mm:ssZ (Optional) */
BackupEndTime string `json:"backupEndTime"`
/* 备份到期时间,UTC时间格式:YYYY-MM-DDTHH:mm:ssZ (Optional) */
BackupExpiredTime string `json:"backupExpiredTime"`
/* 备份大小,单位:Byte (Optional) */
SizeByte int64 `json:"sizeByte"`
/* 是否手动触发的备份任务 0代表自动触发的备份 1代表手动触发的 (Optional) */
IsManual int `json:"isManual"`
/* 备份状态 成功-COMPLETED 运行中-BUILDING 失败-ERROR (Optional) */
Status string `json:"status"`
/* 错误信息,仅sucess为false时返回 (Optional) */
ErrorMessages string `json:"errorMessages"`
/* 源数据库的连接地址,可以为IP或者域名 (Optional) */
Ip string `json:"ip"`
/* 源数据库的端口 (Optional) */
Port int `json:"port"`
}
type PrecheckPlan ¶
type PrecheckPlan struct {
/* 预检查任务Id (Optional) */
JobId string `json:"jobId"`
/* 预检查任务项 (Optional) */
CheckItem string `json:"checkItem"`
/* 预检查任务项的描述 (Optional) */
Description string `json:"description"`
/* 是否成功 (Optional) */
Success bool `json:"success"`
/* 错误信息,仅sucess为false时返回 (Optional) */
ErrorMessages string `json:"errorMessages"`
}
type ReportPrecheck ¶
type ReportPrecheck struct {
/* */
Plan interface{} `json:"plan"`
/* 预检查任务项 */
CheckItem string `json:"checkItem"`
/* 是否成功 */
Success bool `json:"success"`
/* 错误信息,仅sucess为false时返回 (Optional) */
ErrorMessages string `json:"errorMessages"`
/* */
StartTime string `json:"startTime"`
/* */
EndTime string `json:"endTime"`
}
type ReportTask ¶
type ReportTask struct {
/* */
Agent interface{} `json:"agent"`
/* */
TaskType string `json:"taskType"`
/* (Optional) */
PlanId string `json:"planId"`
/* */
Progress int `json:"progress"`
/* (Optional) */
StartTime string `json:"startTime"`
/* (Optional) */
EndTime string `json:"endTime"`
/* (Optional) */
Success bool `json:"success"`
/* (Optional) */
ErrorMessage string `json:"errorMessage"`
}
type ResourceInfo ¶
type RestoreFullBackup ¶
type RestoreFullBackup struct {
/* 用于恢复的备份Id,仅限于本备份计划生成的备份 */
BackupId string `json:"backupId"`
/* 备份实例的数据源信息 */
SourceEndpoint RestoreSourceEndpoint `json:"sourceEndpoint"`
/* 是否是新建数据源;true:是;false:不是 */
CreateNewEndpoint bool `json:"createNewEndpoint"`
}
type RestoreSourceEndpoint ¶
type RestoreSourceEndpoint struct {
/* 备份代理的ID,仅初始化时可设置,设置完成并开始备份后,不可修改 */
BackupAgentId string `json:"backupAgentId"`
/* 源数据库的网络类型 PublicAccess 和 RDS */
NetworkType string `json:"networkType"`
/* 源数据库的端口,仅初始化时可设置,设置完成并开始备份后,不可修改 */
Port int `json:"port"`
/* 源数据库的账号 */
AccountName string `json:"accountName"`
/* 源数据库的密码 (Optional) */
Password *string `json:"password"`
/* 不同数据库引擎独有的配置参数 (Optional) */
EngineRelatedConfig *EngineRelatedConfig `json:"engineRelatedConfig"`
}
type RestoreTask ¶
type RestoreTask struct {
/* 恢复任务ID (Optional) */
RestoreTaskId string `json:"restoreTaskId"`
/* 恢复类型,逻辑恢复 LogicalRestore, 物理恢复 PhysicalRestore, 时间点恢复 TimepointRestore (Optional) */
RestoreType string `json:"restoreType"`
/* 恢复后的数据时间点, UTC时间格式:YYYY-MM-DDTHH:mm:ssZ (Optional) */
DataTimestamp string `json:"dataTimestamp"`
/* 恢复开始时间,UTC时间格式:YYYY-MM-DDTHH:mm:ssZ (Optional) */
RestoreStartTime string `json:"restoreStartTime"`
/* 恢复结束时间,UTC时间格式:YYYY-MM-DDTHH:mm:ssZ (Optional) */
RestoreEndTime string `json:"restoreEndTime"`
/* 备份大小,单位:Byte (Optional) */
SizeByte int64 `json:"sizeByte"`
/* 恢复状态 成功-COMPLETED 运行中-RESTORING 失败-ERROR (Optional) */
Status string `json:"status"`
/* 错误信息,仅状态为 ERROR 时返回;其他状态返回空字符串 (Optional) */
ErrorMessages string `json:"errorMessages"`
/* 要恢复到的主机的名称 (Optional) */
HostName string `json:"hostName"`
/* 要恢复到的主机的地址,可以为IP或者域名 (Optional) */
Ip string `json:"ip"`
/* 数据库的端口 (Optional) */
Port int `json:"port"`
}
type RestoreTimePoint ¶
type RestoreTimePoint struct {
/* 数据库实例要恢复到的时间点,UTC时间格式:YYYY-MM-DDTHH:mm:ssZ */
RestoreTime string `json:"restoreTime"`
/* 备份实例的数据源信息 */
SourceEndpoint RestoreSourceEndpoint `json:"sourceEndpoint"`
/* 是否是新建数据源;true:是;false:不是 */
CreateNewEndpoint bool `json:"createNewEndpoint"`
}
type ShouldDelBackups ¶
type ShouldDelBackups struct {
/* (Optional) */
BackupType string `json:"backupType"`
/* (Optional) */
TotalCount int `json:"totalCount"`
/* (Optional) */
BackupFiles []BackupBriefInfo `json:"backupFiles"`
}
type SourceEndpoint ¶
type SourceEndpoint struct {
/* 源数据库的网络类型 PublicAccess 和 RDS */
NetworkType string `json:"networkType"`
/* 源数据库的端口 */
Port int `json:"port"`
/* 备份代理的ID,仅初始化时可设置,设置完成并开始备份后,不可修改 */
BackupAgentId string `json:"backupAgentId"`
/* 源数据库的账号 */
AccountName string `json:"accountName"`
/* 源数据库的密码 */
Password string `json:"password"`
/* 不同数据库引擎独有的配置参数 */
EngineRelatedConfig *EngineRelatedConfig `json:"engineRelatedConfig"`
}
Source Files
¶
- Agent.go
- AgentAttributes.go
- AgentBackupSchedule.go
- AgentDataSource.go
- AgentPlan.go
- AgentReg.go
- AgentTasks.go
- BackupBriefInfo.go
- BackupFile.go
- BackupObjects.go
- BackupPlan.go
- BackupPlanAttributes.go
- BackupSchedule.go
- BinlogBackup.go
- Charge.go
- ChargeSpec.go
- CreateBackupPlan.go
- DataSourceEntry.go
- EngineRelatedConfig.go
- Filter.go
- InitBackupPlan.go
- LogicalBackups.go
- ModifyBackupObjects.go
- ModifyBackupPolicy.go
- ModifySourceEndpoint.go
- ModifyTask.go
- PhysicalBackups.go
- PrecheckPlan.go
- ReportPrecheck.go
- ReportTask.go
- ResourceInfo.go
- RestoreFullBackup.go
- RestoreSourceEndpoint.go
- RestoreTask.go
- RestoreTimePoint.go
- ShouldDelBackups.go
- Sort.go
- SourceEndpoint.go
- Tag.go
Click to show internal directories.
Click to hide internal directories.