API 文档

数据结构

最近更新时间:2021-03-10 08:09:09

我的收藏

AccountCreateInfo

账号创建信息

被如下接口引用:CreateAccount。

名称 类型 必选 描述
UserName String 实例用户名
Password String 实例密码
DBPrivileges Array of DBPrivilege DB权限列表
Remark String 账号备注信息
IsAdmin Boolean 是否为管理员账户,默认为否

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的读写权限信息
IsAdmin Boolean 是否为管理员账户

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-手动临时备份
BackupName String 备份名称,可自定义

CosUploadBackupFile

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

被如下接口引用:DescribeBackupUploadSize。

名称 类型 描述
FileName String 备份名称
Size Integer 备份大小

DBCreateInfo

数据库创建信息

被如下接口引用:CreateDB。

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

DBDetail

数据库信息

被如下接口引用:DescribeDBs。

名称 类型 描述
Name String 数据库名称
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-单机,3-跨可用区,4-集群跨可用区,5-集群,9-自研机房
    Region String 实例所在地域名称,如 ap-guangzhou
    Zone String 实例所在可用区名称,如 ap-guangzhou-1
    BackupTime String 备份时间点
    PayMode Integer 实例付费模式, 0-按量计费,1-包年包月
    Uid String 实例唯一UID
    Cpu Integer 实例cpu核心数
    Version String 实例版本代号
    Type String 物理机代号
    Pid Integer 计费ID
    UniqVpcId String 实例所属VPC的唯一字符串ID,格式如:vpc-xxx,基础网络时为空字符串
    UniqSubnetId String 实例所属子网的唯一字符串ID,格式如: subnet-xxx,基础网络时为空字符串
    IsolateOperator String 实例隔离操作
    注意:此字段可能返回 null,表示取不到有效值。
    SubFlag String 发布订阅标识,SUB-订阅实例,PUB-发布实例,空值-没有发布订阅的普通实例
    注意:此字段可能返回 null,表示取不到有效值。
    ROFlag String 只读标识,RO-只读实例,MASTER-有RO实例的主实例,空值-没有只读组的非RO实例
    注意:此字段可能返回 null,表示取不到有效值。
    HAFlag String 容灾类型,MIRROR-镜像,ALWAYSON-AlwaysOn, SINGLE-单例
    注意:此字段可能返回 null,表示取不到有效值。
    ResourceTags Array of ResourceTag 实例绑定的标签列表
    注意:此字段可能返回 null,表示取不到有效值。

    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 备注信息

    DatabaseTuple

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

    被如下接口引用:CreatePublishSubscribe, DeletePublishSubscribe。

    名称 类型 必选 描述
    PublishDatabase String 发布数据库名称
    SubscribeDatabase String 订阅数据库名称

    DatabaseTupleStatus

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

    被如下接口引用:DescribePublishSubscribe。

    名称 类型 描述
    PublishDatabase String 发布数据库名称
    SubscribeDatabase String 订阅数据库名称
    LastSyncTime String 最近一次同步时间
    Status String 数据库之间的发布订阅状态 running,success,fail,unknow

    DbRollbackTimeInfo

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

    被如下接口引用:DescribeRollbackTime。

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

    DealInfo

    订单信息

    被如下接口引用:DescribeOrders。

    名称 类型 描述
    DealName String 订单名
    Count Integer 商品数量
    FlowId Integer 关联的流程 ID,可用于查询流程执行状态
    InstanceIdSet Array of String 只有创建实例的订单会填充该字段,表示该订单创建的实例的 ID。
    OwnerUin String 所属账号
    InstanceChargeType 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(TencentDB 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:TencentDB for SQLServer 2:云服务器自建SQLServer数据库 4:SQLServer备份还原 5:SQLServer备份还原(COS方式)
    CreateTime Timestamp 迁移任务的创建时间
    StartTime Timestamp 迁移任务的开始时间
    EndTime Timestamp 迁移任务的结束时间
    Status Integer 迁移任务的状态(1:初始化,4:迁移中,5.迁移失败,6.迁移成功,7已中止,8已删除,9中止中,10完成中,11中止失败,12完成失败)
    Message String 信息
    CheckFlag Integer 是否迁移任务经过检查(0:未校验,1:校验成功,2:校验失败,3:校验中)
    Progress Integer 迁移任务当前进度(单位%)
    MigrateDetail MigrateDetail 迁移任务进度细节

    Migration

    冷备迁移导入

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

    名称 类型 描述
    MigrationId String 备份导入任务ID 或 增量导入任务ID
    MigrationName String 备份导入名称,增量导入任务该字段为空
    注意:此字段可能返回 null,表示取不到有效值。
    AppId Integer 应用ID
    Region String 地域
    InstanceId String 迁移目标实例ID
    RecoveryType String 迁移任务恢复类型
    UploadType String 备份用户上传类型,COS_URL-备份放在用户的对象存储上,提供URL。COS_UPLOAD-备份放在业务的对象存储上,用户上传
    BackupFiles Array of String 备份文件列表,UploadType确定,COS_URL则保存URL,COS_UPLOAD则保存备份名称
    Status Integer 迁移任务状态,2-创建完成,7-全量导入中,8-等待增量,9-导入成功,10-导入失败,12-增量导入中
    CreateTime String 迁移任务创建时间
    StartTime String 迁移任务开始时间
    EndTime String 迁移任务结束时间
    Message String 说明信息
    Detail MigrationDetail 迁移细节
    Action MigrationAction 当前状态允许的操作
    IsRecovery String 是否是最终恢复,全量导入任务该字段为空
    注意:此字段可能返回 null,表示取不到有效值。

    MigrationAction

    冷备导入任务允许的操作

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

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

    MigrationDetail

    冷备导入任务迁移细节

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

    名称 类型 描述
    StepAll Integer 总步骤数
    StepNow Integer 当前步骤
    Progress Integer 总进度,如:"30"表示30%
    StepInfo Array of MigrationStep 步骤信息,null表示还未开始迁移
    注意:此字段可能返回 null,表示取不到有效值。

    MigrationStep

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

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

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

    PublishSubscribe

    发布订阅对象

    被如下接口引用:DescribePublishSubscribe。

    名称 类型 描述
    Id Integer 发布订阅ID
    Name String 发布订阅名称
    PublishInstanceId String 发布实例ID
    PublishInstanceName String 发布实例名称
    PublishInstanceIp String 发布实例IP
    SubscribeInstanceId String 订阅实例ID
    SubscribeInstanceName String 订阅实例名称
    SubscribeInstanceIp String 订阅实例IP
    DatabaseTupleSet Array of DatabaseTupleStatus 数据库的订阅发布关系集合

    ReadOnlyGroup

    只读组对象

    被如下接口引用:DescribeReadOnlyGroupList。

    名称 类型 描述
    ReadOnlyGroupId String 只读组ID
    ReadOnlyGroupName String 只读组名称
    RegionId String 只读组的地域ID,与主实例相同
    ZoneId String 只读组的可用区ID,与主实例相同
    IsOfflineDelay Integer 是否启动超时剔除功能,0-不开启剔除功能,1-开启剔除功能
    ReadOnlyMaxDelayTime Integer 启动超时剔除功能后,使用的超时阈值
    MinReadOnlyInGroup Integer 启动超时剔除功能后,只读组至少保留的只读副本数
    Vip String 只读组vip
    Vport Integer 只读组vport
    VpcId String 只读组私有网络ID
    SubnetId String 只读组私有网络子网ID
    Status Integer 只读组状态: 1-申请成功运行中,5-申请中
    MasterInstanceId String 主实例ID,形如mssql-sgeshe3th
    ReadOnlyInstanceSet Array of ReadOnlyInstance 只读实例副本集合

    ReadOnlyInstance

    只读副本实例

    被如下接口引用:DescribeReadOnlyGroupDetails, DescribeReadOnlyGroupList。

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

    ReadOnlyInstanceWeightPair

    只读实例与权重对应关系

    被如下接口引用:ModifyReadOnlyGroupDetails。

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

    RegionInfo

    地域信息

    被如下接口引用:DescribeRegions。

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

    RenameRestoreDatabase

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

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

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

    ResourceTag

    实例绑定的标签信息

    被如下接口引用:CreateBasicDBInstances, CreateDBInstances, CreateReadOnlyDBInstances, DescribeDBInstances。

    名称 类型 描述
    TagKey String 标签key
    TagValue String 标签value

    SecurityGroup

    安全组

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

    名称 类型 描述
    ProjectId Integer 项目ID
    CreateTime String 创建时间,时间格式:yyyy-mm-dd hh:mm:ss
    InboundSet Array of SecurityGroupPolicy 入站规则
    OutboundSet Array of SecurityGroupPolicy 出站规则
    SecurityGroupId String 安全组ID
    SecurityGroupName String 安全组名称
    SecurityGroupRemark String 安全组备注

    SecurityGroupPolicy

    安全组策略

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

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

    SlowlogInfo

    慢查询日志文件信息

    被如下接口引用:DescribeSlowlogs。

    名称 类型 描述
    Id Integer 慢查询日志文件唯一标识
    StartTime Timestamp 文件生成的开始时间
    EndTime Timestamp 文件生成的结束时间
    Size Integer 文件大小(KB)
    Count Integer 文件中log条数
    InternalAddr String 内网下载地址
    ExternalAddr String 外网下载地址
    Status Integer 状态(1成功 2失败)
    注意:此字段可能返回 null,表示取不到有效值。

    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
    PostPid Array of Integer 此规格对应的按量计费Pid列表
    注意:此字段可能返回 null,表示取不到有效值。
    PayModeStatus String 此规格下支持的付费模式,POST-仅支持按量计费 PRE-仅支持包年包月 ALL-支持所有
    InstanceType String 产品类型,HA-高可用型(包括双机高可用,alwaysOn集群),RO-只读副本型,SI-基础版本型
    MultiZonesStatus String 跨可用区类型,MultiZones-只支持跨可用区,SameZones-只支持同可用区,ALL-支持所有

    StepDetail

    进度步骤详情

    被如下接口引用:QueryMigrationCheckProcess。

    名称 类型 描述
    Msg String 具体步骤返回信息
    Status Integer 当前步骤状态,0成功,-2未开始
    Name String 步骤名称

    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)
    目录