数据结构

AccountCreateInfo

账号创建信息

被如下接口引用：CreateAccount。

名称	类型	必选	描述
UserName	String	是	实例用户名 示例值：ac1
Password	String	否	实例密码 示例值：Zh22448899
DBPrivileges	Array of DBPrivilege	否	DB权限列表 示例值：[{"DBName": "db1","Privilege": "ReadOnly"}]
Remark	String	否	账号备注信息 示例值：andy
IsAdmin	Boolean	否	是否为管理员账户，当值为true 等价于单节点AccountType=L0，双节点AccountType=L1，当值为false，等价于AccountType=L3 示例值：false
Authentication	String	否	win-windows鉴权,sql-sqlserver鉴权，不填默认值为sql-sqlserver鉴权 示例值：sql
AccountType	String	否	账号类型，IsAdmin的扩展字段。 L0-超级权限(基础版独有),L1-高级权限,L2-特殊权限,L3-普通权限，默认L3 示例值：L0
IsCam	Boolean	否	是否开启CAM验证 示例值：false
EncryptedVersion	Integer	否	加密密钥版本号，0表示不使用加密 示例值：0

AccountDetail

账号信息详情

被如下接口引用：DescribeAccounts。

名称	类型	描述
Name	String	账户名 示例值：ac1
Remark	String	账户备注 示例值：andy
CreateTime	Timestamp	账户创建时间 示例值：2020-04-09 00:00:00
Status	Integer	账户状态，1-创建中，2-正常，3-修改中，4-密码重置中，-1-删除中 示例值：2
UpdateTime	Timestamp	账户更新时间 示例值：2020-04-09 00:00:00
PassTime	Timestamp	密码更新时间 示例值：2020-04-09 00:00:00
InternalStatus	String	账户内部状态，正常为enable 示例值：enable
Dbs	Array of DBPrivilege	该账户对相关db的读写权限信息 示例值：[{"DBName": "db1","Privilege": "ReadOnly"}]
IsAdmin	Boolean	是否为管理员账户 示例值：false
IsCam	Boolean	是否为cam托管账户 示例值：false
Authentication	String	win-windows鉴权,sql-sqlserver鉴权 示例值：win
Host	String	win-windows鉴权账户需要host 示例值：172_8_9_12
AccountType	String	账号类型。L0-超级权限(基础版独有),L1-高级权限,L2-特殊权限,L3-普通权限 示例值：L0

AccountPassword

实例账号密码信息

被如下接口引用：ResetAccountPassword。

名称	类型	必选	描述
UserName	String	是	用户名 示例值：andy
Password	String	是	密码 示例值：Zh22448899
EncryptedVersion	Integer	否	加密密钥版本号，0表示不使用加密 示例值：0

AccountPrivilege

数据库账号权限信息。创建数据库时设置

被如下接口引用：CreateDB, DescribeAccountPrivilegeByDB, DescribeDBs, DescribeDatabases, ModifyDatabasePrivilege。

名称	类型	必选	描述
UserName	String	是	数据库用户名 示例值：db_test
Privilege	String	是	数据库权限。ReadWrite表示可读写，ReadOnly表示只读,Delete表示删除DB对该账户的权限，DBOwner所有者 示例值：ReadOnly
AccountType	String	否	账户名称，L0-超级权限(基础版独有),L1-高级权限,L2-特殊权限,L3-普通权限 示例值：L0

AccountPrivilegeModifyInfo

数据库账号权限变更信息

被如下接口引用：ModifyAccountPrivilege。

名称	类型	必选	描述
UserName	String	是	数据库用户名 示例值：ac1
DBPrivileges	Array of DBPrivilegeModifyInfo	是	账号权限变更信息。参数DBPrivileges和AccAllDB只能二选一
IsAdmin	Boolean	否	表示是否为管理员账户，当值为true，表示是 管理员。若实例 是 单节点，则管理员所在的 账号类型为超级权限账号 ，即AccountType=L0；若实例 是 双节点，则管理员所在的 账号类型为高级权限账号，即AccountType=L1；当值为false，表示 不是管理员，则账号类型为普通账号，即AccountType=L3 示例值：true
AccountType	String	否	账号类型，IsAdmin字段的扩展字段。 L0-超级权限(基础版独有),L1-高级权限,L2-特殊权限,L3-普通权限，默认L3 示例值：L0
AccAllDB	SelectAllDB	否	全量修改指定账号下的所有DB权限，只支持特殊权限账号和普通权限账号。参数DBPrivileges和AccAllDB只能二选一

AccountRemark

账户备注信息

被如下接口引用：ModifyAccountRemark。

名称	类型	必选	描述
UserName	String	否	账户名 示例值：tom
Remark	String	否	对应账户新的备注信息 示例值：部门一

Backup

备份文件详细信息

被如下接口引用：DescribeBackups。

名称	类型	描述
FileName	String	文件名，对于单库备份文件不返回此值；单库备份文件通过DescribeBackupFiles接口获取文件名 示例值：auto_xxx.bak.tar
Size	Integer	文件大小，单位 KB，对于单库备份文件不返回此值；单库备份文件通过DescribeBackupFiles接口获取文件大小 示例值：20
StartTime	Timestamp	备份开始时间 示例值：2020-04-09 00:00:00
EndTime	Timestamp	备份结束时间 示例值：2020-04-09 00:00:00
InternalAddr	String	内网下载地址，对于单库备份文件不返回此值；单库备份文件通过DescribeBackupFiles接口获取下载地址 示例值：http://xxx
ExternalAddr	String	外网下载地址，对于单库备份文件不返回此值；单库备份文件通过DescribeBackupFiles接口获取下载地址 示例值：http://xxx
Id	Integer	备份文件唯一标识，RestoreInstance接口会用到该字段，对于单库备份文件不返回此值；单库备份文件通过DescribeBackupFiles接口获取可回档的ID 示例值：1
Status	Integer	备份文件状态（0-创建中；1-成功；2-失败） 示例值：0
DBs	Array of String	多库备份时的DB列表 示例值：DBName
Strategy	Integer	备份策略（0-实例备份；1-多库备份） 示例值：0
StorageStrategy	Integer	备份存储策略 0-跟随自定义备份保留策略 1-跟随实例生命周期直到实例下线 示例值：0
BackupWay	Integer	备份方式，0-定时备份；1-手动临时备份；2-定期备份 示例值：0
BackupName	String	备份任务名称，可自定义 示例值：mssql-dj5i29c5n
GroupId	String	聚合Id，对于打包备份文件不返回此值。通过此值调用DescribeBackupFiles接口，获取单库备份文件的详细信息 示例值：558800
BackupFormat	String	备份文件形式（pkg-打包备份文件，single-单库备份文件） 示例值：pkg
Region	String	实例当前地域Code 示例值：ap-guangzhou
CrossBackupAddr	Array of CrossBackupAddr	跨地域备份的目的地域下载链接 示例值：[]
CrossBackupStatus	Array of CrossRegionStatus	跨地域备份的目标地域和备份状态 示例值：[]

BackupFile

在非打包上传备份模式下，每个库对应一个备份文件

被如下接口引用：DescribeBackupFiles。

名称	类型	描述
Id	Integer	备份文件唯一标识 示例值：0
FileName	String	备份文件名称 示例值：xxxx.bak
Size	Integer	文件大小(K) 示例值：0
DBs	Array of String	备份文件的库的名称 示例值：[db1]
DownloadLink	String	下载地址 示例值：http://xxxxx
Region	String	当前实例地域码 示例值：ap-guangzhou
CrossBackupAddr	Array of CrossBackupAddr	备份的跨地域region和所对应的下载地址 示例值：[]

BusinessIntelligenceFile

商业智能服务文件类型

被如下接口引用：DescribeBusinessIntelligenceFile。

名称	类型	描述
FileName	String	文件名称 示例值：FileName
FileType	String	文件类型 示例值：FLAT
FileURL	String	文件的COS_URL 示例值：http://bucket/file.txt
FilePath	String	文件在服务器上的路径 示例值：D:\SISI\
FileSize	Integer	文件大小，单位时Byte 示例值：0
FileMd5	String	文件md5值 示例值：sdfgefdgrferw
Status	Integer	部署文件状态 1-初始化待部署 2-部署中 3-部署成功 4-部署失败 示例值：1
Remark	String	备注信息 示例值：Remark
CreateTime	String	文件创建时间 示例值：2020-04-09 00:00:00
StartTime	String	文件部署开始时间 示例值：2020-04-09 00:00:00
EndTime	String	文件部署结束时间 示例值：2020-04-09 00:00:00
Message	String	报错信息返回 示例值：Message
InstanceId	String	商业智能实例ID 示例值：mssql-dj5i29c5n
Action	FileAction	动作相关信息

CheckItem

实例变配检查条目

被如下接口引用：DescribeUpgradeInstanceCheck。

名称	类型	描述
CheckName	String	检查项目名称，CK_CPU-变配后CPU风险检查；CK_MASTER_STORAGE-只读副本变配下，只读副本磁盘空间不小于主实例空间检查；CK_MEMORY-变配后内存风险检查；CK_STORAGE-变配后磁盘空间风险检查；CK_UPGRATE-变配是否需要迁移检查； 示例值：CK_CPU
CurrentValue	String	检查项目返回值，CK_CPU-当前CPU近7天最大的使用率(%) ；CK_MASTER_STORAGE-主实例的磁盘空间(GB)；CK_MEMORY-当前内存近7天最大的使用值（GB)； CK_STORAGE-当前磁盘近7天最大的使用值（GB)；CK_UPGRATE- 当前变配检查是否需要迁移，MIGRATE需要迁移变配，LOCAL本地变配； 示例值：0
Passed	Integer	检查条目是否通过 0-不通过，不能变配； 1-通过，可以变配 示例值：0
IsAffect	Integer	本条目变配是否对实例有影响 0-没有影响 1-有影响 示例值：0
Msg	String	有影响或者不通过的情况下的必要描述 示例值：0
MsgCode	Integer	描述对应的代码 示例值：0

CosUploadBackupFile

查询已经上传的备份文件大小。

被如下接口引用：DescribeBackupUploadSize。

名称	类型	描述
FileName	String	备份名称 示例值：mssql-backup
Size	Integer	备份大小 示例值：859

CrossBackupAddr

跨地域备份下载地址集合

被如下接口引用：DescribeBackupFiles, DescribeBackups。

名称	类型	描述
CrossRegion	String	跨地域备份目标地域 示例值：ap-guangzhou
CrossInternalAddr	String	跨地域备份内网下载地址 示例值： http://xxx
CrossExternalAddr	String	跨地域备份外网下载地址 示例值：http://xxx

CrossRegionStatus

跨地域备份的目标地域和备份状态

被如下接口引用：DescribeBackups。

名称	类型	描述
CrossRegion	String	跨地域备份目标地域 示例值：ap-guangzhou
CrossStatus	Integer	备份跨地域的同步状态 0-创建中；1-成功；2-失败；4-同步中 示例值：0

CrossSummaryDetailRes

跨地域备份实时统计列表项

被如下接口引用：DescribeCrossBackupStatistical。

名称	类型	描述
Status	Integer	实例状态 示例值：2
Region	String	实例所属地域 示例值：ap-guangzhou
InstanceId	String	实例ID 示例值：mssql-xxx
Name	String	实例名称 示例值：name
CrossBackupEnabled	String	跨地域备份状态 enable-开启，disable-关闭 示例值：enable
CrossRegions	Array of String	跨地域备份目标地域 示例值：["ap-beijing","ap-shanghai"]
LastBackupStartTime	String	最新备份开始时间 示例值：2022-06-21 11:47:17
CrossBackupSaveDays	Integer	跨地域备份保留天数 示例值：7
DataBackupSpace	Integer	跨地域数据备份总空间 示例值：0
DataBackupCount	Integer	跨地域数据备份文件总个数 示例值：0
LogBackupSpace	Integer	跨地域日志备份总空间 示例值：0
LogBackupCount	Integer	跨地域日志备份文件总个数 示例值：0
ActualUsedSpace	Integer	跨地域备份总空间 示例值：0
ActualUsedCount	Integer	跨地域备份总个数 示例值：0

DBCreateInfo

数据库创建信息

被如下接口引用：CreateDB。

名称	类型	必选	描述
DBName	String	是	数据库名 示例值：DBName
Charset	String	否	字符集。可通过接口DescribeDBCharsets查到支持的字符集，不填默认为Chinese_PRC_CI_AS。 示例值：Chinese_PRC_CI_AS
Accounts	Array of AccountPrivilege	否	数据库账号权限信息 示例值：Accounts
Remark	String	否	备注 示例值：Remark

DBDetail

数据库信息

被如下接口引用：DescribeDBs, DescribeDatabases。

名称	类型	描述
Name	String	数据库名称 示例值：db1
Charset	String	字符集 示例值：Chinese_PRC_CI_AS
Remark	String	备注 示例值：andy
CreateTime	Timestamp	数据库创建时间 示例值：2024-11-14 14:29:38
Status	Integer	数据库状态。1--创建中， 2--运行中， 3--修改中，-1--删除中 示例值：2
Accounts	Array of AccountPrivilege	数据库账号权限信息 示例值：[{"UserName": "andy","Privilege": "ReadOnly","AccountType": "L0"}]
InternalStatus	String	内部状态。ONLINE表示运行中 示例值：ONLINE
Encryption	String	是否已开启TDE加密，enable-已加密，disable-未加密 示例值：disable

DBInstance

实例详细信息

被如下接口引用：DescribeDBInstances。

名称	类型	描述
InstanceId	String	实例ID 示例值：mssql-dj5i29c5n
Name	String	实例名称 示例值：Name
ProjectId	Integer	实例所在项目ID 示例值：0
RegionId	Integer	实例所在地域ID 示例值：1
ZoneId	Integer	实例所在可用区ID 示例值：100004
VpcId	Integer	实例所在私有网络ID，基础网络时为 0 示例值：3834195
SubnetId	Integer	实例所在私有网络子网ID，基础网络时为 0 示例值：67890
Status	Integer	实例状态。取值范围： 1：申请中 2：运行中 3：受限运行中 (主备切换中) 4：已隔离 5：回收中 6：已回收 7：任务执行中 (实例做备份、回档等操作) 8：已下线 9：实例扩容中 10：实例迁移中 11：只读 12：重启中 13：实例修改中且待切换 14：订阅发布创建中 15：订阅发布修改中 16：实例修改中且切换中 17：创建RO副本中 示例值：2
Vip	String	实例访问IP 示例值：192.168.0.16
Vport	Integer	实例访问端口 示例值：1433
CreateTime	Timestamp	实例创建时间 示例值：2020-04-09 00:00:00
UpdateTime	Timestamp	实例更新时间 示例值：2020-04-09 00:00:00
StartTime	Timestamp	实例计费开始时间 示例值：2020-04-09 00:00:00
EndTime	Timestamp	实例计费结束时间 示例值：2020-04-09 00:00:00
IsolateTime	Timestamp	实例隔离时间 示例值：2020-04-09 00:00:00
Memory	Integer	实例内存大小，单位G 示例值：64
UsedStorage	Integer	实例已经使用存储空间大小，单位G 示例值：500
Storage	Integer	实例存储空间大小，单位G 示例值：500
VersionName	String	实例版本 示例值：SQL Server 2008 Enterprise
RenewFlag	Integer	实例续费标记，0-正常续费，1-自动续费，2-到期不续费 示例值：0
Model	Integer	实例高可用， 1-双机高可用，2-单机，3-跨可用区，4-集群跨可用区，5-集群，6-多节点集群，7-多节点集群跨可用区，9-自研机房 示例值：1
Region	String	实例所在地域名称，如 ap-guangzhou 示例值：ap-guangzhou
Zone	String	实例所在可用区名称，如 ap-guangzhou-1 示例值：ap-guangzhou-2
BackupTime	String	备份时间点 示例值：00:00
PayMode	Integer	实例付费模式， 0-按量计费，1-包年包月 示例值：1
Uid	String	实例唯一UID 示例值：gamedb.gz000.cdb.db
Cpu	Integer	实例cpu核心数 示例值：4
Version	String	实例版本代号 示例值：2008R2
Type	String	实例类型代号："TS85"-物理机，本地SSD硬盘；"Z3"-物理机早期版本，本地SSD硬盘；"CLOUD_BASIC"-虚拟机，普通云硬盘；"CLOUD_PREMIUM"-虚拟机，高性能云硬盘；"CLOUD_SSD"-虚拟机，云SSD硬盘；"CLOUD_HSSD"-虚拟机，增强型SSD云硬盘；"CLOUD_TSSD"-虚拟机，极速型SSD云硬盘；"CLOUD_BSSD"-虚拟机，通用型SSD云硬盘 示例值：TS85
Pid	Integer	计费ID 示例值：1
UniqVpcId	String	实例所属VPC的唯一字符串ID，格式如：vpc-xxx，基础网络时为空字符串 示例值：vpc-xxxxx
UniqSubnetId	String	实例所属子网的唯一字符串ID，格式如： subnet-xxx，基础网络时为空字符串 示例值：subnet-xxxxx
IsolateOperator	String	实例隔离操作 示例值：User
SubFlag	String	发布订阅标识，SUB-订阅实例，PUB-发布实例，空值-没有发布订阅的普通实例 示例值：SUB
ROFlag	String	只读标识，RO-只读实例，MASTER-有RO实例的主实例，空值-没有只读组的非RO实例 示例值：MASTER
HAFlag	String	容灾类型，MIRROR-镜像，ALWAYSON-AlwaysOn, SINGLE-单例 示例值：MIRROR
ResourceTags	Array of ResourceTag	实例绑定的标签列表 注意：此字段可能返回 null，表示取不到有效值。 示例值：['Tag1']
BackupModel	String	备份模式，master_pkg-主节点打包备份(默认) ；master_no_pkg-主节点不打包备份；slave_pkg-从节点打包备份(always on集群有效)；slave_no_pkg-从节点不打包备份(always on集群有效)；只读副本对该值无效。 示例值：master_pkg
InstanceNote	String	实例备份信息 示例值：instance note
BackupCycle	Array of Integer	备份周期 示例值：1
BackupCycleType	String	备份周期类型，[daily、weekly、monthly] 示例值：daily
BackupSaveDays	Integer	数据(日志)备份保留时间 示例值：7
InstanceType	String	实例类型 HA-高可用，RO-只读实例，SI-基础版，BI-商业智能服务，cvmHA-云盘高可用，cvmRO-云盘只读实例，MultiHA-多节点，cvmMultiHA-云盘多节点 示例值：HA
CrossRegions	Array of String	跨地域备份目的地域，如果为空，则表示未开启跨地域备份 示例值：[ap-guangzhou]
CrossBackupEnabled	String	跨地域备份状态 enable-开启，disable-关闭 示例值：enable
CrossBackupSaveDays	Integer	跨地域备份保留天数，则默认7天 示例值：7
DnsPodDomain	String	外网地址域名 示例值：gz.xxx.sqlserver.tencent.com
TgwWanVPort	Integer	外网端口号 示例值：2032
Collation	String	系统字符集排序规则，默认：Chinese_PRC_CI_AS 示例值：Chinese_PRC_CI_AS
TimeZone	String	系统时区，默认：China Standard Time 示例值：China Standard Time
IsDrZone	Boolean	是否跨AZ 示例值：false
SlaveZones	SlaveZones	双节点实例备可用区信息 示例值：[{"SlaveZone": "ap-guangzhou-1","SlaveZoneName": "广州一区","DrInstanceId": "mssqldr-9ji781"}]
Architecture	String	架构标识，SINGLE-单节点 DOUBLE-双节点 示例值：DOUBLE
Style	String	类型标识，EXCLUSIVE-独享型，SHARED-共享型 示例值：EXCLUSIVE
MultiSlaveZones	Array of SlaveZones	多节点实例备可用区信息 示例值：[{"SlaveZone": "ap-guangzhou-2","SlaveZoneName": "广州二区","DrInstanceId": "mssqldr-9ji782"}]

DBPrivilege

账号的数据库权限信息

被如下接口引用：CreateAccount, DescribeAccounts, DescribeDBPrivilegeByAccount。

名称	类型	必选	描述
DBName	String	是	数据库名 示例值：db_test
Privilege	String	是	数据库权限，ReadWrite表示可读写，ReadOnly表示只读，DBOwner所有者 示例值：ReadOnly

DBPrivilegeModifyInfo

数据库权限变更信息

被如下接口引用：ModifyAccountPrivilege。

名称	类型	必选	描述
DBName	String	是	数据库名 示例值：db_test
Privilege	String	是	权限变更信息。ReadWrite表示可读写，ReadOnly表示只读，Delete表示删除账号对该DB的权限，DBOwner所有者 示例值：ReadWrite

DBRemark

数据库备注信息

被如下接口引用：ModifyDBRemark。

名称	类型	必选	描述
Name	String	是	数据库名称 示例值：db1
Remark	String	是	备注信息 示例值：andy

DBRenameRes

数据库重命名返回参数

被如下接口引用：DescribeBackupMigration, DescribeDBRestoreTime, DescribeIncrementalMigration。

名称	类型	描述
NewName	String	新数据库名称 示例值：new_db
OldName	String	老数据库名称 示例值：old_db

DBTDEEncrypt

开启、关闭TDE数据库加密

被如下接口引用：ModifyDBEncryptAttributes。

名称	类型	必选	描述
DBName	String	否	数据库名称 示例值：test_db
Encryption	String	否	enable-开启数据库TDE加密，disable-关闭数据库TDE加密 示例值：enable

DataBasePrivilegeModifyInfo

数据库账号权限变更信息

被如下接口引用：ModifyDatabasePrivilege。

名称	类型	必选	描述
DataBaseName	String	是	数据库名称 示例值：db1
AccountPrivileges	Array of AccountPrivilege	是	数据库权限变更信息 示例值：[{"UserName": "andy","Privilege": "ReadOnly","AccountType": " L0"}]

DatabaseTuple

该数据结构表示具有发布订阅关系的两个数据库。

被如下接口引用：CreatePublishSubscribe, DeletePublishSubscribe, ModifyPublishSubscribe。

名称	类型	必选	描述
PublishDatabase	String	是	发布数据库名称 示例值：db1
SubscribeDatabase	String	是	订阅数据库名称 示例值：db2

DatabaseTupleStatus

该数据结构表示具有发布订阅关系的两个数据库，以及其之间发布订阅的状态信息。

被如下接口引用：DescribePublishSubscribe。

名称	类型	描述
PublishDatabase	String	发布数据库名称 示例值：db1
SubscribeDatabase	String	订阅数据库名称 示例值：db2
LastSyncTime	String	最近一次同步时间 示例值：2024-12-23 00:24:26
Status	String	数据库之间的发布订阅状态 running，success，fail，unknow 示例值：running

DbNormalDetail

数据库配置信息

被如下接口引用：DescribeDBsNormal, DescribeDatabasesNormal。

名称	类型	描述
IsSubscribed	String	是否已订阅 0：否 1：是 示例值：0
CollationName	String	数据库排序规则 示例值：Chinese_PRC_CI_AS
IsAutoCleanupOn	String	开启CT之后是否自动清理 0：否 1：是 示例值：0
IsBrokerEnabled	String	是否已启用代理 0：否 1：是 示例值：0
IsCdcEnabled	String	是否已开启/关闭CDC 0：关闭 1：开启 示例值：0
IsDbChainingOn	String	是否已启用/ 禁用CT 0：禁用 1：启用 示例值：0
IsEncrypted	String	是否加密 0：否 1：是 示例值：0
IsMirroring	String	是否是镜像 0：否 1：是 示例值：0
IsPublished	String	是否已发布 0：否 1：是 示例值：0
IsReadCommittedSnapshotOn	String	是否开启快照 0：否 1：是 示例值：0
IsTrustworthyOn	String	是否可信任 0：否 1：是 示例值：0
MirroringState	String	镜像状态 示例值：SYNCHRONIZED
Name	String	数据库名称 示例值：mirror_test37
RecoveryModelDesc	String	恢复模式 示例值：FULL
RetentionPeriod	String	保留天数 示例值：7
StateDesc	String	数据库状态 示例值：ONLINE
UserAccessDesc	String	用户类型 示例值：MULTI_USER
CreateTime	String	数据库创建时间 示例值：2023-01-01 12:00:00
IsFullTextEnabled	String	是否全文启用 0：否 1：是 示例值：0

DbRollbackTimeInfo

数据库可回档时间范围信息

被如下接口引用：DescribeRollbackTime。

名称	类型	描述
DBName	String	数据库名称 示例值：db1
StartTime	Timestamp	可回档开始时间 示例值：2024-12-20 00:24:26
EndTime	Timestamp	可回档结束时间 示例值：2024-12-23 00:24:26

DealInfo

订单信息

被如下接口引用：DescribeOrders。

名称	类型	描述
DealName	String	订单名 示例值：20230101872736
Count	Integer	商品数量 示例值：1
FlowId	Integer	关联的流程 ID，可用于查询流程执行状态 示例值：100367
InstanceIdSet	Array of String	只有创建实例的订单会填充该字段，表示该订单创建的实例的 ID。 示例值：["mssql-6f4ddx2f"]
OwnerUin	String	所属账号 示例值：10000****5643
InstanceChargeType	String	实例付费类型 示例值：POSTPAID

DealInstance

订单号对应的资源ID列表

被如下接口引用：DescribeInstanceByOrders。

名称	类型	描述
InstanceId	Array of String	实例ID 示例值：[mssql-i9auaja]
DealName	String	订单号 示例值：20230101872736

DrReadableInfo

备机只读信息

被如下接口引用：DescribeDBInstancesAttribute。

名称	类型	描述
DrInstanceId	String	备机资源ID 示例值：mssqldr-bh89a1
Zone	String	备机可用区 示例值：ap-guangzhou-3
SlaveStatus	String	备机状态 DR_CREATING-备机创建中 DR_RUNNING-备机运行中 DR_UNAVAILABLE-备机不可用 DR_ISOLATED-备机已隔离 DR_RECYCLING-备机回收中 DR_RECYCLED-备机已回收 DR_JOB_RUNNING-备机执行任务中 DR_OFFLINE-备机已下线 DR_FAIL_OVER-备机只读故障转移中 示例值：enable
ReadableStatus	String	备机可读状态，enable-已开启，disable-已关闭 示例值：enable
Vip	String	备机只读vip 示例值：127.0.0.1
VPort	Integer	备机只读端口 示例值：1433
UniqVpcId	String	备机所在私有网络ID 示例值：vpc-nhu89aj
UniqSubnetId	String	备机所在私有网络子网ID 示例值：sub-87ahua
RoWeight	Integer	备机只读权重 示例值：0
ReadMode	String	备机只读模式，BalancedReadOnly-多备一读模式，SingleReadOnly-一备一读模式 示例值：BalancedReadOnly

DrZoneInfo

备机可用区信息

被如下接口引用：DescribeUpgradeInstanceCheck, UpgradeDBInstance。

名称	类型	必选	描述
DrInstanceId	String	否	备机资源ID 示例值：mssqldr-io91h2
Zone	String	否	备机可用区 示例值：ap-guangzhou-3

EventConfig

设置实例扩展事件阈值

被如下接口引用：StartInstanceXEvent。

名称	类型	必选	描述
EventType	String	是	事件类型，slow-设置慢SQL阈值，blocked-设置阻塞、死锁阈值 示例值：slow
Threshold	Integer	是	阈值，单位毫秒。0表示关闭，大于0表示开启 示例值：1000

Events

实例扩展事件详情

被如下接口引用：DescribeXEvents。

名称	类型	描述
Id	Integer	ID 示例值：100
FileName	String	扩展事件文件名称 示例值：*.xel
Size	Integer	扩展事件文件大小 示例值：1024
EventType	String	事件类型，slow-慢SQL事件，blocked-阻塞事件，deadlock-死锁事件 示例值：slow
Status	Integer	事件记录状态，1-成功，2-失败 示例值：1
StartTime	String	扩展文件生成开始时间 示例值：2023-01-01 12:00:00
EndTime	String	扩展文件生成开始时间 示例值：2023-01-01 12:05:00
InternalAddr	String	内网下载地址 示例值：https://cosback-appid.cos.ap-guangzhou.myqcloud.com/appid%2fsqlserver%2fmssql-mgq355n0%2fbackup%2fautoed_instance_58037_20200728011545.bak.tar?sign=q-sign-algorithm%3dsha1%26q-ak%3d*************************%3b1596177266%26q-key-time%3d1596176966%3b1596177266%26q-header-list%3d%26q-url-param-list%3d%26q-signature%3d3ea8139b631fa13d54b2c03313cbf3850d1e0c2c
ExternalAddr	String	外网下载地址 示例值：https://cosback-appid.cos.ap-guangzhou.myqcloud.com/appid%2fsqlserver%2fmssql-mgq355n0%2fbackup%2fautoed_instance_58037_20200728011545.bak.tar?sign=q-sign-algorithm%3dsha1%26q-ak%3d*************************%26q-sign-time%3d1596176966%3b1596177266%26q-key-time%3d1596176966%3b1596177266%26q-header-list%3d%26q-url-param-list%3d%26q-signature%3d3ea8139b631fa13d54b2c03313cbf3850d1e0c2c

FileAction

允许动作信息

被如下接口引用：DescribeBusinessIntelligenceFile。

名称	类型	描述
AllAction	Array of String	支持的所有操作，值包括：view(查看列表) remark(修改备注)，deploy(部署)，delete(删除文件) 示例值：view
AllowedAction	Array of String	当前状态允许的操作，AllAction的子集,为空表示禁止所有操作 示例值：view

InstanceDBDetail

实例的数据库信息

被如下接口引用：DescribeDBs, DescribeDatabases。

名称	类型	描述
InstanceId	String	实例ID 示例值：mssql-njj2mtpl
DBDetails	Array of DBDetail	数据库信息列表

InstanceRenewInfo

实例续费状态信息

被如下接口引用：ModifyDBInstanceRenewFlag。

名称	类型	必选	描述
InstanceId	String	是	实例ID，形如mssql-j8kv137v 示例值：mssql-j8kv137v
RenewFlag	Integer	是	实例续费标记。0：正常续费，1：自动续费，2：到期不续 示例值：0

InstanceTask

实例异步任务

被如下接口引用：DescribeInstanceTasks。

名称	类型	描述
Id	Integer	唯一id 示例值：100374
Type	Integer	Job类型 示例值：62
Status	Integer	Job状态 示例值：2
Progress	Integer	进度百分比0~100 示例值：50
StartTime	String	开始时间 示例值：2024-08-15 14:25:20
EndTime	String	结束时间 示例值：2024-08-15 14:26:22
ErrorCode	Integer	错误代码 示例值：0
Message	String	错误信息描述 示例值：Asynchronous task failed

InterInstance

互通组内实例信息详情

被如下接口引用：DescribeDBInstanceInter。

名称	类型	描述
InstanceId	String	实例ID 示例值：mssql-dj5i29c5n
InterVip	String	实例互通IP，用于加入互通组后访问 示例值：192.168.0.1
InterPort	Integer	实例互通端口，用于加入互通组后访问 示例值：1433
Status	Integer	实例互通状态，1 -互通ipprot打开中 2 -互通ipprot已经打开 3 -已经打开互通ip的实例加入到互通组中 4 -已经打开互通ip的实例已加入到互通组 5 -互通ipprot回收中 6 -互通ipprot已回收 7 -已回收的实例从互通组中移除中 8 -已回收的实例从互通组中已经移除 示例值：1
Region	String	实例所在地域名称，如 ap-guangzhou 示例值：ap-guangzhou
Zone	String	实例所在可用区名称，如 ap-guangzhou-1 示例值：ap-guangzhou-3
Version	String	实例版本代号 示例值：2008R2
VersionName	String	实例版本 示例值：SQL Server 2008 R2 Enterprise
Name	String	实例名称 示例值：Name
Vip	String	实例访问IP 示例值：192.168.0.2
Vport	Integer	实例访问端口 示例值：1433

InterInstanceFlow

实例开通或者关闭互通组后的状态

