tencentcloud-sdk-nodejs

/** * DescribeCrossBackupStatistical返回参数结构体 */ export interface DescribeCrossBackupStatisticalResponse { /** * 跨地域备份概览实时统计总条数 */ TotalCount: number; /** * 跨地域备份概览实时统计列表 */ Items: Array<CrossSummaryDetailRes>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 实例续费状态信息 */ export interface InstanceRenewInfo { /** * 实例ID，形如mssql-j8kv137v */ InstanceId: string; /** * 实例续费标记。0：正常续费，1：自动续费，2：到期不续 */ RenewFlag: number; } /** * 订单信息 */ export interface DealInfo { /** * 订单名 */ DealName?: string; /** * 商品数量 */ Count?: number; /** * 关联的流程 ID，可用于查询流程执行状态 */ FlowId?: number; /** * 只有创建实例的订单会填充该字段，表示该订单创建的实例的 ID。 */ InstanceIdSet?: Array<string>; /** * 所属账号 */ OwnerUin?: string; /** * 实例付费类型 */ InstanceChargeType?: string; } /** * DescribeDatabases请求参数结构体 */ export interface DescribeDatabasesRequest { /** * 实例ID */ InstanceIdSet: Array<string>; /** * 分页返回，每页返回的数目，取值为1-100，默认值为20 */ Limit?: number; /** * 分页返回，页编号，默认值为第0页 */ Offset?: number; /** * 数据库名称 */ Name?: string; /** * 排序规则（desc-降序，asc-升序），默认desc */ OrderByType?: string; /** * 是否已开启TDE加密，enable-已加密，disable-未加密 */ Encryption?: string; } /** * 跨地域备份的目标地域和备份状态 */ export interface CrossRegionStatus { /** * 跨地域备份目标地域 */ CrossRegion: string; /** * 备份跨地域的同步状态 0-创建中；1-成功；2-失败；4-同步中 */ CrossStatus: number; } /** * StartMigrationCheck返回参数结构体 */ export interface StartMigrationCheckResponse { /** * 迁移检查流程发起后，返回的流程id */ FlowId: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeBackupStatistical返回参数结构体 */ export interface DescribeBackupStatisticalResponse { /** * 符合条件的实例总数。分页返回的话，这个值指的是所有符合条件的实例的个数，而非当前根据Limit和Offset值返回的实例个数。 */ TotalCount: number; /** * 实例列表。 */ Items: Array<SummaryDetailRes>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteBackupMigration请求参数结构体 */ export interface DeleteBackupMigrationRequest { /** * 目标实例ID，由DescribeBackupMigration接口返回 */ InstanceId: string; /** * 备份导入任务ID，由DescribeBackupMigration接口返回 */ BackupMigrationId: string; } /** * DescribeInstanceTasks返回参数结构体 */ export interface DescribeInstanceTasksResponse { /** * 异步任务总条数 */ TotalCount: number; /** * 异步任务信息数组 */ InstanceTaskSet: Array<InstanceTask>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateBusinessDBInstances返回参数结构体 */ export interface CreateBusinessDBInstancesResponse { /** * 订单名称 */ DealName?: string; /** * 流程ID */ FlowId?: number; /** * 实例ID集合 */ InstanceIdSet?: Array<string>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 该数据结构表示具有发布订阅关系的两个数据库，以及其之间发布订阅的状态信息。 */ export interface DatabaseTupleStatus { /** * 发布数据库名称 */ PublishDatabase?: string; /** * 订阅数据库名称 */ SubscribeDatabase?: string; /** * 最近一次同步时间 */ LastSyncTime?: string; /** * 数据库之间的发布订阅状态 running，success，fail，unknow */ Status?: string; } /** * DescribeDatabasesNormal请求参数结构体 */ export interface DescribeDatabasesNormalRequest { /** * 实例ID，形如mssql-7vfv3rk3 */ InstanceId: string; } /** * DescribeInquiryPriceParameter返回参数结构体 */ export interface DescribeInquiryPriceParameterResponse { /** * 计费参数 */ Parameter?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyDatabasePrivilege请求参数结构体 */ export interface ModifyDatabasePrivilegeRequest { /** * 数据库实例ID，形如mssql-njj2mtpl */ InstanceId: string; /** * 数据库权限变更信息 */ DataBaseSet: Array<DataBasePrivilegeModifyInfo>; } /** * DescribeCollationTimeZone返回参数结构体 */ export interface DescribeCollationTimeZoneResponse { /** * 系统字符集排序规则列表 */ Collation?: Array<string>; /** * 系统时区列表 */ TimeZone?: Array<string>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateBusinessIntelligenceFile返回参数结构体 */ export interface CreateBusinessIntelligenceFileResponse { /** * 文件名称 */ FileTaskId?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 实例参数修改记录 */ export interface ParamRecord { /** * 实例ID */ InstanceId: string; /** * 参数名称 */ ParamName: string; /** * 参数修改前的值 */ OldValue: string; /** * 参数修改后的值 */ NewValue: string; /** * 参数修改状态，1-初始化等待被执行，2-执行成功，3-执行失败，4-参数修改中 */ Status: number; /** * 修改时间 */ ModifyTime: string; } /** * RollbackInstance返回参数结构体 */ export interface RollbackInstanceResponse { /** * 异步任务ID */ FlowId?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 需要迁移的DB列表 */ export interface MigrateDB { /** * 迁移数据库的名称 */ DBName?: string; } /** * DescribeDBCharsets返回参数结构体 */ export interface DescribeDBCharsetsResponse { /** * 数据库字符集列表 */ DatabaseCharsets: Array<string>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyDBInstanceProject返回参数结构体 */ export interface ModifyDBInstanceProjectResponse { /** * 修改成功的实例个数 */ Count: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeIncrementalMigration请求参数结构体 */ export interface DescribeIncrementalMigrationRequest { /** * 备份导入任务ID，由CreateBackupMigration接口返回 */ BackupMigrationId: string; /** * 导入目标实例ID */ InstanceId: string; /** * 备份文件名称 */ BackupFileName?: string; /** * 导入任务状态集合 */ StatusSet?: Array<number | bigint>; /** * 分页，页大小，默认值：100 */ Limit?: number; /** * 分页，页数，默认值：0 */ Offset?: number; /** * 排序字段，name；createTime；startTime；endTime，默认按照createTime递增排序。 */ OrderBy?: string; /** * 排序方式，desc-递减排序，asc-递增排序。默认按照asc排序，且在OrderBy为有效值时，本参数有效 */ OrderByType?: string; /** * 增量备份导入任务ID，由CreateIncrementalMigration接口返回 */ IncrementalMigrationId?: string; } /** * DescribeSpecSellStatus返回参数结构体 */ export interface DescribeSpecSellStatusResponse { /** * 规格在不同地域状态集合 */ DescribeSpecSellStatusSet?: Array<SpecSellStatus>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * RestoreInstance返回参数结构体 */ export interface RestoreInstanceResponse { /** * 异步流程任务ID，使用FlowId调用DescribeFlowStatus接口获取任务执行状态 */ FlowId?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 实例异步任务 */ export interface InstanceTask { /** * 唯一id */ Id?: number; /** * Job类型 */ Type?: number; /** * Job状态 */ Status?: number; /** * 进度百分比0~100 */ Progress?: number; /** * 开始时间 */ StartTime?: string; /** * 结束时间 */ EndTime?: string; /** * 错误代码 */ ErrorCode?: number; /** * 错误信息描述 */ Message?: string; } /** * 包括地域的产品规格配置 */ export interface ProductSpec { /** * 地域ID */ RegionId?: number; /** * 可用区ID */ ZoneId?: number; /** * 配置信息 */ Info?: Array<SpecInfo>; } /** * SSL加密配置 */ export interface SSLConfig { /** * SSL加密状态， enable-已开启 disable-未开启 enable_doing-开启中 disable_doing-关闭中 renew_doing-更新中 wait_doing-等待维护时间内执行 */ Encryption?: string; /** * SSL证书有效期，时间格式 YYYY-MM-DD HH:MM:SS */ SSLValidityPeriod?: string; /** * SSL证书有效性，0-无效，1-有效 */ SSLValidity?: number; /** * 是否是KMS的CMK证书 */ IsKMS?: number; /** * KMS中购买的用户主密钥ID（CMK） */ CMKId?: string; /** * CMK所属的地域，不同地域的CMK数据不互通 */ CMKRegion?: string; } /** * DescribeFlowStatus请求参数结构体 */ export interface DescribeFlowStatusRequest { /** * 流程ID */ FlowId: number; } /** * ModifyAccountPrivilege返回参数结构体 */ export interface ModifyAccountPrivilegeResponse { /** * 异步任务流程ID */ FlowId?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyMigration返回参数结构体 */ export interface ModifyMigrationResponse { /** * 迁移任务ID */ MigrateId: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeInstanceTasks请求参数结构体 */ export interface DescribeInstanceTasksRequest { /** * 数据库实例ID，形如mssql-njj2mtpl */ InstanceId: string; /** * 分页大小 */ Limit: number; /** * 异步任务状态 1-运行中，2-运行成功，3-运行失败 */ Status?: number; /** * 分页偏移量 */ Offset?: number; } /** * DescribeDBInstances请求参数结构体 */ export interface DescribeDBInstancesRequest { /** * 项目ID */ ProjectId?: number; /** * 实例状态。取值范围： <li>1：申请中</li> <li>2：运行中</li> <li>3：受限运行中 (主备切换中)</li> <li>4：已隔离</li> <li>5：回收中</li> <li>6：已回收</li> <li>7：任务执行中 (实例做备份、回档等操作)</li> <li>8：已下线</li> <li>9：实例扩容中</li> <li>10：实例迁移中</li> <li>11：只读</li> <li>12：重启中</li> */ Status?: number; /** * 分页返回，页编号，默认值为第0页 */ Offset?: number; /** * 分页返回，每页返回的数目，取值为1-100，默认值为100 */ Limit?: number; /** * 一个或者多个实例ID。实例ID，格式如：mssql-si2823jyl */ InstanceIdSet?: Array<string>; /** * 付费类型检索 1-包年包月，0-按量计费 */ PayMode?: number; /** * 实例所属VPC的唯一字符串ID，格式如：vpc-xxx，传空字符串(“”)则按照基础网络筛选。 */ VpcId?: string; /** * 实例所属子网的唯一字符串ID，格式如： subnet-xxx，传空字符串(“”)则按照基础网络筛选。 */ SubnetId?: string; /** * 实例内网地址列表，格式如：172.1.0.12 */ VipSet?: Array<string>; /** * 实例名称列表，模糊查询 */ InstanceNameSet?: Array<string>; /** * 实例版本代号列表，格式如：2008R2，2012SP3等 */ VersionSet?: Array<string>; /** * 实例可用区，格式如：ap-guangzhou-2 */ Zone?: string; /** * 实例标签列表 */ TagKeys?: Array<string>; /** * 模糊查询关键字，支持实例id、实例名、内网ip */ SearchKey?: string; /** * 实例唯一Uid列表 */ UidSet?: Array<string>; /** * 实例类型 HA-高可用 RO-只读实例 SI-基础版 BI-商业智能服务,cvmHA-云盘双机高可用，cvmRO-云盘只读副本,MultiHA-多节点,cvmMultiHA-云盘多节点 */ InstanceType?: string; /** * 分页查询方式 offset-按照偏移量分页查询，pageNumber-按照页数分页查询，默认取值pageNumber */ PaginationType?: string; } /** * ModifyDBInstanceRenewFlag返回参数结构体 */ export interface ModifyDBInstanceRenewFlagResponse { /** * 修改成功的个数 */ Count: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 实例可售卖的规格信息 */ export interface SpecInfo { /** * 实例规格ID，利用DescribeZones返回的SpecId，结合DescribeProductConfig返回的可售卖规格信息，可获悉某个可用区下可购买什么规格的实例 */ SpecId?: number; /** * 机型ID */ MachineType?: string; /** * 机型中文名称 */ MachineTypeName?: string; /** * 数据库版本信息。取值为2008R2（表示SQL Server 2008 R2），2012SP3（表示SQL Server 2012），2016SP1（表示SQL Server 2016 SP1） */ Version?: string; /** * Version字段对应的版本名称 */ VersionName?: string; /** * 内存大小，单位GB */ Memory?: number; /** * CPU核数 */ CPU?: number; /** * 此规格下最小的磁盘大小，单位GB */ MinStorage?: number; /** * 此规格下最大的磁盘大小，单位GB */ MaxStorage?: number; /** * 此规格对应的QPS大小 */ QPS?: number; /** * 此规格的中文描述信息 */ SuitInfo?: string; /** * 此规格对应的包年包月Pid */ Pid?: number; /** * 此规格对应的按量计费Pid列表 */ PostPid?: Array<number | bigint>; /** * 此规格下支持的付费模式，POST-仅支持按量计费 PRE-仅支持包年包月 ALL-支持所有 */ PayModeStatus?: string; /** * 购买实例的类型 HA-本地盘高可用(包括双机高可用，alwaysOn集群)，RO-本地盘只读副本，SI-云盘版单节点,BI-商业智能服务，cvmHA-云盘版高可用，cvmRO-云盘版只读副本，MultiHA-多节点，cvmMultiHA-云盘多节点示例值：HA */ InstanceType?: string; /** * 跨可用区类型，MultiZones-只支持跨可用区，SameZones-只支持同可用区，ALL-支持所有 */ MultiZonesStatus?: string; } /** * ModifyBackupName返回参数结构体 */ export interface ModifyBackupNameResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateReadOnlyDBInstances请求参数结构体 */ export interface CreateReadOnlyDBInstancesRequest { /** * 主实例ID，格式如：mssql-3l3fgqn7 */ InstanceId: string; /** * 实例可用区，类似ap-guangzhou-1（广州一区）；实例可售卖区域可以通过接口DescribeZones获取 */ Zone: string; /** * 只读组类型选项，1-按照一个实例一个只读组的方式发货，2-新建只读组后发货，所有实例都在这个只读组下面， 3-发货的所有实例都在已有的只读组下面 */ ReadOnlyGroupType: number; /** * 实例内存大小，单位GB */ Memory: number; /** * 实例磁盘大小，单位GB */ Storage: number; /** * 0-默认不升级主实例，1-强制升级主实例完成ro部署；主实例为非集群版时需要填1，强制升级为集群版。填1 说明您已同意将主实例升级到集群版实例。 */ ReadOnlyGroupForcedUpgrade?: number; /** * ReadOnlyGroupType=3时必填,已存在的只读组ID */ ReadOnlyGroupId?: string; /** * ReadOnlyGroupType=2时必填，新建的只读组名称 */ ReadOnlyGroupName?: string; /** * ReadOnlyGroupType=2时必填，新建的只读组是否开启延迟剔除功能，1-开启，0-关闭。当只读副本与主实例延迟大于阈值后，自动剔除。 */ ReadOnlyGroupIsOfflineDelay?: number; /** * ReadOnlyGroupType=2 且 ReadOnlyGroupIsOfflineDelay=1时必填，新建的只读组延迟剔除的阈值。 */ ReadOnlyGroupMaxDelayTime?: number; /** * ReadOnlyGroupType=2 且 ReadOnlyGroupIsOfflineDelay=1时必填，新建的只读组延迟剔除后至少保留只读副本的个数。 */ ReadOnlyGroupMinInGroup?: number; /** * 付费模式，取值支持 PREPAID（预付费），POSTPAID（后付费）。 */ InstanceChargeType?: string; /** * 本次购买几个只读实例，默认值为2。 */ GoodsNum?: number; /** * VPC子网ID，形如subnet-bdoe83fa；SubnetId和VpcId需同时设置或者同时不设置 */ SubnetId?: string; /** * VPC网络ID，形如vpc-dsp338hz；SubnetId和VpcId需同时设置或者同时不设置 */ VpcId?: string; /** * 购买实例周期，默认取值为1，表示一个月。取值不超过48 */ Period?: number; /** * 安全组列表，填写形如sg-xxx的安全组ID */ SecurityGroupList?: Array<string>; /** * 是否自动使用代金券；1 - 是，0 - 否，默认不使用 */ AutoVoucher?: number; /** * 代金券ID数组，目前单个订单只能使用一张 */ VoucherIds?: Array<string>; /** * 新建实例绑定的标签集合 */ ResourceTags?: Array<ResourceTag>; /** * 系统字符集排序规则，默认：Chinese_PRC_CI_AS */ Collation?: string; /** * 系统时区，默认：China Standard Time */ TimeZone?: string; } /** * CreateBackupMigration请求参数结构体 */ export interface CreateBackupMigrationRequest { /** * 导入目标实例ID */ InstanceId: string; /** * 迁移任务恢复类型，FULL-全量备份恢复，FULL_LOG-全量备份+事务日志恢复，FULL_DIFF-全量备份+差异备份恢复 */ RecoveryType: string; /** * 备份上传类型，COS_URL-备份放在用户的对象存储上，提供URL。COS_UPLOAD-备份放在业务的对象存储上，需要用户上传。 */ UploadType: string; /** * 任务名称 */ MigrationName: string; /** * UploadType是COS_URL时这里填URL，COS_UPLOAD这里填备份文件的名字。只支持1个备份文件，但1个备份文件内可包含多个库 */ BackupFiles?: Array<string>; } /** * DescribeInstanceParamRecords请求参数结构体 */ export interface DescribeInstanceParamRecordsRequest { /** * 实例 ID，格式如：mssql-dj5i29c5n，与云数据库控制台页面中显示的实例 ID 相同，可使用 DescribeDBInstances 接口获取，其值为输出参数中字段 InstanceId 的值。 */ InstanceId: string; /** * 分页，页数，默认0 */ Offset?: number; /** * 分页，页大小，默认20，最大不超过100 */ Limit?: number; } /** * SwitchCloudInstanceHA请求参数结构体 */ export interface SwitchCloudInstanceHARequest { /** * 实例ID */ InstanceId: string; /** * 切换执行方式，0-立刻执行，1-时间窗内执行，默认取值为0。 */ WaitSwitch?: number; } /** * DescribeInstanceByOrders返回参数结构体 */ export interface DescribeInstanceByOrdersResponse { /** * 资源ID集合 */ DealInstance?: Array<DealInstance>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateReadOnlyDBInstances返回参数结构体 */ export interface CreateReadOnlyDBInstancesResponse { /** * 订单名称数组 */ DealNames?: Array<string>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreatePublishSubscribe返回参数结构体 */ export interface CreatePublishSubscribeResponse { /** * 流程ID，可通过接口DescribeFlowStatus查询立即切换升级任务的状态。 */ FlowId: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeInstanceParams请求参数结构体 */ export interface DescribeInstanceParamsRequest { /** * 实例 ID，格式如：mssql-dj5i29c5n，与云数据库控制台页面中显示的实例 ID 相同，可使用 DescribeDBInstances 接口获取，其值为输出参数中字段 InstanceId 的值。 */ InstanceId: string; } /** * TerminateDBInstance请求参数结构体 */ export interface TerminateDBInstanceRequest { /** * 主动销毁的实例ID列表，格式如：[mssql-3l3fgqn7]。与云数据库控制台页面中显示的实例ID相同 */ InstanceIdSet: Array<string>; } /** * RestartDBInstance请求参数结构体 */ export interface RestartDBInstanceRequest { /** * 数据库实例ID，形如mssql-njj2mtpl */ InstanceId: string; /** * 重启设置，0-立刻重启，1-维护时间窗口内重启，默认0 */ WaitSwitch?: number; } /** * ModifyDBInstanceName请求参数结构体 */ export interface ModifyDBInstanceNameRequest { /** * 数据库实例ID，形如mssql-njj2mtpl */ InstanceId: string; /** * 新的数据库实例名字 */ InstanceName: string; } /** * 实例账号密码信息 */ export interface AccountPassword { /** * 用户名 */ UserName: string; /** * 密码 */ Password: string; /** * 加密密钥版本号，0表示不使用加密 */ EncryptedVersion?: number; } /** * DeleteAccount请求参数结构体 */ export interface DeleteAccountRequest { /** * 数据库实例ID，形如mssql-njj2mtpl */ InstanceId: string; /** * 实例用户名数组 */ UserNames: Array<string>; } /** * DescribeDBCharsets请求参数结构体 */ export interface DescribeDBCharsetsRequest { /** * 实例ID，形如mssql-j8kv137v */ InstanceId: string; } /** * StartIncrementalMigration返回参数结构体 */ export interface StartIncrementalMigrationResponse { /** * 流程ID */ FlowId: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyDBInstanceNetwork返回参数结构体 */ export interface ModifyDBInstanceNetworkResponse { /** * 实例转网流程id，可通过[DescribeFlowStatus](https://cloud.tencent.com/document/product/238/19967)接口查询流程状态 */ FlowId?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * AssociateSecurityGroups返回参数结构体 */ export interface AssociateSecurityGroupsResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyDatabaseMdf返回参数结构体 */ export interface ModifyDatabaseMdfResponse { /** * 流程ID */ FlowId?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 迁移任务的目标类型 */ export interface MigrateTarget { /** * 迁移目标实例的ID，格式如：mssql-si2823jyl */ InstanceId?: string; /** * 迁移目标实例的用户名 */ UserName?: string; /** * 迁移目标实例的密码 */ Password?: string; } /** * 开启、关闭TDE数据库加密 */ export interface DBTDEEncrypt { /** * 数据库名称 */ DBName?: string; /** * enable-开启数据库TDE加密，disable-关闭数据库TDE加密 */ Encryption?: string; } /** * CreateMigration请求参数结构体 */ export interface CreateMigrationRequest { /** * 迁移任务的名称 */ MigrateName: string; /** * 迁移类型（1:结构迁移 2:数据迁移 3:增量同步） */ MigrateType: number; /** * 迁移源的类型 1:TencentDB for SQLServer 2:云服务器自建SQLServer数据库 4:SQLServer备份还原 5:SQLServer备份还原（COS方式） */ SourceType: number; /** * 迁移源 */ Source: MigrateSource; /** * 迁移目标 */ Target: MigrateTarget; /** * 迁移DB对象，离线迁移不使用（SourceType=4或SourceType=5）。 */ MigrateDBSet?: Array<MigrateDB>; /** * 按照ReNameRestoreDatabase中的库进行恢复，并重命名，不填则按照默认方式命名恢复的库，且恢复所有的库。SourceType=5的情况下有效。 */ RenameRestore?: Array<RenameRestoreDatabase>; } /** * 互通组内实例信息详情 */ export interface InterInstance { /** * 实例ID */ InstanceId: string; /** * 实例互通IP，用于加入互通组后访问 */ InterVip: string; /** * 实例互通端口，用于加入互通组后访问 */ InterPort: number; /** * 实例互通状态，1 -互通ipprot打开中 2 -互通ipprot已经打开 3 -已经打开互通ip的实例加入到互通组中 4 -已经打开互通ip的实例已加入到互通组 5 -互通ipprot回收中 6 -互通ipprot已回收 7 -已回收的实例从互通组中移除中 8 -已回收的实例从互通组中已经移除 */ Status: number; /** * 实例所在地域名称，如 ap-guangzhou */ Region: string; /** * 实例所在可用区名称，如 ap-guangzhou-1 */ Zone: string; /** * 实例版本代号 */ Version: string; /** * 实例版本 */ VersionName: string; /** * 实例名称 */ Name: string; /** * 实例访问IP */ Vip: string; /** * 实例访问端口 */ Vport: number; } /** * ModifyDBName返回参数结构体 */ export interface ModifyDBNameResponse { /** * 任务流ID */ FlowId?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 查询已经上传的备份文件大小。 */ export interface CosUploadBackupFile { /** * 备份名称 */ FileName?: string; /** * 备份大小 */ Size?: number; } /** * ModifyDBName请求参数结构体 */ export interface ModifyDBNameRequest { /** * 实例ID */ InstanceId: string; /** * 旧数据库名 */ OldDBName: string; /** * 新数据库名 */ NewDBName: string; } /** * ModifyDBInstanceRenewFlag请求参数结构体 */ export interface ModifyDBInstanceRenewFlagRequest { /** * 实例续费状态标记信息 */ RenewFlags: Array<InstanceRenewInfo>; } /** * DescribeUpgradeInstanceCheck返回参数结构体 */ export interface DescribeUpgradeInstanceCheckResponse { /** * 本变配是否对实例有影响，0-没有影响 1-有影响 */ IsAffect?: number; /** * 本变配是否可以执行 0-不通过，不能变配 1-通过，可以变配 */ Passed?: number; /** * 本变配是升配还是降配，down-降配 up-升配 */ ModifyMode?: string; /** * 检查项列表 */ CheckItems?: Array<CheckItem>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeRestoreTimeRange返回参数结构体 */ export interface DescribeRestoreTimeRangeResponse { /** * 按照时间点可回档的最小时间 */ MinTime?: string; /** * 按照时间点可回档的最大时间 */ MaxTime?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyDatabasePrivilege返回参数结构体 */ export interface ModifyDatabasePrivilegeResponse { /** * 异步任务流程ID */ FlowId: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateIncrementalMigration返回参数结构体 */ export interface CreateIncrementalMigrationResponse { /** * 增量备份导入任务ID */ IncrementalMigrationId: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeZones返回参数结构体 */ export interface DescribeZonesResponse { /** * 返回多少个可用区信息 */ TotalCount: number; /** * 可用区数组 */ ZoneSet: Array<ZoneInfo>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * UpgradeDBInstance请求参数结构体 */ export interface UpgradeDBInstanceRequest { /** * 实例ID，形如mssql-j8kv137v */ InstanceId: string; /** * 实例升级后内存大小，单位GB，其值不能小于当前实例内存大小 */ Memory?: number; /** * 实例升级后磁盘大小，单位GB，其值不能小于当前实例磁盘大小 */ Storage?: number; /** * 是否自动使用代金券，0 - 不使用；1 - 默认使用。取值默认为0 */ AutoVoucher?: number; /** * 代金券ID，目前单个订单只能使用一张代金券 */ VoucherIds?: Array<string>; /** * 实例升级后的CPU核心数 */ Cpu?: number; /** * 升级sqlserver的版本，目前支持：2008R2（SQL Server 2008 Enterprise），2012SP3（SQL Server 2012 Enterprise）版本等。每个地域支持售卖的版本不同，可通过DescribeProductConfig接口来拉取每个地域可售卖的版本信息，版本不支持降级，不填则不修改版本 */ DBVersion?: string; /** * 升级sqlserver的高可用架构,从镜像容灾升级到always on集群容灾，仅支持2017及以上版本且支持always on高可用的实例，不支持降级到镜像方式容灾，CLUSTER-升级为always on容灾，不填则不修改高可用架构 */ HAType?: string; /** * 修改实例是否为跨可用区容灾，SameZones-修改为同可用区 MultiZones-修改为跨可用区 */ MultiZones?: string; /** * 执行变配的方式，默认为 1。支持值包括：0 - 立刻执行，1 - 维护时间窗执行 */ WaitSwitch?: number; /** * 多节点架构实例的备节点可用区，默认为空。如果需要在变配的同时修改指定备节点的可用区时必传，当MultiZones = MultiZones时主节点和备节点可用区不能全部相同。备机可用区集合最小为2个，最大不超过5个。 */ DrZones?: Array<DrZoneInfo>; } /** * ModifyDBInstanceSSL返回参数结构体 */ export interface ModifyDBInstanceSSLResponse { /** * 异步任务流程ID */ FlowId?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 账号的数据库权限信息 */ export interface DBPrivilege { /** * 数据库名 */ DBName: string; /** * 数据库权限，ReadWrite表示可读写，ReadOnly表示只读，DBOwner所有者 */ Privilege: string; } /** * DescribeReadOnlyGroupDetails返回参数结构体 */ export interface DescribeReadOnlyGroupDetailsResponse { /** * 只读组ID */ ReadOnlyGroupId: string; /** * 只读组名称 */ ReadOnlyGroupName: string; /** * 只读组的地域ID，与主实例相同 */ RegionId: string; /** * 只读组的可用区ID，与主实例相同 */ ZoneId: string; /** * 是否启动超时剔除功能，0-不开启剔除功能，1-开启剔除功能 */ IsOfflineDelay: number; /** * 启动超时剔除功能后，使用的超时阈值 */ ReadOnlyMaxDelayTime: number; /** * 启动超时剔除功能后，至少只读组保留的只读副本数 */ MinReadOnlyInGroup: number; /** * 只读组vip */ Vip: string; /** * 只读组vport */ Vport: number; /** * 只读组私有网络ID */ VpcId: string; /** * 只读组私有网络子网ID */ SubnetId: string; /** * 只读实例副本集合 */ ReadOnlyInstanceSet: Array<ReadOnlyInstance>; /** * 只读组状态: 1-申请成功运行中，5-申请中 */ Status: number; /** * 主实例ID，形如mssql-sgeshe3th */ MasterInstanceId: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 实例绑定的标签信息 */ export interface ResourceTag { /** * 标签key */ TagKey?: string; /** * 标签value */ TagValue?: string; } /** * InquiryPriceRenewDBInstance请求参数结构体 */ export interface InquiryPriceRenewDBInstanceRequest { /** * 实例ID */ InstanceId: string; /** * 续费周期。按月续费最多48个月。默认查询续费一个月的价格 */ Period?: number; /** * 续费周期单位。month表示按月续费，当前只支持按月付费查询价格 */ TimeUnit?: string; } /** * DeleteBackupMigration返回参数结构体 */ export interface DeleteBackupMigrationResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribePublishSubscribe请求参数结构体 */ export interface DescribePublishSubscribeRequest { /** * 实例ID，形如mssql-j8kv137v */ InstanceId: string; /** * 订阅/发布实例ID，与InstanceId是发布实例还是订阅实例有关；当InstanceId为发布实例时，本字段按照订阅实例ID做筛选；当InstanceId为订阅实例时，本字段按照发布实例ID做筛选； */ PubOrSubInstanceId?: string; /** * 订阅/发布实例内网IP，与InstanceId是发布实例还是订阅实例有关；当InstanceId为发布实例时，本字段按照订阅实例内网IP做筛选；当InstanceId为订阅实例时，本字段按照发布实例内网IP做筛选； */ PubOrSubInstanceIp?: string; /** * 订阅发布ID，用于筛选 */ PublishSubscribeId?: number; /** * 订阅发布名字，用于筛选 */ PublishSubscribeName?: string; /** * 发布库名字，用于筛选 */ PublishDBName?: string; /** * 订阅库名字，用于筛选 */ SubscribeDBName?: string; /** * 分页，页数 */ Offset?: number; /** * 分页，页大小 */ Limit?: number; } /** * 在非打包上传备份模式下，每个库对应一个备份文件 */ export interface BackupFile { /** * 备份文件唯一标识 */ Id: number; /** * 备份文件名称 */ FileName: string; /** * 文件大小(K) */ Size: number; /** * 备份文件的库的名称 */ DBs: Array<string>; /** * 下载地址 */ DownloadLink: string; /** * 当前实例地域码 */ Region: string; /** * 备份的跨地域region和所对应的下载地址 */ CrossBackupAddr: Array<CrossBackupAddr>; } /** * DescribeRegularBackupPlan返回参数结构体 */ export interface DescribeRegularBackupPlanResponse { /** * 常规备份计划 */ SaveModePeriod: Array<string>; /** * 定期备份计划 */ SaveModeRegular: Array<string>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * InquiryPriceUpgradeDBInstance返回参数结构体 */ export interface InquiryPriceUpgradeDBInstanceResponse { /** * 未打折的原价，其值除以100表示最终的价格。例如10094表示100.94元 */ OriginalPrice?: number; /** * 实际需要支付价格，其值除以100表示最终的价格。例如10094表示100.94元 */ Price?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyMigration请求参数结构体 */ export interface ModifyMigrationRequest { /** * 迁移任务ID */ MigrateId: number; /** * 新的迁移任务的名称，若不填则不修改 */ MigrateName?: string; /** * 新的迁移类型（1:结构迁移 2:数据迁移 3:增量同步），若不填则不修改 */ MigrateType?: number; /** * 迁移源的类型 1:TencentDB for SQLServer 2:云服务器自建SQLServer数据库 4:SQLServer备份还原 5:SQLServer备份还原（COS方式），若不填则不修改 */ SourceType?: number; /** * 迁移源，若不填则不修改 */ Source?: MigrateSource; /** * 迁移目标，若不填则不修改 */ Target?: MigrateTarget; /** * 迁移DB对象，离线迁移（SourceType=4或SourceType=5）不使用，若不填则不修改 */ MigrateDBSet?: Array<MigrateDB>; } /** * 跨地域备份下载地址集合 */ export interface CrossBackupAddr { /** * 跨地域备份目标地域 */ CrossRegion: string; /** * 跨地域备份内网下载地址 */ CrossInternalAddr: string; /** * 跨地域备份外网下载地址 */ CrossExternalAddr: string; } /** * QueryMigrationCheckProcess请求参数结构体 */ export interface QueryMigrationCheckProcessRequest { /** * 迁移任务ID */ MigrateId: number; } /** * RestartDBInstance返回参数结构体 */ export interface RestartDBInstanceResponse { /** * 异步任务流程ID */ FlowId?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeRollbackTime返回参数结构体 */ export interface DescribeRollbackTimeResponse { /** * 数据库可回档实例信息 */ Details: Array<DbRollbackTimeInfo>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeProductSpec返回参数结构体 */ export interface DescribeProductSpecResponse { /** * 配置地域分的个数 */ TotalCount?: number; /** * 规格信息数组 */ SpecInfoList?: Array<ProductSpec>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 数据库信息 */ export interface DBDetail { /** * 数据库名称 */ Name?: string; /** * 字符集 */ Charset?: string; /** * 备注 */ Remark?: string; /** * 数据库创建时间 */ CreateTime?: string; /** * 数据库状态。1--创建中， 2--运行中， 3--修改中，-1--删除中 */ Status?: number; /** * 数据库账号权限信息 */ Accounts?: Array<AccountPrivilege>; /** * 内部状态。ONLINE表示运行中 */ InternalStatus?: string; /** * 是否已开启TDE加密，enable-已加密，disable-未加密 */ Encryption?: string; } /** * DescribeInstanceParams返回参数结构体 */ export interface DescribeInstanceParamsResponse { /** * 实例的参数总数 */ TotalCount: number; /** * 参数详情 */ Items: Array<ParameterDetail>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DisassociateSecurityGroups请求参数结构体 */ export interface DisassociateSecurityGroupsRequest { /** * 安全组ID。 */ SecurityGroupId: string; /** * 实例ID 列表，一个或者多个实例ID组成的数组。多个实例必须是同一个地域，同一个可用区，同一个项目下的。 */ InstanceIdSet: Array<string>; } /** * ModifyBackupName请求参数结构体 */ export interface ModifyBackupNameRequest { /** * 实例ID，格式如：mssql-3l3fgqn7 */ InstanceId: string; /** * 修改的备份名称 */ BackupName: string; /** * 备份ID 可通过 [DescribeBackups](https://cloud.tencent.com/document/product/238/19943) 接口获取。当GroupId为空时，BackupId必填。 */ BackupId?: number; /** * 备份任务组ID，在单库备份文件模式下，可通过[DescribeBackups](https://cloud.tencent.com/document/product/238/19943) 接口获得。 BackupId 和 GroupId 同时存在，按照BackupId进行修改。 */ GroupId?: string; } /** * CreateDB请求参数结构体 */ export interface CreateDBRequest { /** * 实例ID */ InstanceId: string; /** * 数据库创建信息 */ DBs: Array<DBCreateInfo>; } /** * RollbackInstance请求参数结构体 */ export interface RollbackInstanceRequest { /** * 实例ID */ InstanceId: string; /** * 回档类型，0-回档的数据库覆盖原库；1-回档的数据库以重命名的形式生成，不覆盖原库 */ Type: number; /** * 回档目标时间点 */ Time: string; /** * 需要回档的数据库 */ DBs?: Array<string>; /** * 备份恢复到的同一个APPID下的实例ID，不填则恢复到原实例ID */ TargetInstanceId?: string; /** * 按照ReNameRestoreDatabase中的库进行重命名，仅在Type = 1重命名回档方式有效；不填则按照默认方式命名库，DBs参数确定要恢复的库 */ RenameRestore?: Array<RenameRestoreDatabase>; } /** * 备机只读信息 */ export interface DrReadableInfo { /** * 备机资源ID */ DrInstanceId?: string; /** * 备机可用区 */ Zone?: string; /** * 备机状态 DR_CREATING-备机创建中 DR_RUNNING-备机运行中 DR_UNAVAILABLE-备机不可用 DR_ISOLATED-备机已隔离 DR_RECYCLING-备机回收中 DR_RECYCLED-备机已回收 DR_JOB_RUNNING-备机执行任务中 DR_OFFLINE-备机已下线 DR_FAIL_OVER-备机只读故障转移中 */ SlaveStatus?: string; /** * 备机可读状态，enable-已开启，disable-已关闭 */ ReadableStatus?: string; /** * 备机只读vip */ Vip?: string; /** * 备机只读端口 */ VPort?: number; /** * 备机所在私有网络ID */ UniqVpcId?: string; /** * 备机所在私有网络子网ID */ UniqSubnetId?: string; /** * 备机只读权重 */ RoWeight?: number; /** * 备机只读模式，BalancedReadOnly-多备一读模式，SingleReadOnly-一备一读模式 */ ReadMode?: string; } /** * DescribeRollbackTime请求参数结构体 */ export interface DescribeRollbackTimeRequest { /** * 实例ID */ InstanceId: string; /** * 需要查询的数据库列表 */ DBs: Array<string>; } /** * DescribeIncrementalMigration返回参数结构体 */ export interface DescribeIncrementalMigrationResponse { /** * 增量导入任务总数 */ TotalCount: number; /** * 增量导入任务集合 */ IncrementalMigrationSet: Array<Migration>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateDBInstances返回参数结构体 */ export interface CreateDBInstancesResponse { /** * 订单名称 */ DealName?: string; /** * 订单名称数组 */ DealNames?: Array<string>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteAccount返回参数结构体 */ export interface DeleteAccountResponse { /** * 任务流ID */ FlowId: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * TDE透明数据加密配置 */ export interface TDEConfigAttribute { /** * 是否已开通TDE加密，enable-已开通，disable-未开通 */ Encryption?: string; /** * 证书归属。self-表示使用该账号自身的证书，others-表示引用其他账号的证书，none-表示没有证书 */ CertificateAttribution?: string; /** * 开通TDE加密时引用的其他主账号ID */ QuoteUin?: string; /** * KMS中购买的用户主密钥ID（CMK） */ CMKId?: string; /** * CMK所属的地域，不同地域的CMK不互通 */ CMKRegion?: string; } /** * 备份概览实时统计项 */ export interface SummaryDetailRes { /** * 地域标识 */ RegionId?: number; /** * 实例状态。1：申请中2：运行中3：受限运行中 (主备切换中)4：已隔离5：回收中6：已回收7：任务执行中 (实例做备份、回档等操作)8：已下线9：实例扩容中10：实例迁移中 */ Status?: number; /** * 实例ID */ InstanceId?: string; /** * 实例名称 */ Name?: string; /** * 备份空间 */ ActualUsedSpace?: number; /** * 数据备份空间 */ DataBackupSpace?: number; /** * 数据备份文件总个数 */ DataBackupCount?: number; /** * 日志备份空间 */ LogBackupSpace?: number; /** * 日志备份文件总个数 */ LogBackupCount?: number; /** * 自动备份空间 */ AutoBackupSpace?: number; /** * 自动备份文件总个数 */ AutoBackupCount?: number; /** * 手动备份空间 */ ManualBackupSpace?: number; /** * 手动备份文件总个数 */ ManualBackupCount?: number; /** * 实例所属地域码 */ Region?: string; } /** * ModifyDReadable请求参数结构体 */ export interface ModifyDReadableRequest { /** * 实例ID */ InstanceId: string; /** * 操作类型。enable-开启备机只读，disable-关闭备机只读 */ Type: string; /** * 备机网络ID，不填默认和主实例保持一致 */ VpcId?: string; /** * 备机网络子网ID，不填默认和主实例保持一致 */ SubnetId?: string; /** * 指定的备机只读vip，不填自动分配。多节点SingleReadOnly模式不支持指定vip。 */ Vip?: string; /** * 备机只读模式，多节点架构默认取值BalancedReadOnly。SingleReadOnly-每个备机各对应一个只读地址（多节点架构），BalancedReadOnly-所有备机共用一个只读地址。当实例是双节点架构时，固定取值SingleReadOnly。 */ ReadMode?: string; } /** * DeleteBusinessIntelligenceFile请求参数结构体 */ export interface DeleteBusinessIntelligenceFileRequest { /** * 实例ID */ InstanceId: string; /** * 文件名称集合 */ FileNameSet: Array<string>; } /** * AssociateSecurityGroups请求参数结构体 */ export interface AssociateSecurityGroupsRequest { /** * 安全组ID。 */ SecurityGroupId: string; /** * 实例ID 列表，一个或者多个实例ID组成的数组。多个实例必须是同一个地域，同一个可用区，同一个项目下的。 */ InstanceIdSet: Array<string>; } /** * ModifyBackupStrategy返回参数结构体 */ export interface ModifyBackupStrategyResponse { /** * 返回错误码 * @deprecated */ Errno?: number; /** * 返回错误信息 */ Msg?: string; /** * 返回错误码 */ Code?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 备可用区信息 */ export interface SlaveZones { /** * 备可用区地域码 */ SlaveZone?: string; /** * 备可用区 */ SlaveZoneName?: string; /** * 备机资源ID */ DrInstanceId?: string; } /** * DescribeBackupUploadSize请求参数结构体 */ export interface DescribeBackupUploadSizeRequest { /** * 导入目标实例ID */ InstanceId: string; /** * 备份导入任务ID，由CreateBackupMigration接口返回 */ BackupMigrationId: string; /** * 增量导入任务ID */ IncrementalMigrationId?: string; } /** * StartInstanceXEvent返回参数结构体 */ export interface StartInstanceXEventResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeDBInstanceInter返回参数结构体 */ export interface DescribeDBInstanceInterResponse { /** * 互通组内总条数 */ TotalCount?: number; /** * 互通组内实例信息详情 */ InterInstanceSet?: Array<InterInstance>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyPublishSubscribeName返回参数结构体 */ export interface ModifyPublishSubscribeNameResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteIncrementalMigration请求参数结构体 */ export interface DeleteIncrementalMigrationRequest { /** * 目标实例ID */ InstanceId: string; /** * 备份导入任务ID，由CreateBackupMigration接口返回 */ BackupMigrationId: string; /** * 增量备份导入任务ID，由CreateIncrementalMigration接口返回 */ IncrementalMigrationId: string; } /** * CutXEvents返回参数结构体 */ export interface CutXEventsResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeBackups请求参数结构体 */ export interface DescribeBackupsRequest { /** * 开始时间(yyyy-MM-dd HH:mm:ss) */ StartTime: string; /** * 结束时间(yyyy-MM-dd HH:mm:ss) */ EndTime: string; /** * 实例ID，形如mssql-njj2mtpl */ InstanceId: string; /** * 分页返回，每页返回的数目，取值为1-100，默认值为20 */ Limit?: number; /** * 分页返回，页编号，默认值为第0页 */ Offset?: number; /** * 按照备份名称筛选，不填则不筛选此项 */ BackupName?: string; /** * 按照备份策略筛选，0-实例备份，1-多库备份，不填则不筛选此项 */ Strategy?: number; /** * 按照备份方式筛选，0-后台自动定时备份，1-用户手动临时备份，2-定期备份，不填则不筛选此项 */ BackupWay?: number; /** * 按照备份ID筛选，不填则不筛选此项 */ BackupId?: number; /** * 按照备份的库名称筛选，不填则不筛选此项 */ DatabaseName?: string; /** * 是否分组查询，默认是0，单库备份情况下 0-兼容老方式不分组，1-单库备份分组后展示 */ Group?: number; /** * 备份类型，1-数据备份，2-日志备份，默认值为1 */ Type?: number; /** * 按照备份文件形式筛选，pkg-打包备份文件，single-单库备份文件 */ BackupFormat?: string; /** * 备份存储策略 0-跟随自定义备份保留策略 1-跟随实例生命周期直到实例下线，默认取值0 */ StorageStrategy?: number; } /** * RestoreInstance请求参数结构体 */ export interface RestoreInstanceRequest { /** * 实例ID，形如mssql-j8kv137v */ InstanceId: string; /** * 备份文件ID，该ID可以通过DescribeBackups接口返回数据中的Id字段获得 */ BackupId: number; /** * 备份恢复到的同一个APPID下的实例ID，不填则恢复到原实例ID */ TargetInstanceId?: string; /** * 按照ReNameRestoreDatabase中的库进行恢复，并重命名，不填则按照默认方式命名恢复的库，且恢复所有的库。 */ RenameRestore?: Array<RenameRestoreDatabase>; /** * 回档类型，0-覆盖方式；1-重命名方式，默认1 */ Type?: number; /** * 需要覆盖回档的数据库，只有覆盖回档时必填 */ DBList?: Array<string>; /** * 备份任务组ID，在单库备份文件模式下 */ GroupId?: string; } /** * ModifyDatabaseShrinkMDF请求参数结构体 */ export interface ModifyDatabaseShrinkMDFRequest { /** * 数据库名数组 */ DBNames: Array<string>; /** * 实例ID */ InstanceId: string; } /** * DescribeInstanceTradeParameter返回参数结构体 */ export interface DescribeInstanceTradeParameterResponse { /** * 计费参数 */ Parameter?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * RunMigration请求参数结构体 */ export interface RunMigrationRequest { /** * 迁移任务ID */ MigrateId: number; } /** * 安全组策略 */ export interface SecurityGroupPolicy { /** * 策略，ACCEPT 或者 DROP */ Action?: string; /** * 目的 IP 或 IP 段，例如172.16.0.0/12 */ CidrIp?: string; /** * 端口或者端口范围 */ PortRange?: string; /** * 网络协议，支持 UDP、TCP等 */ IpProtocol?: string; /** * 规则限定的方向，OUTPUT-出战规则 INPUT-进站规则 */ Dir?: string; } /** * DescribeInstanceByOrders请求参数结构体 */ export interface DescribeInstanceByOrdersRequest { /** * 订单号集合 */ DealNames: Array<string>; } /** * ModifyMaintenanceSpan返回参数结构体 */ export interface ModifyMaintenanceSpanResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * InquiryPriceCreateDBInstances请求参数结构体 */ export interface InquiryPriceCreateDBInstancesRequest { /** * 可用区ID。该参数可以通过调用 DescribeZones 接口的返回值中的Zone字段来获取。 */ Zone: string; /** * 内存大小，单位：GB */ Memory: number; /** * 实例容量大小，单位：GB。 */ Storage: number; /** * 计费类型，取值支持 PREPAID，POSTPAID。 */ InstanceChargeType?: string; /** * 购买时长，单位：月。取值为1到48，默认为1 */ Period?: number; /** * 一次性购买的实例数量。取值1-100，默认取值为1 */ GoodsNum?: number; /** * sqlserver版本，目前所有支持的版本有：2008R2 (SQL Server 2008 R2 Enterprise)，2012SP3 (SQL Server 2012 Enterprise)，201202 (SQL Server 2012 Standard)，2014SP2 (SQL Server 2014 Enterprise)，201402 (SQL Server 2014 Standard)，2016SP1 (SQL Server 2016 Enterprise)，201602 (SQL Server 2016 Standard)，2017 (SQL Server 2017 Enterprise)，201702 (SQL Server 2017 Standard)，2019 (SQL Server 2019 Enterprise)，201902 (SQL Server 2019 Standard)。每个地域支持售卖的版本不同，可通过DescribeProductConfig接口来拉取每个地域可售卖的版本信息。不填，默认为版本2008R2。 */ DBVersion?: string; /** * 预购买实例的CPU核心数 */ Cpu?: number; /** * 购买实例的类型 HA-高可用型(包括双机高可用，alwaysOn集群)，RO-只读副本型，SI-单节点型,cvmHA-虚拟机双机高可用,cvmRO-虚拟机只读，MultiHA-多节点，cvmMultiHA-云盘 */ InstanceType?: string; /** * 购买实例的宿主机类型，PM-物理机, CLOUD_PREMIUM-虚拟机高性能云盘，CLOUD_SSD-虚拟机SSD云盘, CLOUD_HSSD-虚拟机加强型SSD云盘，CLOUD_TSSD-虚拟机极速型SSD云盘，CLOUD_BSSD-虚拟机通用型SSD云盘 */ MachineType?: string; /** * 备节点可用区，默认为空。如果是多节点架构时必传，并且备机可用区集合最小为2个，最大不超过5个。 */ DrZones?: Array<string>; } /** * StartIncrementalMigration请求参数结构体 */ export interface StartIncrementalMigrationRequest { /** * 导入目标实例ID */ InstanceId: string; /** * 备份导入任务ID，由CreateBackupMigration接口返回 */ BackupMigrationId: string; /** * 增量备份导入任务ID */ IncrementalMigrationId: string; } /** * ModifyDBInstanceNetwork请求参数结构体 */ export interface ModifyDBInstanceNetworkRequest { /** * 实例id */ InstanceId: string; /** * 新VPC网络Id */ NewVpcId: string; /** * 新子网Id */ NewSubnetId: string; /** * 原vip保留时长，单位小时，默认为0，代表立即回收，最大为168小时 */ OldIpRetainTime?: number; /** * 指定VIP地址 */ Vip?: string; /** * 目标节点，0-修改主节点网络，1-修改备节点网络，默认取值0 */ DRNetwork?: number; /** * 备机资源ID。当DRNetwork = 1时必填 */ DrInstanceId?: string; } /** * ModifyDBEncryptAttributes返回参数结构体 */ export interface ModifyDBEncryptAttributesResponse { /** * 任务流ID */ FlowId?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyMaintenanceSpan请求参数结构体 */ export interface ModifyMaintenanceSpanRequest { /** * 实例ID，形如mssql-k8voqdlz */ InstanceId: string; /** * 以周为单位，表示允许周几维护，例如：[1,2,3,4,5,6,7]表示周一到周日均为可维护日，本参数不填，则不修改此值。 */ Weekly?: Array<number | bigint>; /** * 每天可维护的开始时间，例如：10:24标识可维护时间窗10点24分开始，本参数不填，则不修改此值。 */ StartTime?: string; /** * 每天可维护的持续时间，单位是h，例如：1 表示从可维护的开始时间起持续1小时，本参数不填，则不修改此值。 */ Span?: number; } /** * RecycleDBInstance请求参数结构体 */ export interface RecycleDBInstanceRequest { /** * 实例ID */ InstanceId: string; } /** * DescribeOrders返回参数结构体 */ export interface DescribeOrdersResponse { /** * 订单信息数组 */ Deals: Array<DealInfo>; /** * 返回多少个订单的信息 */ TotalCount: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyCloseWanIp请求参数结构体 */ export interface ModifyCloseWanIpRequest { /** * 实例资源ID */ InstanceId: string; /** * RO只读组Id */ RoGroupId?: string; } /** * 实例开通或者关闭互通组后的状态 */ export interface InterInstanceFlow { /** * 实例ID，例如：mssql-sdf32n1d */ InstanceId: string; /** * 实例开通或者关闭互通组的流程ID，FlowId小于0-开通或者关闭失败，反之则成功。 */ FlowId: number; } /** * ModifyDBInstanceNote返回参数结构体 */ export interface ModifyDBInstanceNoteResponse { /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 数据库实例参数 */ export interface Parameter { /** * 参数名称 */ Name?: string; /** * 参数值 */ CurrentValue?: string; } /** * DescribeDBs返回参数结构体 */ export interface DescribeDBsResponse { /** * 数据库数量 */ TotalCount?: number; /** * 实例数据库列表 */ DBInstances?: Array<InstanceDBDetail>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeDBSecurityGroups请求参数结构体 */ export interface DescribeDBSecurityGroupsRequest { /** * 实例ID，格式如：mssql-c1nl9rpv或者mssqlro-c1nl9rpv，与云数据库控制台页面中显示的实例ID相同。 */ InstanceId: