/** * 可恢复时间区间 */ export interface ArchiveLogInterval { /** * 结束时间 注意:此字段可能返回 null,表示取不到有效值。 */ EndTime?: string; /** * 大版本 注意:此字段可能返回 null,表示取不到有效值。 */ MajorVersion?: string; /** * 小版本 注意:此字段可能返回 null,表示取不到有效值。 */ MinorVersion?: string; /** * 开始时间 注意:此字段可能返回 null,表示取不到有效值。 */ StartTime?: string; } /** * IsolateDBInstance请求参数结构体 */ export interface IsolateDBInstanceRequest { /** * 需要隔离的实例ID列表 */ InstanceIds: Array; } /** * DescribeFlow请求参数结构体 */ export type DescribeFlowRequest = null; /** * ModifyDBSBackupSetComment返回参数结构体 */ export interface ModifyDBSBackupSetCommentResponse { /** *

是否成功

*/ IsSuccess?: boolean; /** *

修改信息

*/ Msg?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyInstanceName返回参数结构体 */ export interface ModifyInstanceNameResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyDBInstanceSecurityGroups返回参数结构体 */ export interface ModifyDBInstanceSecurityGroupsResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeDBParameters请求参数结构体 */ export interface DescribeDBParametersRequest { /** * 实例 ID,形如:tdsql3-ow728lmc。 */ InstanceId: string; } /** * DescribeDBSArchiveLogs返回参数结构体 */ export interface DescribeDBSArchiveLogsResponse { /** *

归档日志列表

注意:此字段可能返回 null,表示取不到有效值。 */ Items?: Array; /** *

总数

*/ TotalCount?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeDatabaseObjects返回参数结构体 */ export interface DescribeDatabaseObjectsResponse { /** * 透传入参。 */ InstanceId: string; /** * 数据库名称。 */ DbName: string; /** * 表列表。 注意:此字段可能返回 null,表示取不到有效值。 */ Tables: Array; /** * 视图列表。 注意:此字段可能返回 null,表示取不到有效值。 */ Views: Array; /** * 存储过程列表。 注意:此字段可能返回 null,表示取不到有效值。 */ Procs: Array; /** * 函数列表。 注意:此字段可能返回 null,表示取不到有效值。 */ Funcs: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 安全出入口规则 */ export interface SecurityGroupBound { /** * 来源 IP 或 IP 段,例如192.168.0.0/16 */ CidrIp?: string; /** * 策略,ACCEPT 或者 DROP */ Action?: string; /** * 端口 */ PortRange?: string; /** * 网络协议,支持 UDP、TCP 等 */ IpProtocol?: string; } /** * CreateDBSBackup返回参数结构体 */ export interface CreateDBSBackupResponse { /** *

备份集ID

*/ BackupSetId?: number; /** *

是否成功

*/ IsSuccess?: boolean; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateDBSBackup请求参数结构体 */ export interface CreateDBSBackupRequest { /** *

备份方式:physical、snapshot 这个值和DescribeDBSBackupPolicy接口返回的backupMethod保持一致

枚举值:

  • physical: 物理备份
  • snapshot: 快照备份
*/ BackupMethod: string; /** *

备份类型:暂时只支持full

*/ BackupType: string; /** *

实例ID

*/ InstanceId: string; /** *

备份备注

*/ BackupName?: string; } /** * DestroyInstances请求参数结构体 */ export interface DestroyInstancesRequest { /** * 需要隔离的实例ID列表 */ InstanceIds: Array; } /** * DescribeDBSecurityGroups请求参数结构体 */ export interface DescribeDBSecurityGroupsRequest { /** * 实例ID。 */ InstanceId: string; } /** * ModifyDBParameters返回参数结构体 */ export interface ModifyDBParametersResponse { /** * 123 */ TaskID: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyInstanceName请求参数结构体 */ export interface ModifyInstanceNameRequest { /** * 需要修改的实例id */ InstanceId: string; /** * 修改的实例名称,要求长度1-60,允许包含中文、英文大小写、数字、-、_ */ InstanceName: string; } /** * DB参数描述 */ export interface ParamDesc { /** * 参数名字 */ Param: string; /** * 当前参数值 */ Value: string; /** * 设置过的值,参数生效后,该值和value一样。 注意:此字段可能返回 null,表示取不到有效值。 */ SetValue: string; /** * 系统默认值 */ Default: string; /** * 参数限制 注意:此字段可能返回 null,表示取不到有效值。 */ Constraint: ParamConstraint; /** * 是否有设置过值,false:没有设置过值,true:有设置过值。 */ HaveSetValue: boolean; /** * true:需要重启 */ NeedRestart: boolean; /** * 参数描述 注意:此字段可能返回 null,表示取不到有效值。 */ Description: string; } /** * ModifyAutoRenewFlag请求参数结构体 */ export interface ModifyAutoRenewFlagRequest { /** *

需要修改的实例列表

*/ InstanceIds: Array; /** *

1表示开启自动续费,0为关闭自动续费

*/ AutoRenewFlag: number; } /** * ModifyDBSBackupPolicy返回参数结构体 */ export interface ModifyDBSBackupPolicyResponse { /** *

是否成功

*/ IsSuccess?: boolean; /** *

消息

*/ Msg?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeDBSCloneInstances返回参数结构体 */ export interface DescribeDBSCloneInstancesResponse { /** *

克隆列表

注意:此字段可能返回 null,表示取不到有效值。 */ Items?: Array; /** *

总数

*/ TotalCount?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeDBSecurityGroups返回参数结构体 */ export interface DescribeDBSecurityGroupsResponse { /** * 安全组详情。 */ Groups?: Array; /** * 实例VIP 注意:此字段可能返回 null,表示取不到有效值。 */ VIP?: string; /** * 实例端口 注意:此字段可能返回 null,表示取不到有效值。 */ VPort?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeDBSArchiveLogs请求参数结构体 */ export interface DescribeDBSArchiveLogsRequest { /** *

实例ID

*/ InstanceId: string; /** *

日志记录ID

*/ ArchiveLogId?: number; /** *

结束时间

*/ EndTime?: string; /** *

备份状态:pending,running,success,failed

*/ FilterStatus?: string; /** *

条数限制

*/ Limit?: number; /** *

偏移量

*/ Offset?: number; /** *

排序字段,枚举:StartTime,EndTime,ExpiredTime,FileSize,BackupDuration

*/ OrderBy?: string; /** *

排序方式:ASC:顺序, DESC:倒序

*/ OrderType?: string; /** *

开始时间

*/ StartTime?: string; } /** * 云数据库参数信息。 */ export interface DBParamValue { /** * 参数名称 */ Param: string; /** * 参数值 */ Value: string; } /** * 数据库函数信息 */ export interface DatabaseFunction { /** * 函数名称 */ Func: string; } /** * ModifyDBSBackupPolicy请求参数结构体 */ export interface ModifyDBSBackupPolicyRequest { /** *

备份策略

*/ BackupPolicy: BackupPolicyModelInput; /** *

实例ID

*/ InstanceId: string; } /** * DescribeDBSCloneInstances请求参数结构体 */ export interface DescribeDBSCloneInstancesRequest { /** *

源实例ID

*/ SourceInstanceId: string; /** *

引擎类型

*/ DBType?: string; /** *

结束创建时间

*/ EndCreateTime?: string; /** *

克隆类型: PITR 时间点 BackupSet 备份集

*/ FilterCloneType?: string; /** *

查询数量[0,200]

*/ Limit?: number; /** *

查询偏移量[0,INF]

*/ Offset?: number; /** *

排序字段: CloneTime,CreateTime

*/ OrderBy?: string; /** *

排序类型:ASC,DESC

*/ OrderType?: string; /** *

开始创建时间

*/ StartCreateTime?: string; } /** * DescribeDatabaseObjects请求参数结构体 */ export interface DescribeDatabaseObjectsRequest { /** * 实例 ID,形如:tdsql3-42f40429. */ InstanceId: string; /** * 数据库名称,通过 DescribeDatabases 接口获取。 */ DbName: string; } /** * DescribeDBSAvailableRecoveryTime返回参数结构体 */ export interface DescribeDBSAvailableRecoveryTimeResponse { /** *

结束时间

注意:此字段可能返回 null,表示取不到有效值。 */ EndTime?: string; /** *

可恢复时间区间

注意:此字段可能返回 null,表示取不到有效值。 */ Intervals?: Array; /** *

开始时间

注意:此字段可能返回 null,表示取不到有效值。 */ StartTime?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 修改备份策略对象 */ export interface BackupPolicyModelInput { /** *

备份结束时间

*/ BackupEndTime?: string; /** *

备份方式 physical 物理备份 snapshot 快照备份

*/ BackupMethod?: string; /** *

备份开始时间

*/ BackupStartTime?: string; /** *

是否开启全量备份

*/ EnableFull?: number; /** *

是否开启日志备份

*/ EnableLog?: number; /** *

全备保留时间,目前只能设置7天

*/ FullRetentionPeriod?: number; /** *

实例ID

*/ InstanceId?: string; /** *

日志保留天数,目前只能设置保留7天

*/ LogRetentionPeriod?: number; /** *

一周的哪几天进行备份

*/ PeriodTime?: string; /** *

存储类型:COS,SNAPSHOT

枚举值:
  • COS: COS存储
  • SNAPSHOT: 云盘快照
*/ StorageType?: string; } /** * ModifyAutoRenewFlag返回参数结构体 */ export interface ModifyAutoRenewFlagResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DestroyInstances返回参数结构体 */ export interface DestroyInstancesResponse { /** * 解除隔离成功实例Id列表 */ SuccessInstanceIds: Array; /** * 解除隔离失败实例Id列表 */ FailedInstanceIds: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeDBParameters返回参数结构体 */ export interface DescribeDBParametersResponse { /** * 实例 ID,形如:tdsql3-ow728lmc。 */ InstanceId: string; /** * 请求实例的当前参数值 */ Params: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 安全组详情 */ export interface SecurityGroup { /** * 项目ID */ ProjectId?: number; /** * 创建时间,时间格式:yyyy-mm-dd hh:mm:ss */ CreateTime?: string; /** * 安全组ID */ SecurityGroupId?: string; /** * 安全组名称 */ SecurityGroupName?: string; /** * 安全组备注 */ SecurityGroupRemark?: string; /** * 入站规则 */ Inbound?: Array; /** * 出站规则 */ Outbound?: Array; } /** * IsolateDBInstance返回参数结构体 */ export interface IsolateDBInstanceResponse { /** * 隔离成功实例Id列表 */ SuccessInstanceIds: Array; /** * 隔离失败实例Id列表 */ FailedInstanceIds: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeDBSAvailableRecoveryTime请求参数结构体 */ export interface DescribeDBSAvailableRecoveryTimeRequest { /** *

实例ID

*/ InstanceId: string; /** *

备份集ID,值来自 DescribeDBSBackupSets 接口返回

*/ BackupSetId?: number; } /** * 数据库表信息 */ export interface DatabaseTable { /** * 表名 */ Table: string; } /** * DeleteDBSBackupSets返回参数结构体 */ export interface DeleteDBSBackupSetsResponse { /** *

本次实际删除的备份数量

*/ Deleted?: number; /** *

是否全部删除成功

*/ IsSuccess?: boolean; /** *

需要删除的备份总数

*/ Total?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeFlow返回参数结构体 */ export interface DescribeFlowResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 约束类型值的范围 */ export interface ConstraintRange { /** * 约束类型为section时的最小值 */ Min: string; /** * 约束类型为section时的最大值 */ Max: string; } /** * CancelIsolateDBInstances返回参数结构体 */ export interface CancelIsolateDBInstancesResponse { /** * 解除隔离成功实例Id列表 */ SuccessInstanceIds: Array; /** * 解除隔离失败实例Id列表 */ FailedInstanceIds: Array; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 数据库视图信息 */ export interface DatabaseView { /** * 视图名称 */ View: string; } /** * CancelIsolateDBInstances请求参数结构体 */ export interface CancelIsolateDBInstancesRequest { /** * 需要隔离的实例ID列表 */ InstanceIds: Array; } /** * ModifyDBSBackupSetComment请求参数结构体 */ export interface ModifyDBSBackupSetCommentRequest { /** *

实例ID

*/ InstanceId: string; /** *

备份集ID,值来自 DescribeDBSBackupSets 接口返回

*/ BackupSetId: number; /** *

备份备注

*/ NewBackupName: string; } /** * 数据库存储过程信息 */ export interface DatabaseProcedure { /** * 存储过程名称 */ Proc: string; } /** * 归档日志对象 */ export interface ArchiveLogModel { /** * 归档日志ID 注意:此字段可能返回 null,表示取不到有效值。 */ ArchiveLogId?: number; /** * 备份耗时 注意:此字段可能返回 null,表示取不到有效值。 */ BackupDuration?: number; /** * 备份集状态 注意:此字段可能返回 null,表示取不到有效值。 */ BackupStatus?: string; /** * 备份结束时间 注意:此字段可能返回 null,表示取不到有效值。 */ EndTime?: string; /** * 错误信息 注意:此字段可能返回 null,表示取不到有效值。 */ ErrorMessage?: string; /** * 过期时间 注意:此字段可能返回 null,表示取不到有效值。 */ ExpiredTime?: string; /** * 备份文件名 注意:此字段可能返回 null,表示取不到有效值。 */ FileName?: string; /** * 备份集文件大小,单位Byte 注意:此字段可能返回 null,表示取不到有效值。 */ FileSize?: number; /** * 实例ID 注意:此字段可能返回 null,表示取不到有效值。 */ InstanceId?: string; /** * 备份开始时间 注意:此字段可能返回 null,表示取不到有效值。 */ StartTime?: string; } /** * 参数约束 */ export interface ParamConstraint { /** * 约束类型,如枚举enum,区间section */ Type: string; /** * 约束类型为enum时的可选值列表 注意:此字段可能返回 null,表示取不到有效值。 */ Enum: string; /** * 约束类型为section时的范围 注意:此字段可能返回 null,表示取不到有效值。 */ Range: ConstraintRange; /** * 约束类型为string时的可选值列表 注意:此字段可能返回 null,表示取不到有效值。 */ String: string; } /** * ModifyDBParameters请求参数结构体 */ export interface ModifyDBParametersRequest { /** * 实例 ID,形如:tdsql3-ow728lmc。 */ InstanceId: string; /** * 参数列表,每一个元素是Param和Value的组合 */ Params: Array; } /** * ModifyDBInstanceSecurityGroups请求参数结构体 */ export interface ModifyDBInstanceSecurityGroupsRequest { /** * 实例ID。 */ InstanceId: string; /** * 要修改的安全组 ID 列表,一个或者多个安全组 ID 组成的数组。 */ SecurityGroupIds: Array; } /** * DeleteDBSBackupSets请求参数结构体 */ export interface DeleteDBSBackupSetsRequest { /** *

实例ID

*/ InstanceId: string; /** *

备份集列表 ,值来自 DescribeDBSBackupSets 接口返回

*/ BackupSetIdList?: Array; } /** * 克隆实例对象 */ export interface CloneInstanceModel { /** * 克隆任务结束时间 注意:此字段可能返回 null,表示取不到有效值。 */ CloneEndTime?: string; /** * 克隆记录ID 注意:此字段可能返回 null,表示取不到有效值。 */ CloneId?: number; /** * 克隆实例类型 注意:此字段可能返回 null,表示取不到有效值。 */ CloneInsType?: string; /** * 克隆实例ID 注意:此字段可能返回 null,表示取不到有效值。 */ CloneInstanceId?: string; /** * 克隆实例是否已经删除 注意:此字段可能返回 null,表示取不到有效值。 */ CloneInstanceIsDeleted?: boolean; /** * 克隆任务进度 注意:此字段可能返回 null,表示取不到有效值。 */ CloneProgress?: number; /** * 克隆任务开始时间 注意:此字段可能返回 null,表示取不到有效值。 */ CloneStartTime?: string; /** * 克隆任务状态 注意:此字段可能返回 null,表示取不到有效值。 */ CloneStatus?: string; /** * 克隆时间 注意:此字段可能返回 null,表示取不到有效值。 */ CloneTime?: string; /** * 克隆类型 注意:此字段可能返回 null,表示取不到有效值。 */ CloneType?: string; /** * 创建时间 注意:此字段可能返回 null,表示取不到有效值。 */ CreateTime?: string; /** * 引擎类型 注意:此字段可能返回 null,表示取不到有效值。 */ DBType?: string; /** * 地域 注意:此字段可能返回 null,表示取不到有效值。 */ Region?: string; /** * 源实例ID 注意:此字段可能返回 null,表示取不到有效值。 */ SourceInstanceId?: string; }