被如下接口引用：CloseInterCommunication, OpenInterCommunication。

名称	类型	描述
InstanceId	String	实例ID，例如：mssql-sdf32n1d 示例值：mssql-dj5i29c5n
FlowId	Integer	实例开通或者关闭互通组的流程ID，FlowId小于0-开通或者关闭失败，反之则成功。 示例值：558800

MigrateDB

需要迁移的DB列表

被如下接口引用：CreateMigration, DescribeMigrationDetail, ModifyMigration。

名称	类型	必选	描述
DBName	String	否	迁移数据库的名称 示例值：db1

MigrateDetail

迁移的进度详情类型

被如下接口引用：DescribeMigrations。

名称	类型	描述
StepName	String	当前环节的名称 示例值：Back Up Database
Progress	Integer	当前环节的进度（单位是%） 示例值：50

MigrateSource

迁移任务的源类型

被如下接口引用：CreateMigration, DescribeMigrationDetail, ModifyMigration。

名称	类型	必选	描述
InstanceId	String	否	迁移源实例的ID，MigrateType=1(TencentDB for SQLServers)时使用，格式如：mssql-si2823jyl 示例值：mssql-si2823jyl
CvmId	String	否	迁移源Cvm的ID，MigrateType=2(云服务器自建SQLServer数据库)时使用 示例值：ins-62dhd3d1
VpcId	String	否	迁移源Cvm的Vpc网络标识，MigrateType=2(云服务器自建SQLServer数据库)时使用，格式如：vpc-6ys9ont9 示例值：vpc-6ys9ont9
SubnetId	String	否	迁移源Cvm的Vpc下的子网标识，MigrateType=2(云服务器自建SQLServer数据库)时使用，格式如：subnet-h9extioi 示例值：subnet-h9extioi
UserName	String	否	用户名，MigrateType=1或MigrateType=2使用 示例值：andy
Password	String	否	密码，MigrateType=1或MigrateType=2使用 示例值：Zh22448899
Ip	String	否	迁移源Cvm自建库的内网IP，MigrateType=2(云服务器自建SQLServer数据库)时使用 示例值：172.1.1.5
Port	Integer	否	迁移源Cvm自建库的端口号，MigrateType=2(云服务器自建SQLServer数据库)时使用 示例值：22
Url	Array of String	否	离线迁移的源备份地址，MigrateType=4或MigrateType=5使用 示例值：http://gz-oncvm-1254065710.cosgz.myqcloud.com/test4_20180724021516.bak
UrlPassword	String	否	离线迁移的源备份密码，MigrateType=4或MigrateType=5使用 示例值：Ps55336622

MigrateTarget

迁移任务的目标类型

被如下接口引用：CreateMigration, DescribeMigrationDetail, ModifyMigration。

名称	类型	必选	描述
InstanceId	String	否	迁移目标实例的ID，格式如：mssql-si2823jyl 示例值：mssql-si2823jyl
UserName	String	否	迁移目标实例的用户名 示例值：andy
Password	String	否	迁移目标实例的密码 示例值：Zh22446688

MigrateTask

查询迁移任务列表类型

被如下接口引用：DescribeMigrations。

名称	类型	描述
MigrateId	Integer	迁移任务ID 示例值：2728
MigrateName	String	迁移任务名称 示例值：andy-Migrate
AppId	Integer	迁移任务所属的用户ID 示例值：1254**5710
Region	String	迁移任务所属的地域 示例值：ap-guangzhou
SourceType	Integer	迁移源的类型 1:TencentDB for SQLServer 2:云服务器自建SQLServer数据库 4:SQLServer备份还原 5:SQLServer备份还原（COS方式） 示例值：5
CreateTime	Timestamp	迁移任务的创建时间 示例值：2024-08-06 17:44:58
StartTime	Timestamp	迁移任务的开始时间 示例值：2024-08-06 17:45:58
EndTime	Timestamp	迁移任务的结束时间 示例值：2024-08-06 17:50:58
Status	Integer	迁移任务的状态（1:初始化,4:迁移中,5.迁移失败,6.迁移成功,7已中止,8已删除,9中止中,10完成中,11中止失败,12完成失败） 示例值：1
Message	String	信息 示例值：Message
CheckFlag	Integer	是否迁移任务经过检查（0:未校验,1:校验成功,2:校验失败,3:校验中） 示例值：1
Progress	Integer	迁移任务当前进度（单位%） 示例值：50
MigrateDetail	MigrateDetail	迁移任务进度细节 示例值：[{"StepName": "Back Up Database","Progress": "50"}]

Migration

冷备迁移导入

被如下接口引用：DescribeBackupMigration, DescribeIncrementalMigration。

名称	类型	描述
MigrationId	String	备份导入任务ID 或 增量导入任务ID 示例值：mssql-incremental-migration-kp7bgv8p
MigrationName	String	备份导入名称，增量导入任务该字段为空 示例值：MigrationName
AppId	Integer	应用ID 示例值：251006279
Region	String	地域 示例值：ap-guangzhou
InstanceId	String	迁移目标实例ID 示例值：mssql-rdc0gajn
RecoveryType	String	迁移任务恢复类型 示例值：FULL_LOG
UploadType	String	备份用户上传类型，COS_URL-备份放在用户的对象存储上，提供URL。COS_UPLOAD-备份放在业务的对象存储上，用户上传 示例值：COS_UPLOAD
BackupFiles	Array of String	备份文件列表，UploadType确定，COS_URL则保存URL，COS_UPLOAD则保存备份名称 示例值：db_cvm_1_20200927204209_2log2_2noreconvery2.bak
Status	Integer	迁移任务状态，2-创建完成，7-全量导入中，8-等待增量，9-导入成功，10-导入失败，12-增量导入中 示例值：2
CreateTime	String	迁移任务创建时间 示例值：2020-09-27 20:44:59
StartTime	String	迁移任务开始时间 示例值：0000-00-00 00:00:00
EndTime	String	迁移任务结束时间 示例值：0000-00-00 00:00:00
Message	String	说明信息 示例值：Message
Detail	MigrationDetail	迁移细节 示例值：Detail
Action	MigrationAction	当前状态允许的操作 示例值：Action
IsRecovery	String	是否是最终恢复，全量导入任务该字段为空 示例值：NO
DBRename	Array of DBRenameRes	重命名的数据库名称集合 注意：此字段可能返回 null，表示取不到有效值。 示例值：["renameDB"]

MigrationAction

冷备导入任务允许的操作

被如下接口引用：DescribeBackupMigration, DescribeIncrementalMigration。

名称	类型	描述
AllAction	Array of String	支持的所有操作，值包括：view(查看任务) ，modify(修改任务)， start(启动任务)，incremental(创建增量任务)，delete(删除任务)，upload(获取上传权限)。 示例值：["view"]
AllowedAction	Array of String	当前状态允许的操作，AllAction的子集,为空表示禁止所有操作 示例值：["view"]

MigrationDetail

冷备导入任务迁移细节

被如下接口引用：DescribeBackupMigration, DescribeIncrementalMigration。

名称	类型	描述
StepAll	Integer	总步骤数 示例值：4
StepNow	Integer	当前步骤 示例值：1
Progress	Integer	总进度,如："30"表示30% 示例值：20
StepInfo	Array of MigrationStep	步骤信息，null表示还未开始迁移 示例值：[{"StepNo": "1","StepName": "back up datebase","StepId": "ConnectDBCheck","Status": "1"}]

MigrationStep

冷备导入任务迁移步骤细节

被如下接口引用：DescribeBackupMigration, DescribeIncrementalMigration。

名称	类型	描述
StepNo	Integer	步骤序列 示例值：1
StepName	String	步骤展现名称 示例值：back up datebase
StepId	String	英文ID标识 示例值：ConnectDBCheck
Status	Integer	步骤状态:0-默认值,1-成功,2-失败,3-执行中,4-未执行 示例值：1

ModifyDataBaseTuple

要修改的数据库订阅发布关系集合

被如下接口引用：ModifyPublishSubscribe。

名称	类型	必选	描述
DatabaseTuple	DatabaseTuple	是	要修改的订阅关系
NewDatabaseTuple	DatabaseTuple	否	修改后的订阅关系。DeleteDataBasesTuple为false时有效
DeleteDataBasesTuple	Boolean	否	是否删除订阅关系。此选项为true时，NewDatabaseTuple无效 示例值：true

OldVip

用于返回实例存在的未回收的ip数量

被如下接口引用：DescribeDBInstancesAttribute。

名称	类型	描述
Vip	String	未回收的旧ip 示例值：127.0.0.1
RecycleTime	String	ip回收时间 示例值：2024-03-26 12:28:41
OldIpRetainTime	Integer	旧IP保留时间小时数 示例值：1

ParamRecord

实例参数修改记录

被如下接口引用：DescribeInstanceParamRecords。

名称	类型	描述
InstanceId	String	实例ID 示例值：mssql-hbr4jy7i
ParamName	String	参数名称 示例值：fill factor (%)
OldValue	String	参数修改前的值 示例值：2
NewValue	String	参数修改后的值 示例值：100
Status	Integer	参数修改状态，1-初始化等待被执行，2-执行成功，3-执行失败，4-参数修改中 示例值：2
ModifyTime	String	修改时间 示例值：2020-04-09 00:00:00

Parameter

数据库实例参数

被如下接口引用：ModifyInstanceParam。

名称	类型	必选	描述
Name	String	否	参数名称 示例值：fill factor (%)
CurrentValue	String	否	参数值 示例值：1

ParameterDetail

实例参数的详细描述

被如下接口引用：DescribeInstanceParams。

名称	类型	描述
Name	String	参数名称 示例值：fill factor (%)
ParamType	String	参数类型，integer-整型，enum-枚举型 示例值：INT
Default	String	参数默认值 示例值：0
Description	String	参数描述 示例值：The fill-factor option is provided for fine-tuning index data st
CurrentValue	String	参数当前值 示例值：5
NeedReboot	Integer	修改参数后，是否需要重启数据库以使参数生效，0-不需要重启，1-需要重启 示例值：1
Max	Integer	参数允许的最大值 示例值：100
Min	Integer	参数允许的最小值 示例值：0
EnumValue	Array of String	参数允许的枚举类型 示例值：["YES", "NO"]
Status	Integer	参数状态 0-状态正常 1-在修改中 示例值：0

Price

参考价格，该价格为CPU、内存规格价格，不包括磁盘用量，实际价格以询价接口为准。

被如下接口引用：DescribeSpecSellStatus。

名称	类型	描述
PrepaidPrice	Integer	包年包月参考价格，单位-分 示例值：1
PrepaidPriceUnit	String	包年包月价格单位，M-月 示例值：M
PostpaidPrice	Integer	按量付费价格，单位-分 示例值：1
PostpaidPriceUnit	String	按量付费价格单位，H-小时 示例值：H

ProductSpec

包括地域的产品规格配置

被如下接口引用：DescribeProductSpec。

名称	类型	描述
RegionId	Integer	地域ID 示例值：1
ZoneId	Integer	可用区ID 示例值：100002
Info	Array of SpecInfo	配置信息 示例值：[{"CPU": 1,"MachineType": "TS85","MachineTypeName": "高IO","MaxStorage": 3000,"Memory": 2000000,"MinStorage": 10,"PayModeStatus": "ALL","Pid": 10908,"PostPid": [10908],"QPS": 2100,"SpecId": 15,"SuitInfo": "独立用户数上百人的小型应用","Version": "2008R2","VersionName": "SQL Server 2008 Enterprise"}],"RegionId": 1,"ZoneId": 100002}]

PublishSubscribe

发布订阅对象

被如下接口引用：DescribePublishSubscribe。

名称	类型	描述
Id	Integer	发布订阅ID 示例值：172631
Name	String	发布订阅名称 示例值：sqlPublishSubscribe
PublishInstanceId	String	发布实例ID 示例值：mssql-2cwisu23
PublishInstanceName	String	发布实例名称 示例值：mssql-andy
PublishInstanceIp	String	发布实例IP 示例值：172.1.1.1
SubscribeInstanceId	String	订阅实例ID 示例值：mssql-hlh6yka1
SubscribeInstanceName	String	订阅实例名称 示例值：mssql-toto
SubscribeInstanceIp	String	订阅实例IP 示例值：172.2.2.2
DatabaseTupleSet	Array of DatabaseTupleStatus	数据库的订阅发布关系集合 示例值：[{"PublishDatabase": "db1","SubscribeDatabase": "db2","LastSyncTime": "2024-12-23 00:24:26","Status": " running"}]

ReadOnlyGroup

只读组对象

被如下接口引用：DescribeReadOnlyGroupList。

名称	类型	描述
ReadOnlyGroupId	String	只读组ID 示例值：mssqlrg-dj5i29c5n
ReadOnlyGroupName	String	只读组名称 示例值：default_name
RegionId	String	只读组的地域ID，与主实例相同 示例值：ap-guangzhou
ZoneId	String	只读组的可用区ID，与主实例相同 示例值：ap-guangzhou-2
IsOfflineDelay	Integer	是否启动超时剔除功能，0-不开启剔除功能，1-开启剔除功能 示例值：1
ReadOnlyMaxDelayTime	Integer	启动超时剔除功能后，使用的超时阈值 示例值：100
MinReadOnlyInGroup	Integer	启动超时剔除功能后，只读组至少保留的只读副本数 示例值：1
Vip	String	只读组vip 示例值：127.0.0.1
Vport	Integer	只读组vport 示例值：1433
VpcId	String	只读组私有网络ID 示例值：vpc-kw88teud
SubnetId	String	只读组私有网络子网ID 示例值：subnet-8z5n8tcg
Status	Integer	只读组状态: 1-申请成功运行中，5-申请中 示例值：1
MasterInstanceId	String	主实例ID，形如mssql-sgeshe3th 示例值：mssql-sgeshe3th
ReadOnlyInstanceSet	Array of ReadOnlyInstance	只读实例副本集合
DnsPodDomain	String	RO组外网地址域名 示例值：gz.xxx.sqlserver.tencent.com
TgwWanVPort	Integer	RO组外网地址端口 示例值：2032
ReadOnlyGroupType	Integer	RO只读组类型，1-按照一个实例一个只读组的方式发货，2-新建只读组后发货的所有实例都在这个只读组下面， 3-发货的所有实例都在已有的只读组下面 示例值：1
ReadOnlyGroupForcedUpgrade	Integer	部署RO副本模式，0-默认不升级主实例，1-强制升级主实例完成RO部署 示例值：1

ReadOnlyInstance

只读副本实例

被如下接口引用：DescribeReadOnlyGroupAutoWeight, DescribeReadOnlyGroupDetails, DescribeReadOnlyGroupList。

名称	类型	描述
InstanceId	String	只读副本ID，格式如：mssqlro-3l3fgqn7 示例值：mssql-dj5i29c5n
Name	String	只读副本名称 示例值：andy
Uid	String	只读副本唯一UID 示例值：gamedb.gz000.cdb.db
ProjectId	Integer	只读副本所在项目ID 示例值：0
Status	Integer	只读副本状态。1：申请中 2：运行中 3：被延迟剔除 4：已隔离 5：回收中 6：已回收 7：任务执行中 8：已下线 9：实例扩容中 10：实例迁移中 12：重启中 示例值：1
CreateTime	String	只读副本创建时间 示例值：2020-04-09 00:00:00
UpdateTime	String	只读副本更新时间 示例值：2020-04-09 00:00:00
Memory	Integer	只读副本内存大小，单位G 示例值：2
Storage	Integer	只读副本存储空间大小，单位G 示例值：100
Cpu	Integer	只读副本cpu核心数 示例值：1
Version	String	只读副本版本代号 示例值：2008R2
Type	String	宿主机代号 示例值：TS85
Model	Integer	只读副本模式，2-单机 示例值：2
PayMode	Integer	只读副本计费模式，1-包年包月，0-按量计费 示例值：1
Weight	Integer	只读副本权重 示例值：1
DelayTime	String	只读副本延迟时间，单位秒 示例值：1
SynStatus	String	只读副本与主实例的同步状态。 Init:初始化 DeployReadOnlyInPorgress:部署副本进行中 DeployReadOnlySuccess:部署副本成功 DeployReadOnlyFail:部署副本失败 DeployMasterDBInPorgress:主节点上加入副本数据库进行中 DeployMasterDBSuccess:主节点上加入副本数据库成功 DeployMasterDBFail:主节点上加入副本数据库进失败 DeployReadOnlyDBInPorgress:副本还原加入数据库开始 DeployReadOnlyDBSuccess:副本还原加入数据库成功 DeployReadOnlyDBFail:副本还原加入数据库失败 SyncDelay:同步延迟 SyncFail:同步故障 SyncExcluded:已剔除只读组 SyncNormal:正常 示例值：Init
DatabaseDifference	String	只读副本与主实例没有同步的库 示例值：db1
AccountDifference	String	只读副本与主实例没有同步的账户 示例值：ac1
StartTime	String	只读副本计费开始时间 示例值：2020-04-09 00:00:00
EndTime	String	只读副本计费结束时间 示例值：2020-04-09 00:00:00
IsolateTime	String	只读副本隔离时间 示例值：2020-04-09 00:00:00
RegionId	String	只读副本所在地域 示例值：ap-guangzhou
ZoneId	String	只读副本所在可用区 示例值：ap-guangzhou-3

