本文汇总云数据库 SQL Server 版的 API 接口中使用的数据结构定义详情。
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
DNSVisibility | Bool | false | 表示是否开启私网到公网解析,取值如下:
|
Domain | String | mssqldab1be87****.rds-mssql.ivolces.com | 连接域名。 |
EipId | String | eip-5go6uulm687473inqk15**** | EIP 的 ID,仅对公网地址有效。 |
IPAddress | String | 10.1.2.3 | IP 地址。 |
NetworkType | String | Private | 网络地址类型。取值:
|
Port | String | 1433 | 端口。 |
SubnetId | String | subnet-2bzup883l93402dx0efe1**** | 子网 ID,仅对私网地址有效。 |
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
BackupType | String | Full | 备份类型。取值如下:
|
BackupFileName | String | backup/mssql-bbe31c86****/D/1692648480-master-D-06bf4b6a4313495c9debd28bf3ab****.bak | 备份文件名称。 |
BackupFileSize | Long | 1048576 | 备份文件大小,单位为 Byte。 |
BackupStartTime | String | 2023-08-22T08:17:14.000Z | 备份的开始时间。格式:yyyy-MM-ddTHH:mm:sssZ(UTC 时间)。 |
BackupEndTime | String | 2023-08-22T08:17:14.000Z | 备份的结束时间。格式:yyyy-MM-ddTHH:mm:sssZ(UTC 时间)。 |
DatabaseName | String | testname | 数据库名称。 |
BackupDownloadLinkInner | String | https://***** | 内网备份下载链接。 说明 获取内网备份下载链接前,您需要调用 DownloadBackup 接口获取全量物理备份文件。 |
BackupDownloadLinkEIP | String | https://***** | 外网备份下载链接。 说明 获取外网备份下载链接前,您需要调用 DownloadBackup 接口获取全量物理备份文件。 |
LinkExpiredTime | String | 2023-05-11T02:55:44.000Z | 下载链接过期时间,格式:yyyy-MM-ddTHH:mm:sssZ(UTC 时间)。 |
DownloadProgress | Integer | 10 | 备份文件准备进度,单位:%。 |
DownloadStatus | string | Success | 备份文件准备状态。取值:
|
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
DBName | String | 是 | dbname | 备份的数据库名称。 |
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
BackupEndTime | String | 2023-04-17T18:48:00.000Z | 备份的结束时间,格式:yyyy-MM-ddTHH:mm:sssZ(UTC 时间)。 |
BackupFileSize | Long | 5129555 | 备份文件大小,单位为 Byte。 |
BackupId | String | 8d4ce0cbd1d643cc8287cedbf421**** | 备份 ID。 |
BackupMethod | String | Physical | 备份方式,取值:
|
BackupStartTime | String | 2023-04-17T18:48:00.000Z | 备份的开始时间,格式:yyyy-MM-ddTHH:mm:sssZ(UTC 时间)。 |
BackupStatus | String | Success | 备份状态,取值:
|
BackupType | String | Full | 备份类型。取值:
|
CreateType | String | System | 创建类型,取值:
|
DownloadProgress | Integer | 10 | 备份文件的准备进度,单位为 % 。 |
DownloadStatus | string | Success | 备份文件的准备状态。取值:
|
BackupDatabaseDetail | Array of BackupDatabaseDetailObject | 备份信息。 说明 在调用 DescribeBackups 接口查看云数据库 SQL Server 版实例的备份集列表时支持返回该参数。 | |
MaintenanceTime | String | 22:00Z-02:59Z | 实例的可维护时间段。格式:HH:mmZ-HH:mmZ(UTC时间)。 |
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
BackupUse | Folat | 1.42 | 实例已用备份空间。单位:GiB。 |
CreateTime | String | 2023-12-26T02:32:36.000Z | 创建实例的实际时间。 |
DBEngineVersion | String | SQLServer_2019_Std | 兼容版本。取值如下:
|
InnerVersion | String | 15.0.4335.1 | 小版本信息。 |
InstanceId | String | mssql-dab1be87**** | 实例 ID。 |
InstanceName | String | 实例样例 | 实例名称。 |
InstanceStatus | String | Running | 实例状态,取值:
|
InstanceType | String | HA | 实例类型。取值如下:
说明
|
Memory | Integer | 16 | 内存大小,单位为 GiB。 |
NodeSpec | String | rds.mssql.ee.ha.x8.4c32g | 主节点规格。 |
ProjectName | String | Test | 所属项目。 |
RegionId | String | cn-beijing | 地域 ID。 |
ServerCollation | String | Chinese_PRC_CS_AS | 实例字符集排序规则,默认取值为
|
SlowQueryEnable | String | false | 表示是否开启慢日志,取值如下:
|
SlowQueryTime | String | 1 | 慢日志的阈值,取值范围为 [1~10],单位:秒(s)。 |
StorageSpace | Integer | 200 | 实例总存储空间。单位:GiB。 |
StorageType | String | ESSDPL1 | 实例存储类型。取值为 ESSDPL1 ,表示极速型 SSD PL1。 |
StorageUse | Float | 1.85 | 实例已用储空间。单位:GiB。 |
SubnetId | String | subnet-rroau2hdn1mov0x57f7**** | 子网 ID。 说明 当返回两个子网,并使用英文分号(;)隔开时,则表示主备节点部署在不同可用区,默认第一个为主节点子网,第二个为备节点子网。 |
TimeZone | String | China Standard Time | 时区。 |
UpdateTime | String | 2024-01-03T07:15:08.000Z | 实例的更新时间。 |
VCPU | Integer | 4 | CPU 大小。例如:1 表示 1 核。 |
VpcId | String | vpc-13g2qkkzntfy83n6nu4z1**** | 私有网络(VPC) ID。 |
ZoneId | String | cn-beijing-a | 可用区 ID。 说明 当返回两个可用区,并使用英文分号(;)隔开时,则表示主备节点部署在不同可用区,默认第一个为主节点子网,第二个为备节点子网。 |
ReadOnlyNumber | Integer | 1 | 只读实例的个数。 |
PrimaryInstanceId | String | mssql-e75beddc**** | 主实例 ID。 |
Tags | Array of TagsObject | { | 实例标签。详细信息,请参见数据结构。 |
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
AutoRenew | Bool | false | 预付费场景下是否自动续费。
|
ChargeStartTime | String | 2023-02-03T06:16:03.000Z | 计费开始时间,格式为 yyyy-MM-ddTHH:mm:sssZ(UTC 时间)。 |
ChargeEndTime | String | 2023-03-02T15:59:59.000Z | 计费到期时间,格式为 yyyy-MM-ddTHH:mm:sssZ(UTC 时间)。 |
ChargeStatus | String | Normal | 付费状态。取值:
|
ChargeType | String | PostPaid | 付费类型。取值:
|
OverdueReclaimTime | String | 2023-03-09T15:59:59.000Z | 欠费关停时预计释放时间,格式为 yyyy-MM-ddTHH:mm:sssZ(UTC 时间)。 |
OverdueTime | String | 2023-03-03T04:00:00.000Z | 欠费关停时间,格式为 yyyy-MM-ddTHH:mm:sssZ(UTC 时间)。 |
Period | Integer | 1 | 预付费场景下的购买时长。默认值:1 。 |
PeriodUnit | String | Month | 预付费场景下的购买周期。
|
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
ChargeType | String | 是 | PostPaid | 付费类型。取值:
|
AutoRenew | Bool | 否 | true | 预付费场景下是否自动续费。当
|
PeriodUnit | String | 否 | Month | 预付费场景下的购买周期。当
|
Period | Integer | 否 | 1 | 预付费场景下的购买时长。当 ChargeType 为 Prepaid 时,必须设置该参数。 |
Number | Integer | 否 | 1 | 实例购买数量。默认值:1 ,取值范围为 [1,10]。 |
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Address | Array of AddressObject | AddressObject | 地址信息。 |
Description | String | 无。 | 描述信息。 |
EndpointId | String | mssql-dab1be87****-primary | 终端 ID。 |
EndpointName | String | 主连接终端 | 终端名称。 |
EndpointType | String | Primary | 终端类型。取值如下
|
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
DBName | String | 是 | test | 原数据库名称。 |
NewDBName | String | 否 | test_bak | 新数据库新名称。 说明 在不配置此参数时,默认与原数据库名称保持一致。 |
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
ChargeDetail | ChargeDetailObject | ChargeDetail | 付费方式。 |
CreateTime | String | 2023-04-04T07:04:21.000Z | 实例创建的本地时间,格式为 yyyy-MM-ddTHH:mm:ss.sZ(UTC 时间)。 |
DBEngineVersion | String | SQLServer_2019_Std | 兼容版本。取值如下:
|
InstanceId | String | mssql-dab1be87**** | 实例 ID。 |
InstanceName | String | 实例样例 | 实例名称。 |
InstanceStatus | String | Running | 实例状态,取值可为:
|
InstanceType | String | HA | 实例类型。取值如下:
说明
|
NodeDetailInfo | Array of NodeDetailInfoObject | DescribeDBInstanceDetail | 实例节点信息。 |
NodeSpec | String | rds.mssql.ee.ha.x8.4c32g | 主节点规格。 |
Port | String | 1433 | 实例的内网端口。 |
ProjectName | String | Test | 所属项目。 |
RegionId | String | cn-beijing | 地域 ID,可调用 DescribeRegions 查询,使用此参数指定要创建实例的地域。 |
ServerCollation | String | Chinese_PRC_CS_AS | 实例字符集排序规则,默认取值为
|
StorageSpace | Integer | 200 | 实例总存储空间。单位:GiB。 |
StorageType | String | ESSDPL1 | 实例存储类型。取值为 ESSDPL1 。 |
SubnetId | String | subnet-2bzup883l93402dx0efe1**** | 子网 ID。 说明 当返回两个子网,并使用英文分号(;)隔开时,则表示主备节点部署在不同可用区,默认第一个为主节点子网,第二个为备节点子网。 |
TimeZone | String | China Standard Time | 时区。 |
VpcId | String | vpc-2d5xeur6hiscg58ozfcuq**** | 私有网络(VPC) ID。 |
ZoneId | String | cn-beijing-a | 可用区 ID。 说明 当返回两个可用区,并使用英文分号(;)隔开时,则表示主备节点部署在不同可用区,默认第一个为主节点子网,第二个为备节点子网。 |
InstanceCategory | String | Primary | 实例类型,取值如下:
|
ReadOnlyNumber | Integer | 1 | 只读实例的个数。 |
PrimaryInstanceId | String | mssql-e75beddc**** | 主实例 ID。 |
Tags | Array of TagsObject | { | 实例标签。详细信息,请参见数据结构。 |
MaintenanceTime | String | 22:00Z-02:59Z | 实例的可维护时间段。格式:HH:mmZ-HH:mmZ(UTC时间)。 |
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
CheckingCode | String | [10-3000] | 参数取值范围。 |
ForceModify | Bool | false | 表示参数运行值是否可修改。
|
ForceRestart | Bool | false | 表示修改参数的运行值后,实例是否需重启才生效。
|
ParameterDefaultValue | String | 1 | 实例采用的参数模板中为该参数提供的默认值。 |
ParameterDescription | String | Database Mail XPs 选项。使用 DatabaseMail XPs 选项可以在此服务器上启用数据库邮件 | 参数描述。 |
ParameterName | String | automatic soft-NUMA disabled | 参数名。 |
ParameterType | String | Integer | 参数类型,取值为:
|
ParameterValue | String | 1 | 表示参数的取值。 |
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
CreateTime | String | 2024-01-02T11:17:33.000Z | 节点的创建时间。 |
InstanceId | String | mssql-93420fe2**** | 实例 ID。 |
Memory | Integer | 8 | 内存大小,单位为 GiB。 |
NodeId | String | mssql-dab1be87****-0 | 节点 ID。 |
NodeSpec | String | rds.mssql.se.ha.d4.4c16g | 节点规格。 |
NodeStatus | String | Running | 节点状态,取值为:
|
NodeType | String | Primary | 节点类型。取值:
|
RegionId | String | cn-beijing | 地域 ID。 |
UpdateTime | String | 2024-01-03T09:34:55.000Z | 节点的更新时间。 |
VCPU | Integer | 4 | CPU 大小。例如:1 表示 1 核。 |
ZoneId | String | cn-beijing-a | 可用区 ID。 |
NodeIP | String | 192.168.***.*** | 节点 IP。 |
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RegionId | String | cn-beijing | 地域 ID。 |
RegionName | String | cn-beijing | 地域名称。 |
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RestoreFileName | String | copyonly_log.bak | 恢复文件名称。 |
RestoreFileSize | String | 202394112 | 恢复文件大小,单位:Byte。 |
RestoreStartTime | String | 2023-05-11T02:55:38.000Z | 恢复开始时间,格式:yyyy-MM-ddTHH:mm:sssZ(UTC 时间)。 |
RestoreEndTime | String | 2023-05-11T02:55:44.000Z | 恢复结束时间,格式:yyyy-MM-ddTHH:mm:sssZ(UTC 时间)。 |
BackupType | String | Full | 恢复类型。取值如下:
|
DBName | String | testdb | 数据库名称。 |
RestoreDesc | String | 恢复成功 | 恢复详情。 |
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RestoreTaskId | String | 90 | 恢复任务 ID。 |
InstanceId | String | mssql-bbe31c86**** | 实例 ID。 |
InstanceName | String | testname | 实例名称。 |
TaskStartTime | String | 2023-08-22T09:51:00.000Z | 任务开始时间:格式:yyyy-MM-ddTHH:mm:sssZ(UTC 时间)。 |
TaskEndTime | String | 2023-08-22T09:50:45.000Z | 任务结束时间:格式:yyyy-MM-ddTHH:mm:sssZ(UTC 时间)。 |
TaskStatus | String | Failed | 任务状态,取值如下:
说明 恢复失败的任务中可能也存在部分数据库恢复完成的场景,您可以调用 DescribeTosRestoreTaskDetail 接口查看更多详细信息。 |
TaskType | String | OpenDB | 任务类型,取值如下:
|
IsReplace | Boolean | false | 表示恢复时不覆盖目标实例上已经存在的数据库,取值为 false 。 |
RestoreType | String | Full | 恢复类型。取值如下:
|
TaskDesc | String | 恢复文件校验失败 | 任务备份描述。 |
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Key | String | 是 | abc | 实例标签的标签键。 说明
|
Value | String | 否 | 3 | 实例标签的标签值。 说明
|
参数 | 类型 | 是否必选 | 描述 | 示例值 |
---|---|---|---|---|
Key | String | 是 | 标签的键信息。配置规格如下:
| key1 |
Value | String | 否 | 标签的值信息。配置规格如下:
| value1 |
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
ZoneId | String | cn-beijing-a | 可用区 ID。 |
ZoneName | String | cn-beijing-a | 可用区名称。 |
Description | String | 华北2(北京)-可用区A | 地域可用区名称。 |