You need to enable JavaScript to run this app.
导航
数据结构
最近更新时间:2024.11.21 09:55:31首次发布时间:2023.04.24 11:01:03

本文汇总云数据库 SQL Server 版的 API 接口中使用的数据结构定义详情。

AddressObject

名称类型示例值描述

DNSVisibility

Bool

false

表示是否开启私网到公网解析,取值如下:

  • true:表示开启私网到公网解析。
  • false:表示不开启私网到公网解析。
DomainStringmssqldab1be87****.rds-mssql.ivolces.com连接域名。
EipIdStringeip-5go6uulm687473inqk15****EIP 的 ID,仅对公网地址有效。
IPAddressString10.1.2.3IP 地址。

NetworkType

String

Private

网络地址类型。取值:

  • Private:私网类型。
  • Public:公网类型。
PortString1433端口。
SubnetIdStringsubnet-2bzup883l93402dx0efe1****子网 ID,仅对私网地址有效。

BackupDatabaseDetailObject

名称类型示例值描述

BackupType

String

Full

备份类型。取值如下:

  • Full:表示全量备份。

  • Diff:表示差异备份。

BackupFileNameStringbackup/mssql-bbe31c86****/D/1692648480-master-D-06bf4b6a4313495c9debd28bf3ab****.bak备份文件名称。
BackupFileSizeLong1048576备份文件大小,单位为 Byte。
BackupStartTimeString2023-08-22T08:17:14.000Z备份的开始时间。格式:yyyy-MM-ddTHH:mm:sssZ(UTC 时间)。
BackupEndTimeString2023-08-22T08:17:14.000Z备份的结束时间。格式:yyyy-MM-ddTHH:mm:sssZ(UTC 时间)。
DatabaseNameStringtestname数据库名称。

BackupDownloadLinkInner

String

https://*****

内网备份下载链接。

说明

获取内网备份下载链接前,您需要调用 DownloadBackup 接口获取全量物理备份文件。

BackupDownloadLinkEIP

String

https://*****

外网备份下载链接。

说明

获取外网备份下载链接前,您需要调用 DownloadBackup 接口获取全量物理备份文件。

LinkExpiredTime

String

2023-05-11T02:55:44.000Z

下载链接过期时间,格式:yyyy-MM-ddTHH:mm:sssZ(UTC 时间)。

DownloadProgressInteger10备份文件准备进度,单位:%。

DownloadStatus

string

Success

备份文件准备状态。取值:

  • Success:准备完成。

  • Failed:准备失败。

  • Running:准备中。

  • NotDownload:没有下载。

BackupMetaObject

名称类型是否必选示例值描述
DBNameStringdbname备份的数据库名称。

BackupsInfoObject

名称类型示例值描述
BackupEndTimeString2023-04-17T18:48:00.000Z备份的结束时间,格式:yyyy-MM-ddTHH:mm:sssZ(UTC 时间)。
BackupFileSizeLong5129555备份文件大小,单位为 Byte。
BackupIdString8d4ce0cbd1d643cc8287cedbf421****备份 ID。

BackupMethod

String

Physical

备份方式,取值:

  • Logical:逻辑备份。

  • Physical:物理备份。

  • Snapshot:快照备份。

BackupStartTimeString2023-04-17T18:48:00.000Z备份的开始时间,格式:yyyy-MM-ddTHH:mm:sssZ(UTC 时间)。

BackupStatus

String

Success

备份状态,取值:

  • Success:成功。

  • Failed:失败。

  • Running:执行中。

BackupType

String

Full

备份类型。取值:

  • Full:全量备份。

  • Diff:增量备份。

CreateType

String

System

创建类型,取值:

  • System:系统。

  • User:用户。

DownloadProgressInteger10备份文件的准备进度,单位为 %

DownloadStatus

string

Success

备份文件的准备状态。取值:

  • Success:准备完成。

  • Failed:准备失败。

  • Running:准备中。

  • NotDownload:没有下载。

BackupDatabaseDetail

Array of BackupDatabaseDetailObject

BackupDatabaseDetail

备份信息。

说明

在调用 DescribeBackups 接口查看云数据库 SQL Server 版实例的备份集列表时支持返回该参数。

MaintenanceTimeString22:00Z-02:59Z实例的可维护时间段。格式:HH:mmZ-HH:mmZ(UTC时间)。

BasicInfoObject

名称类型示例值描述
BackupUseFolat1.42实例已用备份空间。单位:GiB。
CreateTimeString2023-12-26T02:32:36.000Z创建实例的实际时间。

DBEngineVersion

String

SQLServer_2019_Std

兼容版本。取值如下:

  • SQLServer_2019_Std:表示 SQL Server 2019 标准版。
  • SQLServer_2019_Web:表示 SQL Server 2019 Web 版。
  • SQLServer_2019_Ent:表示 SQL Server 2019 企业版。
InnerVersionString15.0.4335.1小版本信息。
InstanceIdStringmssql-dab1be87****实例 ID。
InstanceNameString实例样例实例名称。

InstanceStatus

String

Running

实例状态,取值:

  • Running:运行中。
  • Creating:创建中。
  • Deleting:删除中。
  • Restarting:重启中。
  • Updating:变更中。
  • MasterChanging:主节点切换中。
  • Error:错误。

InstanceType

String

HA

实例类型。取值如下:

  • HA:表示高可用类型。

  • Basic:表示基础版类型。

  • Cluster:表示集群版类型。

  • ReadOnly:表示实例的类型为只读实例。

说明

  • DBEngineVersion 设置为 SQLServer_2019_Std 时,InstanceType 支持返回 HABasic

  • DBEngineVersion 设置为 SQLServer_2019_Ent 时,InstanceType 支持返回 ClusterBasicReadOnly

  • DBEngineVersion 设置为 SQLServer_2019_Web 时,InstanceType 支持返回 Basic

MemoryInteger16内存大小,单位为 GiB。
NodeSpecStringrds.mssql.ee.ha.x8.4c32g主节点规格。
ProjectNameStringTest所属项目。
RegionIdStringcn-beijing地域 ID。

ServerCollation

String

Chinese_PRC_CS_AS

实例字符集排序规则,默认取值为 Chinese_PRC_CI_AS。已支持的字符集取值如下:

  • Latin1_General_CI_AS

  • Latin1_General_CS_AS

  • SQL_Latin1_General_CP1_CI_AS

  • SQL_Latin1_General_CP1_CS_AS

  • Chinese_PRC_CI_AS

  • Chinese_PRC_CS_AS

  • Chinese_PRC_BIN

  • Japanese_CI_AS

  • Japanese_CS_AS

  • Chinese_Taiwan_Stroke_CI_AS

  • Chinese_Taiwan_Stroke_CS_AS

  • Thai_CI_AS

SlowQueryEnable

String

false

表示是否开启慢日志,取值如下:

  • true:表示开启慢日志。
  • false:表示不开启慢日志。
SlowQueryTimeString1慢日志的阈值,取值范围为 [1~10],单位:秒(s)。
StorageSpaceInteger200实例总存储空间。单位:GiB。
StorageTypeStringESSDPL1实例存储类型。取值为 ESSDPL1,表示极速型 SSD PL1。
StorageUseFloat1.85实例已用储空间。单位:GiB。

SubnetId

String

subnet-rroau2hdn1mov0x57f7****

子网 ID。

说明

当返回两个子网,并使用英文分号(;)隔开时,则表示主备节点部署在不同可用区,默认第一个为主节点子网,第二个为备节点子网。

TimeZoneStringChina Standard Time时区。
UpdateTimeString2024-01-03T07:15:08.000Z实例的更新时间。
VCPUInteger4CPU 大小。例如:1 表示 1 核。
VpcIdStringvpc-13g2qkkzntfy83n6nu4z1****私有网络(VPC) ID。

ZoneId

String

cn-beijing-a

可用区 ID。

说明

当返回两个可用区,并使用英文分号(;)隔开时,则表示主备节点部署在不同可用区,默认第一个为主节点子网,第二个为备节点子网。

ReadOnlyNumberInteger1只读实例的个数。
PrimaryInstanceIdStringmssql-e75beddc****主实例 ID。

Tags

Array of TagsObject

{
"Key":"key", "Value":"value"
}

实例标签。详细信息,请参见数据结构

ChargeDetailObject

名称类型示例值描述

AutoRenew

Bool

false

预付费场景下是否自动续费。

  • true:自动续费(默认)。
  • false:不自动续费。
ChargeStartTimeString2023-02-03T06:16:03.000Z计费开始时间,格式为 yyyy-MM-ddTHH:mm:sssZ(UTC 时间)。
ChargeEndTimeString2023-03-02T15:59:59.000Z计费到期时间,格式为 yyyy-MM-ddTHH:mm:sssZ(UTC 时间)。

ChargeStatus

String

Normal

付费状态。取值:

  • Normal:表示实例正常。
  • Overdue:表示实例欠费。
  • Unpaid:表示实例等待支付。

ChargeType

String

PostPaid

付费类型。取值:

  • PostPaid:表示按量付费。
  • PrePaid:表示包年包月。
OverdueReclaimTimeString2023-03-09T15:59:59.000Z欠费关停时预计释放时间,格式为 yyyy-MM-ddTHH:mm:sssZ(UTC 时间)。
OverdueTimeString2023-03-03T04:00:00.000Z欠费关停时间,格式为 yyyy-MM-ddTHH:mm:sssZ(UTC 时间)。
PeriodInteger1预付费场景下的购买时长。默认值:1

PeriodUnit

String

Month

预付费场景下的购买周期。

  • Month:表示包月(默认值)。
  • Year:表示包年。

ChargeInfoObject

名称类型是否必选示例值描述

ChargeType

String

PostPaid

付费类型。取值:

  • PostPaid:按量付费。
  • PrePaid:包年包月。

AutoRenew

Bool

true

预付费场景下是否自动续费。当 ChargeTypePrepaid 时,可设置该参数。

  • true:表示开启自动续费(默认值)。
  • false:表示不开启自动续费。

PeriodUnit

String

Month

预付费场景下的购买周期。当 ChargeTypePrepaid 时,可设置该参数。

  • Month:表示包月(默认)。
  • Year:表示包年。
PeriodInteger1预付费场景下的购买时长。当 ChargeTypePrepaid 时,必须设置该参数。
NumberInteger1实例购买数量。默认值:1,取值范围为 [1,10]。

ConnectionInfo

名称类型示例值描述
AddressArray of AddressObjectAddressObject地址信息。
DescriptionString无。描述信息。
EndpointIdStringmssql-dab1be87****-primary终端 ID。
EndpointNameString主连接终端终端名称。

EndpointType

String

Primary

终端类型。取值如下

  • Primary:表示主节点终端。

  • ROCluster:表示只读集群终端。

  • RO:表示只读节点终端。

DatabaseObject

名称类型是否必选示例值描述
DBNameStringtest原数据库名称。

NewDBName

String

test_bak

新数据库新名称。

说明

在不配置此参数时,默认与原数据库名称保持一致。

InstancesInfoObject

名称类型示例值描述
ChargeDetailChargeDetailObjectChargeDetail付费方式。
CreateTimeString2023-04-04T07:04:21.000Z实例创建的本地时间,格式为 yyyy-MM-ddTHH:mm:ss.sZ(UTC 时间)。

DBEngineVersion

String

SQLServer_2019_Std

兼容版本。取值如下:

  • SQLServer_2019_Std:表示 SQL Server 2019 标准版。
  • SQLServer_2019_Web:表示 SQL Server 2019 Web 版。
  • SQLServer_2019_Ent:表示 SQL Server 2019 企业版。
InstanceIdStringmssql-dab1be87****实例 ID。
InstanceNameString实例样例实例名称。

InstanceStatus

String

Running

实例状态,取值可为:

  • Running:运行中。
  • Creating:创建中。
  • Deleting:删除中。
  • Restarting:重启中。
  • Updating:变更中。
  • MasterChanging:主备切换中。
  • Error:错误。

InstanceType

String

HA

实例类型。取值如下:

  • HA:表示高可用类型。

  • Basic:表示基础版类型。

  • Cluster:表示集群版类型。

  • ReadOnly:表示实例的类型为只读实例。

说明

  • DBEngineVersion 设置为 SQLServer_2019_Std 时,InstanceType 支持返回 HABasic

  • DBEngineVersion 设置为 SQLServer_2019_Ent 时,InstanceType 支持返回 ClusterBasicReadOnly

  • DBEngineVersion 设置为 SQLServer_2019_Web 时,InstanceType 支持返回 Basic

NodeDetailInfoArray of NodeDetailInfoObjectDescribeDBInstanceDetail实例节点信息。
NodeSpecStringrds.mssql.ee.ha.x8.4c32g主节点规格。
PortString1433实例的内网端口。
ProjectNameStringTest所属项目。
RegionIdStringcn-beijing地域 ID,可调用 DescribeRegions 查询,使用此参数指定要创建实例的地域。

ServerCollation

String

Chinese_PRC_CS_AS

实例字符集排序规则,默认取值为 Chinese_PRC_CI_AS。已支持的字符集取值如下:

  • Latin1_General_CI_AS

  • Latin1_General_CS_AS

  • SQL_Latin1_General_CP1_CI_AS

  • SQL_Latin1_General_CP1_CS_AS

  • Chinese_PRC_CI_AS

  • Chinese_PRC_CS_AS

  • Chinese_PRC_BIN

  • Japanese_CI_AS

  • Japanese_CS_AS

  • Chinese_Taiwan_Stroke_CI_AS

  • Chinese_Taiwan_Stroke_CS_AS

  • Thai_CI_AS

StorageSpaceInteger200实例总存储空间。单位:GiB。
StorageTypeStringESSDPL1实例存储类型。取值为 ESSDPL1

SubnetId

String

subnet-2bzup883l93402dx0efe1****

子网 ID。

说明

当返回两个子网,并使用英文分号(;)隔开时,则表示主备节点部署在不同可用区,默认第一个为主节点子网,第二个为备节点子网。

TimeZoneStringChina Standard Time时区。
VpcIdStringvpc-2d5xeur6hiscg58ozfcuq****私有网络(VPC) ID。

ZoneId

String

cn-beijing-a

可用区 ID。

说明

当返回两个可用区,并使用英文分号(;)隔开时,则表示主备节点部署在不同可用区,默认第一个为主节点子网,第二个为备节点子网。

InstanceCategory

String

Primary

实例类型,取值如下:

  • Primary:表示主实例。
  • ReadOnly:表示只读实例。
ReadOnlyNumberInteger1只读实例的个数。
PrimaryInstanceIdStringmssql-e75beddc****主实例 ID。

Tags

Array of TagsObject

{
"Key":"key", "Value":"value"
}

实例标签。详细信息,请参见数据结构

MaintenanceTimeString22:00Z-02:59Z实例的可维护时间段。格式:HH:mmZ-HH:mmZ(UTC时间)。

InstanceParametersObject

名称类型示例值描述
CheckingCodeString[10-3000]参数取值范围。

ForceModify

Bool

false

表示参数运行值是否可修改。

  • true:表示参数的运行值可修改。
  • false:表示参数的运行值不可修改。

ForceRestart

Bool

false

表示修改参数的运行值后,实例是否需重启才生效。

  • true:表示修改参数的运行值后需要重启实例才生效。
  • false:表示修改参数的运行值后不需重启实例。
ParameterDefaultValueString1实例采用的参数模板中为该参数提供的默认值
ParameterDescriptionStringDatabase Mail XPs 选项。使用 DatabaseMail XPs 选项可以在此服务器上启用数据库邮件参数描述。
ParameterNameStringautomatic soft-NUMA disabled参数名。

ParameterType

String

Integer

参数类型,取值为:

  • String
  • Integer
  • Boolean
  • List
  • Float
ParameterValueString1表示参数的取值。

NodeDetailInfoObject

名称类型示例值描述
CreateTimeString2024-01-02T11:17:33.000Z节点的创建时间。
InstanceIdStringmssql-93420fe2****实例 ID。
MemoryInteger8内存大小,单位为 GiB。
NodeIdStringmssql-dab1be87****-0节点 ID。
NodeSpecStringrds.mssql.se.ha.d4.4c16g节点规格。

NodeStatus

String

Running

节点状态,取值为:

  • Running:运行中。
  • Creating:创建中。
  • Deleting:删除中。
  • Restarting:重启中。
  • Updating:变更中。
  • MasterChanging:主备切换中。
  • Error:错误。

NodeType

String

Primary