ReadOnlyInstanceWeightPair

只读实例与权重对应关系

被如下接口引用：ModifyReadOnlyGroupDetails。

名称	类型	必选	描述
ReadOnlyInstanceId	String	是	只读实例ID，格式如：mssqlro-3l3fgqn7 示例值：mssqlro-3l3fgqn7
ReadOnlyWeight	Integer	是	只读实例权重 ，范围是0-100 示例值：10

RegionInfo

地域信息

被如下接口引用：DescribeRegions。

名称	类型	描述
Region	String	地域英文ID，类似ap-guanghou 示例值：ap-guanghou
RegionName	String	地域中文名称 示例值：广州
RegionId	Integer	地域数字ID 示例值：1
RegionState	String	该地域目前是否可以售卖，UNAVAILABLE-不可售卖；AVAILABLE-可售卖 示例值：AVAILABLE

RenameRestoreDatabase

用于RestoreInstance，RollbackInstance，CreateMigration、CloneDB、ModifyBackupMigration 等接口；对恢复的库进行重命名，且支持选择要恢复的库。

被如下接口引用：CloneDB, CreateMigration, ModifyBackupMigration, RestoreInstance, RollbackInstance。

名称	类型	必选	描述
OldName	String	否	库的名字，如果oldName不存在则返回失败。 在用于离线迁移任务时可不填。 示例值：db1
NewName	String	否	库的新名字，在用于离线迁移时，不填则按照OldName命名，OldName和NewName不能同时不填。在用于克隆数据库时，OldName和NewName都必须填写，且不能重复 示例值：db2

ResourceTag

实例绑定的标签信息

被如下接口引用：CreateBasicDBInstances, CreateBusinessDBInstances, CreateCloudDBInstances, CreateCloudReadOnlyDBInstances, CreateDBInstances, CreateReadOnlyDBInstances, DescribeDBInstances, DescribeInstanceTradeParameter。

名称	类型	必选	描述
TagKey	String	否	标签key 示例值：created-by
TagValue	String	否	标签value 示例值：andy

RestoreTask

回档任务记录

被如下接口引用：DescribeRestoreTask。

名称	类型	描述
TargetInstanceId	String	目标实例ID 示例值：mssql-8932uijww
TargetInstanceName	String	目标实例名称 示例值：mssql-890oiioew
TargetInstanceStatus	Integer	目标实例状态。取值范围： 1：申请中 2：运行中 3：受限运行中 (主备切换中) 4：已隔离 5：回收中 6：已回收 7：任务执行中 (实例做备份、回档等操作) 8：已下线 9：实例扩容中 10：实例迁移中 11：只读 12：重启中 示例值：2
TargetRegion	String	目标实例所在地域 示例值：ap-shanghai
RestoreId	Integer	回档记录ID 示例值：2090292
TargetType	Integer	回档到目标实例的类型，0-当前实例，1-已有实例，2-全新实例 示例值：1
RestoreType	Integer	回档方式，0-按照时间点回档，1-按照备份集回档 示例值：1
RestoreTime	String	回档目标时间 示例值：2023-01-01 12:00:00
StartTime	String	开始时间 示例值：2023-01-01 12:00:00
EndTime	String	结束时间 示例值：2023-01-02 12:00:00
Status	Integer	回档状态，0-初始化，1-运行中，2-成功，3-失败 示例值：2
FlowId	Integer	回档异步任务ID 示例值：0

SSLConfig

SSL加密配置

被如下接口引用：DescribeDBInstancesAttribute。

名称	类型	描述
Encryption	String	SSL加密状态， enable-已开启 disable-未开启 enable_doing-开启中 disable_doing-关闭中 renew_doing-更新中 wait_doing-等待维护时间内执行 示例值：disable
SSLValidityPeriod	String	SSL证书有效期，时间格式 YYYY-MM-DD HH:MM:SS 示例值：2023-10-01 12:00:00
SSLValidity	Integer	SSL证书有效性，0-无效，1-有效 示例值：0
IsKMS	Integer	是否是KMS的CMK证书 示例值：0
CMKId	String	KMS中购买的用户主密钥ID（CMK） 示例值：38b504ae-877a-11ef-8a41-*
CMKRegion	String	CMK所属的地域，不同地域的CMK数据不互通 示例值：ap-guangzhou

SecurityGroup

安全组

被如下接口引用：DescribeDBSecurityGroups, DescribeProjectSecurityGroups。

名称	类型	描述
ProjectId	Integer	项目ID 示例值：172632
CreateTime	String	创建时间，时间格式：yyyy-mm-dd hh:mm:ss 示例值：2024-12-23 00:23:13
InboundSet	Array of SecurityGroupPolicy	入站规则 示例值：[{"Action": "ACCEPT","CidrIp": "0.0.0.0/0","Dir": "INPUT","IpProtocol": "ALL","PortRange": "ALL"}]
OutboundSet	Array of SecurityGroupPolicy	出站规则 示例值：[{"Action": "ACCEPT","CidrIp": "0.0.0.0/0","Dir": "OUTPUT","IpProtocol": "ALL","PortRange": "ALL"}]
SecurityGroupId	String	安全组ID 示例值：sg-igw86yth
SecurityGroupName	String	安全组名称 示例值：default
SecurityGroupRemark	String	安全组备注 示例值：System created security group

SecurityGroupPolicy

安全组策略

被如下接口引用：DescribeDBSecurityGroups, DescribeProjectSecurityGroups。

名称	类型	描述
Action	String	策略，ACCEPT 或者 DROP 示例值：ACCEPT
CidrIp	String	目的 IP 或 IP 段，例如172.16.0.0/12 示例值：172.16.0.0/12
PortRange	String	端口或者端口范围 示例值：1433
IpProtocol	String	网络协议，支持 UDP、TCP等 示例值：TCP
Dir	String	规则限定的方向，OUTPUT-出战规则 INPUT-进站规则 示例值： INPUT

SelectAllDB

DB权限修改类型

被如下接口引用：ModifyAccountPrivilege。

名称	类型	必选	描述
Privilege	String	是	权限变更信息。ReadWrite表示可读写，ReadOnly表示只读，Delete表示删除账号对该DB的权限，DBOwner所有者 示例值：ReadWrite

SlaveZones

备可用区信息

被如下接口引用：DescribeDBInstances。

名称	类型	描述
SlaveZone	String	备可用区地域码 示例值：ap-guangzhou-1
SlaveZoneName	String	备可用区 示例值：广州一区
DrInstanceId	String	备机资源ID 示例值：mssqldr-9ji781

SlowLog

慢查询日志文件信息

被如下接口引用：DescribeSlowlogs。

