数据结构

NetworkType

String

Private

网络地址类型，取值为：

• Private：私网连接地址。
• Public：公网连接地址。
• Inner：公共服务区地址。

DNSVisibility

Boolean

false

是否开启公网解析。取值为：

• false：默认值，火山引擎私网解析。
• true：火山引擎私网以及公网解析。

AccountType

String

Normal

账号类型，取值范围：

• Super：高权限账号。
• Normal：普通账号。
• InstanceReadOnly：实例只读账号。

AccountStatus

String

Available

账号状态：

• Unavailable：不可用
• Available：可用

InstanceStatus

String

Running

实例状态，取值：

• Running：运行中。
• Creating：创建中。
• Deleting：删除中。
• Restarting：重启中。
• Restoring：恢复中。
• Updating：变更中。
• Upgrading：升级中。
• Error：错误。
• Released：已释放。
• CreateError：创建错误。
• MasterChanging：主节点切换中。
• Deleted：已删除。
• Recycled：已回收。

DBEngineVersion

String

PostgreSQL_12

兼容版本。取值：

• PostgreSQL_11：PostgreSQL 11。
• PostgreSQL_12：PostgreSQL 12。
• PostgreSQL_13：PostgreSQL 13。

InstanceTag

Array of TagObject

[{
"Key": "test",
"Value": "123"
}]

标签数组对象。关于 InstanceTag 的详细信息，请参见 TagObject。

BackupStatus

String

Success

备份状态，取值：

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

BackupProgress

Integer

70

备份进展百分比。
-当 BackupStatus 为 Success 时，BackupProgress 为 100。
-当 BackupStatus 为 Running 时，BackupProgress 最小为 0，最大为 100。

BackupType

String

Full

备份类型，取值：

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

CreateType

String

System

创建类型，取值：

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

ChargeType

String

PostPaid

付费类型。取值：

• PostPaid：按量付费。
• PrePaid：包年包月（默认）。

AutoRenew

Boolean

true

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

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

PeriodUnit

String

Month

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

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

ChargeStatus

String

Normal

付费状态。取值：

• Normal：正常。
• Overdue：欠费。
• Unpaid：等待支付。

TempModifyStartTime

String

2023-12-01T10:10:10.000Z

临时升配的开始时间。

TempModifyEndTime

String

2023-12-07T10:10:09.000Z

临时升配的还原时间。

ChargeType

String

是

PostPaid

付费类型。取值：

• PostPaid：按量付费。
• PrePaid：包年包月（默认）。

AutoRenew

Boolean

否

true

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

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

PeriodUnit

String

否

Month

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

• Month：包月（默认）。
• Year：包年。

Number

Integer

否

1

实例购买数量。默认值：1。

ChargeItemType

String

Primary

付费项名称，取值：

• Primary：主节点。
• Secondary：备节点。
• ReadOnly：只读节点。
• Storage： 物理存储空间。

ChargeItemKey

String

rds.pg.d1.1c2g

• 如果 ChargeItemKey 取值为 Primary、Secondary 或 ReadOnly，该参数返回实例的规格，如 rds.pg.d1.1c2g。
• 如果 ChargeItemKey 取值为 Storage，该参数返回存储的 Key，如 rds.pg.d1.localssd。

ChargeItemValue

Integer

100

• 如果 ChargeItemKey 取值为 Primary、Secondary 或 ReadOnly，该参数返回节点个数，取值均为 1。
• 如果 ChargeItemKey 取值为 Storage，该参数返回存储的容量大小，单位为 GB。

Collate

String

en_US.utf8

排序规则。默认值：C。取值范围：
C、C.UTF-8、en_US.utf8 和 zh_CN.utf8。

CType

String

en_US.utf8

字符分类。默认值：C。取值范围：
C、C.UTF-8、en_US.utf8 和 zh_CN.utf8。

DBStatus

String

Available

数据库状态：

• Unavailable：不可用。
• Available：可用。

EndpointType

String

Cluster

终端类型：

• Cluster：默认终端（默认创建）。
• Custom：自定义终端。

ReadWriteMode

String

ReadOnly

读写模式：

• ReadWrite：读写。
• ReadOnly：只读。

Address

ArrayList of AddressObject

[
{
"Domain":"mysql77c004acdd3c.rds.ivolces.com",
"EipId":"",
"IPAddress":"",
"NetworkType":"Private",
"Port":"3306",
"SubnetId":""
}
]

地址列表。关于 Address 的更多详情，请参见数据结构。

ReadOnlyNodeWeight

Array of ReadOnlyNodeWeightObject

[
{
"NodeType" : "Primary",
"Weight" : 100
},
{
"NodeId" : "postgres-ca7b7019****-2",
"Weight" : 100
},
{
"NodeId" : "postgres-ca7b7019****-3",
"Weight" : 200
}
]