节点类型。取值:

  • Primary:表示主节点终端。
  • ReadOnly:表示只读节点终端。
  • Secondary:表示备节点终端。
RegionIdStringcn-beijing地域 ID。
UpdateTimeString2024-01-03T09:34:55.000Z节点的更新时间。
VCPUInteger4CPU 大小。例如:1 表示 1 核。
ZoneIdStringcn-beijing-a可用区 ID。
NodeIPString192.168.***.***节点 IP。

RegionObject

名称类型示例值描述
RegionIdStringcn-beijing地域 ID。
RegionNameStringcn-beijing地域名称。

RestoreTaskDetailObject

名称类型示例值描述
RestoreFileNameStringcopyonly_log.bak恢复文件名称。
RestoreFileSizeString202394112恢复文件大小,单位:Byte。

RestoreStartTime

String

2023-05-11T02:55:38.000Z

恢复开始时间,格式:yyyy-MM-ddTHH:mm:sssZ(UTC 时间)。

RestoreEndTimeString2023-05-11T02:55:44.000Z恢复结束时间,格式:yyyy-MM-ddTHH:mm:sssZ(UTC 时间)。

BackupType

String

Full

恢复类型。取值如下:

  • Full:表示全量恢复。

  • Diff:表示增量恢复。

  • LOG:表示日志恢复。

DBNameStringtestdb数据库名称。
RestoreDescString恢复成功恢复详情。

RestoreTaskObject

名称类型示例值描述
RestoreTaskIdString90恢复任务 ID。
InstanceIdStringmssql-bbe31c86****实例 ID。
InstanceNameStringtestname实例名称。
TaskStartTimeString2023-08-22T09:51:00.000Z任务开始时间:格式:yyyy-MM-ddTHH:mm:sssZ(UTC 时间)。
TaskEndTimeString2023-08-22T09:50:45.000Z任务结束时间:格式:yyyy-MM-ddTHH:mm:sssZ(UTC 时间)。

TaskStatus

String

Failed

任务状态,取值如下:

  • NoStart:表示任务未开始。

  • Running:表示任务运行中。

  • Success:表示任务执行成功。

  • Failed:表示任务执行失败。

说明

恢复失败的任务中可能也存在部分数据库恢复完成的场景,您可以调用 DescribeTosRestoreTaskDetail 接口查看更多详细信息。

TaskType

String

OpenDB

任务类型,取值如下:

  • OpenDB:表示打开数据库。

  • NotOpenDB:表示不打开数据库。

IsReplaceBooleanfalse表示恢复时不覆盖目标实例上已经存在的数据库,取值为 false

RestoreType

String

Full

恢复类型。取值如下:

  • Full:表示全量恢复。

  • Diff:表示增量恢复。

  • LOG:表示日志恢复。

TaskDescString恢复文件校验失败任务备份描述。

TagFilterObject

名称类型是否必选示例值描述

Key

String

abc

实例标签的标签键。

说明

  • 单次查询中标签数量不超过 10 个。
  • 标签键允许重复。
  • 标签键不可为空。

Value

String

3

实例标签的标签值。

说明

  • 如果传入该参数,则必须先传入 Key。
  • 不传则表示查询同一标签键下的所有标签值。
  • 传入空字符串时,表示查询标签值为空的标签。

TagsObject

参数类型是否必选描述示例值

Key

String

标签的键信息。配置规格如下:

  • 支持任何语言、文字、数字、空格或符号(_.:/=+-@)。
  • 大小写敏感,且长度在 1~128 个字符内。
  • 使用 UTF-8 编码的 Unicode 格式。
  • 不支持设置以 volc: 开头的任何形式的 Key,例如 Volc:VOLC: 等。
  • 单次最多不可设置 20 个,且不可重复。

key1

Value

String

标签的值信息。配置规格如下:

  • 支持任何语言、文字、数字、空格或符号(_.:/=+-@)。
  • 大小写敏感,且长度在 0~256 个字符内。
  • 使用 UTF-8 编码的 Unicode 格式。

value1

ZonesObject

名称类型示例值描述
ZoneIdStringcn-beijing-a可用区 ID。
ZoneNameStringcn-beijing-a可用区名称。
DescriptionString华北2(北京)-可用区A地域可用区名称。