数据结构

AccountCreateInfo

账号创建信息

被如下接口引用： CreateAccount.

名称	类型	必选	描述
UserName	String	是	实例用户名
Password	String	是	实例密码
DBPrivileges	Array of DBPrivilege	否	DB权限列表
Remark	String	否	账号备注信息

AccountDetail

账户信息详情

被如下接口引用： DescribeAccounts.

名称	类型	描述
Name	String	账户名
Remark	String	账户备注
CreateTime	Timestamp	账户创建时间
Status	Integer	账户状态，1-创建中，2-正常，3-修改中，4-密码重置中，-1-删除中
UpdateTime	Timestamp	账户更新时间
PassTime	Timestamp	密码更新时间
InternalStatus	String	账户内部状态，正常为enable
Dbs	Array of DBPrivilege	该账户对相关db的读写权限信息

AccountPassword

实例账号密码信息

被如下接口引用： ResetAccountPassword.

名称	类型	必选	描述
UserName	String	是	用户名
Password	String	是	密码

AccountPrivilege

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

被如下接口引用： CreateDB, DescribeDBs.

名称	类型	必选	描述
UserName	String	是	数据库用户名
Privilege	String	是	数据库权限。ReadWrite表示可读写，ReadOnly表示只读

AccountPrivilegeModifyInfo

数据库账号权限变更信息

被如下接口引用： ModifyAccountPrivilege.

名称	类型	必选	描述
UserName	String	是	数据库用户名
DBPrivileges	Array of DBPrivilegeModifyInfo	是	账号权限变更信息

AccountRemark

账户备注信息

被如下接口引用： ModifyAccountRemark.

名称	类型	描述
UserName	String	账户名
Remark	String	对应账户新的备注信息

Backup

备份文件详细信息

被如下接口引用： DescribeBackups.

名称	类型	描述
FileName	String	文件名
Size	Integer	文件大小，单位 KB
StartTime	Timestamp	备份开始时间
EndTime	Timestamp	备份结束时间
InternalAddr	String	内网下载地址
ExternalAddr	String	外网下载地址
Id	Integer	备份文件唯一标识，RestoreInstance接口会用到该字段
Status	Integer	备份文件状态（0-创建中；1-成功；2-失败）
DBs	Array of String	多库备份时的DB列表
Strategy	Integer	备份策略（0-实例备份；1-多库备份）
BackupWay	Integer	备份方式，0-定时备份；1-手动临时备份

DBCreateInfo

数据库创建信息

被如下接口引用： CreateDB.

名称	类型	必选	描述
DBName	String	是	数据库名
Charset	String	是	字符集。可选值包括：Chinese_PRC_CI_AS, Chinese_PRC_CS_AS, Chinese_PRC_BIN, Chinese_Taiwan_Stroke_CI_AS, SQL_Latin1_General_CP1_CI_AS, SQL_Latin1_General_CP1_CS_AS。不填默认为Chinese_PRC_CI_AS
Accounts	Array of AccountPrivilege	是	数据库账号权限信息
Remark	String	是	备注

DBDetail

数据库信息

被如下接口引用： DescribeDBs.

名称	类型	描述
Name	String	实例id
Charset	String	字符集
Remark	String	备注
CreateTime	Timestamp	数据库创建时间
Status	Integer	数据库状态。1--创建中， 2--运行中， 3--修改中，-1--删除中
Accounts	Array of AccountPrivilege	数据库账号权限信息
InternalStatus	String	内部状态。ONLINE表示运行中

DBInstance

实例详细信息

被如下接口引用： DescribeDBInstances.

名称	类型	描述
InstanceId	String	实例ID
Name	String	实例名称
ProjectId	Integer	实例所在项目ID
RegionId	Integer	实例所在地域ID
ZoneId	Integer	实例所在可用区ID
VpcId	Integer	实例所在私有网络ID，基础网络时为 0
SubnetId	Integer	实例所在私有网络子网ID，基础网络时为 0
Status	Integer	实例状态。取值范围： 1：申请中 2：运行中 3：受限运行中 (主备切换中) 4：已隔离 5：回收中 6：已回收 7：任务执行中 (实例做备份、回档等操作) 8：已下线 9：实例扩容中 10：实例迁移中 11：只读 12：重启中
Vip	String	实例访问IP
Vport	Integer	实例访问端口
CreateTime	Timestamp	实例创建时间
UpdateTime	Timestamp	实例更新时间
StartTime	Timestamp	实例计费开始时间
EndTime	Timestamp	实例计费结束时间
IsolateTime	Timestamp	实例隔离时间
Memory	Integer	实例内存大小，单位G
UsedStorage	Integer	实例已经使用存储空间大小，单位G
Storage	Integer	实例存储空间大小，单位G
VersionName	String	实例版本
RenewFlag	Integer	实例续费标记，0-正常续费，1-自动续费，2-到期不续费
Model	Integer	实例高可用， 1-双机高可用，2-单机
Region	String	实例所在地域名称，如 ap-guangzhou
Zone	String	实例所在可用区名称，如 ap-guangzhou-1
BackupTime	String	备份时间点

DBPrivilege

账号的数据库权限信息

被如下接口引用： CreateAccount, DescribeAccounts.

名称	类型	必选	描述
DBName	String	是	数据库名
Privilege	String	是	数据库权限，ReadWrite表示可读写，ReadOnly表示只读

DBPrivilegeModifyInfo

数据库权限变更信息