连接终端配置的节点列表及对应的只读权重。关于 ReadOnlyNodeWeight 的更多详情，请参见数据结构。

AutoAddNewNodes

String

Enable

当终端类型为读写终端或只读终端时，支持设置新节点是否自动加入。取值：

• Enable：自动加入。
• Disable：不自动加入（默认）。

EnableReadWriteSplitting

String

Enable

是否已开启读写分离，取值：

• Enable：开启。
• Disable：未开启。

EnableReadOnly

String

Enable

是否已开启全局只读。

• Enable：开启。
• Disable：未开启。

ReadOnlyNodeDistributionType

String

Default

只读权重分配模式。取值：

• Default：标准权重分配（默认值）。
• Custom：自定义权重分配。

ReadOnlyNodeMaxDelayTime

Integer

30

只读节点的最大延迟阈值，当只读节点延迟时间超过该值时，读取流量不发往该节点，单位：秒。取值：0~3600。默认值：30。

FailoverType

String

System

主备切换类型。

• System：系统自动主备切换。
• User：用户手动主备切换。

DBEngineVersion

String

PostgreSQL_12

兼容版本。取值：

• PostgreSQL_11：PostgreSQL 11。
• PostgreSQL_12：PostgreSQL 12。
• PostgreSQL_13：PostgreSQL 13。

InstanceStatus

String

Released

实例状态，取值：

• Running：运行中。
• Creating：创建中。
• Deleting：删除中。
• Restarting：重启中。
• Restoring：恢复中。
• Updating：变更中。
• Upgrading：升级中。
• Error：错误。
• Released：已释放。
• CreateError：创建错误。
• MasterChanging：主节点切换中。
• Deleted：已删除。
• Recycled：已回收。

InstanceStatus

String

Running

实例状态，取值：

• Running：运行中。
• Creating：创建中。
• Deleting：删除中。
• Restarting：重启中。
• Restoring：恢复中。
• Updating：变更中。
• Upgrading：升级中。
• Error：错误。
• Released：已释放。
• CreateError：创建错误。
• MasterChanging：主节点切换中。
• Deleted：已删除。
• Recycled：已回收。

DBEngineVersion

String

PostgreSQL_12

兼容版本。取值：

• PostgreSQL_11：PostgreSQL 11。
• PostgreSQL_12：PostgreSQL 12。
• PostgreSQL_13：PostgreSQL 13。

Tags

Array of TagObject

[{
"Key": "test",
"Value": "123"
}]

标签数组对象。关于 TagObject 的更多详情，请参见数据结构。

ZoneId

String

cn-beijing-a

支持的可用区 ID。

DBEngineVersion

String

PostgreSQL_12

兼容版本。取值：

• PostgreSQL_11：PostgreSQL 11。
• PostgreSQL_12：PostgreSQL 12。
• PostgreSQL_13：PostgreSQL 13。

SpecStatus

String

Normal

规格所在可用区的售卖状态，包含以下状态：

• Normal：在售。
• Soldout：售罄。

NodeId

String

否

postgres-ca7b7019****

节点 ID。可调用 DescribeDBInstanceDetail 接口查询。

ZoneId

String

是

cn-beijing-a

节点所在可用区，可调用 DescribeAvailabilityZones 查询。

NodeType

String

是

Primary

节点类型，取值为：

• Primary：主节点。
• Secondary：备节点。
• ReadOnly：只读节点。

NodeOperateType

String

否

Modify

操作类型。取值范围：

• Create：增加。
• Delete：删除。
• Modify：修改。

NodeType

String

Primary

节点类型。取值：

• Primary：主节点。
• Secondary：备节点。
• ReadOnly：只读节点。

NodeId

String

是

postgres-c23003b1****-ojmo

只读节点需要传入 NodeId。

NodeType

String

是

Primary

节点类型。取值：

• Primary：主节点。
• ReadOnly：只读节点。

Weight

Integer

是

100

节点的读权重，以 100 递增，最大值为 10000。

Status

String

Applied

状态。取值：

• Applied：已生效。
• Invalid：未生效。
• Syncing：正在应用，尚未生效。

Owner

String

testuser

Schema 的 owner。

Key

String

是

abc

标签键。

Value

String

否

3

标签值。

Key

String

是

abc

标签键。命名规则如下：

• 不能以任何大小写形式的 volc: 开头。 volc: 为系统预留标签键，禁止使用。
• 只能包含语言字符、数字、空格和英文符号 _、.、:、/、=、+、-、@。
• 长度限制在 1~128 个字符之间。

Value

String

否

3

标签值。
命名规则如下：

• 只能包含语言字符、数字、空格和英文符号 _、.、:、/、=、+、-、@。
• 允许为空，长度限制在 0~256 个字符之间。