名称	类型	描述
Id	Integer	慢查询日志文件唯一标识 示例值：30304577
StartTime	Timestamp	文件生成的开始时间 示例值：2020-11-05 20:10:05
EndTime	Timestamp	文件生成的结束时间 示例值：2020-11-05 20:17:14
Size	Integer	文件大小（KB） 示例值：1024
Count	Integer	文件中log条数 示例值：5
InternalAddr	String	内网下载地址 示例值：https://sqlserver-bucket-gz-1258415541.cos.ap-guangzhou.myqcloud.com/1251966477%2fsqlserver
ExternalAddr	String	外网下载地址 示例值：https://sqlserver-bucket-gz-1258415541.cos.ap-guangzhou.myqcloud.com/1251966477%2fsqlserver
Status	Integer	状态（1成功 2失败） 示例值：1

SpecInfo

实例可售卖的规格信息

被如下接口引用：DescribeProductConfig, DescribeProductSpec。

名称	类型	描述
SpecId	Integer	实例规格ID，利用DescribeZones返回的SpecId，结合DescribeProductConfig返回的可售卖规格信息，可获悉某个可用区下可购买什么规格的实例 示例值：22
MachineType	String	机型ID 示例值：TS85
MachineTypeName	String	机型中文名称 示例值：高IO
Version	String	数据库版本信息。取值为2008R2（表示SQL Server 2008 R2），2012SP3（表示SQL Server 2012），2016SP1（表示SQL Server 2016 SP1） 示例值：2008R2
VersionName	String	Version字段对应的版本名称 示例值：SQL Server 2008 Enterprise
Memory	Integer	内存大小，单位GB 示例值：128
CPU	Integer	CPU核数 示例值：16
MinStorage	Integer	此规格下最小的磁盘大小，单位GB 示例值：10
MaxStorage	Integer	此规格下最大的磁盘大小，单位GB 示例值：3000
QPS	Integer	此规格对应的QPS大小 示例值：61000
SuitInfo	String	此规格的中文描述信息 示例值：独立用户数上千万人的大型应用
Pid	Integer	此规格对应的包年包月Pid 示例值：10908
PostPid	Array of Integer	此规格对应的按量计费Pid列表 示例值：[10908]
PayModeStatus	String	此规格下支持的付费模式，POST-仅支持按量计费 PRE-仅支持包年包月 ALL-支持所有 示例值：ALL
InstanceType	String	购买实例的类型 HA-本地盘高可用(包括双机高可用，alwaysOn集群)，RO-本地盘只读副本，SI-云盘版单节点,BI-商业智能服务，cvmHA-云盘版高可用，cvmRO-云盘版只读副本，MultiHA-多节点，cvmMultiHA-云盘多节点 示例值：HA 示例值：HA
MultiZonesStatus	String	跨可用区类型，MultiZones-只支持跨可用区，SameZones-只支持同可用区，ALL-支持所有 示例值：ALL

SpecSellStatus

售卖配置状态

被如下接口引用：DescribeSpecSellStatus。

名称	类型	描述
Id	String	可售卖的规格唯一ID 示例值：1
SpecId	Integer	实例规格ID 示例值：23
PayModeStatus	String	此规格下支持的付费模式，POST-仅支持按量计费 PRE-仅支持包年包月 ALL-支持所有 示例值：ALL
InstanceType	String	产品类型，购买实例的类型 HA-本地盘高可用(包括双机高可用，alwaysOn集群)，RO-本地盘只读副本，SI-云盘版单节点,BI-商业智能服务，cvmHA-云盘版高可用，cvmRO-云盘版只读副本，MultiHA-多节点，cvmMultiHA-云盘多节点 示例值：HA
MultiZonesStatus	String	该规格支持的是否跨可用去，MultiZones-只支持跨可用区，SameZones-只支持同可用区，ALL-支持所有 示例值：SameZones
Architecture	String	架构标识，SINGLE-单节点 DOUBLE-双节点 TRIPLE-三节点 MULTI-多节点 示例值：SINGLE 示例值：SINGLE
Style	String	类型标识，EXCLUSIVE-独享型，SHARED-共享型 示例值：EXCLUSIVE
Version	String	数据库版本信息 示例值：2008R2
ZoneStatusSet	Array of ZoneStatus	每个可用区的售卖状态集合
Price	Price	规格的参考价格，实际价格以询价接口为准
Status	Integer	规格售卖状态 1-正常 2-关闭售卖但是可以升级 3-完全关闭售卖 示例值：1

StepDetail

进度步骤详情

被如下接口引用：QueryMigrationCheckProcess。

名称	类型	描述
Msg	String	具体步骤返回信息 示例值：检查数据传输服务器是否能连通源数据库
Status	Integer	当前步骤状态，0成功，-2未开始 示例值：0
Name	String	步骤名称 示例值：源库连接性检查

SummaryDetailRes

备份概览实时统计项

被如下接口引用：DescribeBackupStatistical。

名称	类型	描述
RegionId	Integer	地域标识 示例值：1
Status	Integer	实例状态。1：申请中2：运行中3：受限运行中 (主备切换中)4：已隔离5：回收中6：已回收7：任务执行中 (实例做备份、回档等操作)8：已下线9：实例扩容中10：实例迁移中 示例值：1
InstanceId	String	实例ID 示例值：mssql-7vfv3rk3
Name	String	实例名称 示例值：andy
ActualUsedSpace	Integer	备份空间 示例值：0
DataBackupSpace	Integer	数据备份空间 示例值：0
DataBackupCount	Integer	数据备份文件总个数 示例值：0
LogBackupSpace	Integer	日志备份空间 示例值：0
LogBackupCount	Integer	日志备份文件总个数 示例值：0
AutoBackupSpace	Integer	自动备份空间 示例值：0
AutoBackupCount	Integer	自动备份文件总个数 示例值：0
ManualBackupSpace	Integer	手动备份空间 示例值：0
ManualBackupCount	Integer	手动备份文件总个数 示例值：0
Region	String	实例所属地域码 示例值：ap-guangzhou

SwitchLog

主备切换日志

被如下接口引用：DescribeHASwitchLog。

名称	类型	描述
EventId	String	切换事件ID 示例值：f39bc24b76d1c5d3ce60f0dcb9e0bd79
SwitchType	Integer	切换模式 0-系统自动切换，1-手动切换 示例值：0
StartTime	String	切换开始时间 示例值：2023-01-01 00:00:00
EndTime	String	切换结束时间 示例值：2023-01-01 00:00:00
Reason	String	机器故障导致自动切换 示例值：AUTO

TDEConfigAttribute

TDE透明数据加密配置

被如下接口引用：DescribeDBInstancesAttribute。

名称	类型	描述
Encryption	String	是否已开通TDE加密，enable-已开通，disable-未开通 示例值：disable
CertificateAttribution	String	证书归属。self-表示使用该账号自身的证书，others-表示引用其他账号的证书，none-表示没有证书 示例值：self
QuoteUin	String	开通TDE加密时引用的其他主账号ID 示例值：1000****6845
CMKId	String	KMS中购买的用户主密钥ID（CMK） 示例值：38b504ae-877a-11ef-8a41-***
CMKRegion	String	CMK所属的地域，不同地域的CMK不互通 示例值：ap-guangzhou

ZoneInfo

可用区信息

被如下接口引用：DescribeZones。

名称	类型	描述
Zone	String	可用区英文ID，形如ap-guangzhou-1，表示广州一区 示例值：ap-guangzhou-1
ZoneName	String	可用区中文名称 示例值：广州一区
ZoneId	Integer	可用区数字ID 示例值：100004
SpecId	Integer	该可用区目前可售卖的规格ID，利用SpecId，结合接口DescribeProductConfig返回的数据，可获悉该可用区目前可售卖的规格大小 示例值：22
Version	String	当前可用区与规格下，可售卖的数据库版本，形如2008R2（表示SQL Server 2008 R2）。其可选值有2008R2（表示SQL Server 2008 R2），2012SP3（表示SQL Server 2012），2016SP1（表示SQL Server 2016 SP1） 示例值：2008R2

ZoneStatus

某个地域可用区下的规格售卖状态。

被如下接口引用：DescribeSpecSellStatus。

名称	类型	描述
Zone	String	规格地域 示例值：ap-guangzhou-2
Region	String	规格可用区 示例值：ap-guangzhou
Status	Integer	规格在该可用区的售卖状态 1-正常 2-关闭售卖但是可以升级 3-完全关闭售卖 示例值：1