被如下接口引用： ModifyAccountPrivilege.

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

DBRemark

数据库备注信息

被如下接口引用： ModifyDBRemark.

名称	类型	必选	描述
Name	String	是	据库名
Remark	String	是	备注信息

DbRollbackTimeInfo

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

被如下接口引用： DescribeRollbackTime.

名称	类型	描述
DBName	String	数据库名称
StartTime	Timestamp	可回档开始时间
EndTime	Timestamp	可回档结束时间

DealInfo

订单信息

被如下接口引用： DescribeOrders.

名称	类型	描述
DealName	String	订单名
Count	Integer	商品数量
FlowId	Integer	关联的流程 Id，可用于查询流程执行状态
InstanceIdSet	Array of String	只有创建实例的订单会填充该字段，表示该订单创建的实例的 ID。
OwnerUin	String	所属账号

InstanceDBDetail

实例的数据库信息

被如下接口引用： DescribeDBs.

名称	类型	描述
InstanceId	String	实例id
DBDetails	Array of DBDetail	数据库信息列表

InstanceRenewInfo

实例续费状态信息

被如下接口引用： ModifyDBInstanceRenewFlag.

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

MigrateDB

需要迁移的DB列表

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

名称	类型	必选	描述
DBName	String	否	迁移数据库的名称

MigrateDetail

迁移的进度详情类型

被如下接口引用： DescribeMigrations.

名称	类型	描述
StepName	String	当前环节的名称
Progress	Integer	当前环节的进度（单位是%）

MigrateSource

迁移任务的源类型

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

名称	类型	必选	描述
InstanceId	String	否	迁移源实例的ID，MigrateType=1(CDB for SQLServers)时使用，格式如：mssql-si2823jyl
CvmId	String	否	迁移源Cvm的ID，MigrateType=2(云服务器自建SQLServer数据库)时使用
VpcId	String	否	迁移源Cvm的Vpc网络标识，MigrateType=2(云服务器自建SQLServer数据库)时使用，格式如：vpc-6ys9ont9
SubnetId	String	否	迁移源Cvm的Vpc下的子网标识，MigrateType=2(云服务器自建SQLServer数据库)时使用，格式如：subnet-h9extioi
UserName	String	否	用户名，MigrateType=1或MigrateType=2使用
Password	String	否	密码，MigrateType=1或MigrateType=2使用
Ip	String	否	迁移源Cvm自建库的内网IP，MigrateType=2(云服务器自建SQLServer数据库)时使用
Port	Integer	否	迁移源Cvm自建库的端口号，MigrateType=2(云服务器自建SQLServer数据库)时使用
Url	Array of String	否	离线迁移的源备份地址，MigrateType=4或MigrateType=5使用
UrlPassword	String	否	离线迁移的源备份密码，MigrateType=4或MigrateType=5使用

MigrateTarget

迁移任务的目标类型

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

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

MigrateTask

查询迁移任务列表类型

被如下接口引用： DescribeMigrations.

名称	类型	描述
MigrateId	Integer	迁移任务ID
MigrateName	String	迁移任务名称
AppId	Integer	迁移任务所属的用户ID
Region	String	迁移任务所属的地域
SourceType	Integer	迁移源的类型 1:CDB for SQLServer 2:云服务器自建SQLServer数据库 4:SQLServer备份还原 5:SQLServer备份还原（COS方式）
CreateTime	Timestamp	迁移任务的创建时间
StartTime	Timestamp	迁移任务的开始时间
EndTime	Timestamp	迁移任务的结束时间
Status	Integer	迁移任务的状态（1:初始化,4:迁移中,5.迁移失败,6.迁移成功）
Message	String	信息
CheckFlag	Integer	是否迁移任务经过检查（0:未校验,1:校验成功,2:校验失败,3:校验中）
Progress	Integer	迁移任务当前进度（单位%）
MigrateDetail	MigrateDetail	迁移任务进度细节

RegionInfo

地域信息

被如下接口引用： DescribeRegions.

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

SlowlogInfo

慢查询日志文件信息

被如下接口引用： DescribeSlowlogs.

名称	类型	描述
Id	Integer	慢查询日志文件唯一标识
StartTime	Timestamp	文件生成的开始时间
EndTime	Timestamp	文件生成的结束时间
Size	Integer	文件大小（KB）
Count	Integer	文件中log条数
InternalAddr	String	内网下载地址
ExternalAddr	String	外网下载地址

SpecInfo

实例可售卖的规格信息

被如下接口引用： DescribeProductConfig.

名称	类型	描述
SpecId	Integer	实例规格ID，利用DescribeZones返回的SpecId，结合DescribeProductConfig返回的可售卖规格信息，可获悉某个可用区下可购买什么规格的实例
MachineType	String	机型ID
MachineTypeName	String	机型中文名称
Version	String	数据库版本信息。取值为2008R2（表示SQL Server 2008 R2），2012SP3（表示SQL Server 2012），2016SP1（表示SQL Server 2016 SP1）
VersionName	String	Version字段对应的版本名称
Memory	Integer	内存大小，单位GB
CPU	Integer	CPU核数
MinStorage	Integer	此规格下最小的磁盘大小，单位GB
MaxStorage	Integer	此规格下最大的磁盘大小，单位GB
QPS	Integer	此规格对应的QPS大小
SuitInfo	String	此规格的中文描述信息
Pid	Integer	此规格对应的Pid

ZoneInfo

可用区信息

被如下接口引用： DescribeZones.

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