数据结构

DNSVisibility

Bool

false

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

• true：表示开启私网到公网解析。
• false：表示不开启私网到公网解析。

NetworkType

String

Private

网络地址类型。取值：

• Private：私网类型。
• Public：公网类型。

BackupType

String

Full

备份类型。取值如下：

• Full：表示全量备份。

• Diff：表示差异备份。

BackupDownloadLinkInner

String

https://*****

内网备份下载链接。

BackupDownloadLinkEIP

String

https://*****

外网备份下载链接。

LinkExpiredTime

String

2023-05-11T02:55:44.000Z

下载链接过期时间，格式：yyyy-MM-ddTHH:mm:sssZ（UTC 时间）。

DownloadStatus

string

Success

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

• Success：准备完成。

• Failed：准备失败。

• Running：准备中。

• NotDownload：没有下载。

BackupMethod

String

Physical

备份方式，取值：

• Logical：逻辑备份。
• Physical：物理备份。
• Snapshot：快照备份。

BackupStatus

String

Success

备份状态，取值：

• Success：成功。
• Failed：失败。
• Running：执行中。

BackupType

String

Full

备份类型。取值：

• Full：全量备份。
• Diff：增量备份。

CreateType

String

System

创建类型，取值：

• System：系统。
• User：用户。

DBEngineVersion

String

SQLServer_2019_Std

兼容版本。取值如下：

• SQLServer_2019_Std：表示 SQL Server 2019 标准版。
• SQLServer_2019_Web：表示 SQL Server 2019 Web 版。
• SQLServer_2019_Ent：表示 SQL Server 2019 企业版。

InstanceStatus

String

Running

实例状态，取值：

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

InstanceType

String

HA

实例类型。取值如下：

• HA：表示高可用类型。

• Basic：表示基础版类型。

• Cluster：表示集群版类型。

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

SlowQueryEnable

String

false

表示是否开启慢日志，取值如下：

• true：表示开启慢日志。
• false：表示不开启慢日志。

SubnetId

String

subnet-rroau2hdn1mov0x57f7****

子网 ID。

ZoneId

String

cn-beijing-a

可用区 ID。

Tags

Array of TagsObject

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

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

AutoRenew

Bool

false

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

• true：自动续费（默认）。
• false：不自动续费。

ChargeStatus

String

Normal

付费状态。取值：

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

ChargeType

String

PostPaid

付费类型。取值：

• PostPaid：表示按量付费。
• PrePaid：表示包年包月。

PeriodUnit

String

Month

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

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

ChargeType

String

是

PostPaid

付费类型。取值：

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

AutoRenew

Bool

否

true

预付费场景下是否自动续费。当 ChargeType 为 Prepaid 时，可设置该参数。

• true：表示开启自动续费（默认值）。
• false：表示不开启自动续费。

PeriodUnit

String

否

Month

预付费场景下的购买周期。当 ChargeType 为 Prepaid 时，可设置该参数。

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

EndpointType

String

Primary

终端类型。取值如下

• Primary：表示主节点终端。

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

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

DBEngineVersion

String

SQLServer_2019_Std

兼容版本。取值如下：

• SQLServer_2019_Std：表示 SQL Server 2019 标准版。
• SQLServer_2019_Web：表示 SQL Server 2019 Web 版。
• SQLServer_2019_Ent：表示 SQL Server 2019 企业版。

InstanceStatus

String

Running

实例状态，取值可为：

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

InstanceType

String

HA

实例类型。取值如下：

• HA：表示高可用类型。

• Basic：表示基础版类型。

• Cluster：表示集群版类型。

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

SubnetId

String

subnet-2bzup883l93402dx0efe1****

子网 ID。

ZoneId

String

cn-beijing-a

可用区 ID。

InstanceCategory

String

Primary

实例类型，取值如下：

• Primary：表示主实例。
• ReadOnly：表示只读实例。

Tags

Array of TagsObject

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

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

ForceModify

Bool

false

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

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

ForceRestart

Bool

false

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

• true：表示修改参数的运行值后需要重启实例才生效。
• false：表示修改参数的运行值后不需重启实例。

ParameterType

String

Integer

参数类型，取值为：

• String
• Integer
• Boolean
• List
• Float

NodeStatus

String

Running

节点状态，取值为：

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

NodeType

String

Primary

节点类型。取值：

• Primary：表示主节点终端。
• ReadOnly：表示只读节点终端。
• Secondary：表示备节点终端。

RestoreStartTime

String

2023-05-11T02:55:38.000Z

恢复开始时间，格式：yyyy-MM-ddTHH:mm:sssZ（UTC 时间）。

BackupType

String

Full

恢复类型。取值如下：

• Full：表示全量恢复。

• Diff：表示增量恢复。

• LOG：表示日志恢复。

TaskStatus

String

Failed

任务状态，取值如下：

• NoStart：表示任务未开始。

• Running：表示任务运行中。

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

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

TaskType

String

OpenDB

任务类型，取值如下：

• OpenDB：表示打开数据库。

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

RestoreType

String

Full

恢复类型。取值如下：

• Full：表示全量恢复。

• Diff：表示增量恢复。

• LOG：表示日志恢复。

Key

String

是

abc

实例标签的标签键。

Value

String

否

3

实例标签的标签值。

Key

String

是

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

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

key1

Value

String

否

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

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

value1