You need to enable JavaScript to run this app.
导航

数据结构

最近更新时间2024.02.08 14:09:34

首次发布时间2023.11.15 22:39:51

AddressObject

被 DescribeDBInstances 和 DescribeDBInstanceDetail 接口引用。

名称类型示例值描述

NetworkType

String

Private

网络地址类型,取值为:

  • Private:私网连接地址。
  • Public:公网连接地址。
  • Inner:公共服务区地址。
DomainStringpostgresca7b7019****.rds-pg.ivolces.com连接域名。
IPAddressString192.***.***.253IP 地址。
PortString5432端口。
SubnetIdStringsubnet-30uhx4w39n75s7r2qr0lq****子网 ID。
EipIdStringeip-3jhjud2zgy1og3pncmeh7****EIP 的 ID,仅对 Public 地址有效。

DNSVisibility

Boolean

false

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

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

AccountObject

被 DescribeDBAccounts 接口引用。

名称类型示例值描述
AccountNameStringtest1账号名称。

AccountType

String

Normal

账号类型,取值范围:

  • Super:高权限账号。
  • Normal:普通账号。

AccountStatus

String

Available

账号状态:

  • Unavailable:不可用
  • Available:可用
AccountPrivilegesStringInherit,Login,CreateRole,CreateDB账号的数据库权限信息。

BasicInfoObject

被 DescribeDBInstanceDetail 接口引用。

名称类型示例值描述
InstanceIdStringpostgres-21a3333b****实例 ID。
InstanceNameStringTest123实例名称。

InstanceStatus

String

Running

实例状态,取值:

  • Running:运行中。
  • Creating:创建中。
  • Deleting:删除中。
  • Restarting:重启中。
  • Restoring:恢复中。
  • Updating:变更中。
  • Upgrading:升级中。
  • Error:错误。
  • Released:已释放。
  • CreateError:创建错误。
  • MasterChanging:主节点切换中。
  • Deleted:已删除。
  • Recycled:已回收。
RegionIdStringcn-beijing地域 ID。
ZoneIdStringcn-beijing-a可用区 ID。

DBEngineVersion

String

PostgreSQL_12

兼容版本。取值:

  • PostgreSQL_11:PostgreSQL 11。
  • PostgreSQL_12:PostgreSQL 12。
  • PostgreSQL_13:PostgreSQL 13。
InstanceTypeStringHA实例类型。取值:HA(高可用版)。
VCPUInteger2CPU 大小。例如:1 表示 1U。
MemoryInteger50内存大小,单位:GB。
NodeSpecStringrds.postgres.1c2g主节点规格。
NodeNumberInteger2节点数量。
CreateTimeString2022-01-01T10:10:10.000Z实例创建的时间。格式为 yyyy-MM-ddTHH:mm:ss.sssZ(UTC 时间)。
UpdateTimeString2022-01-01T10:10:10.000Z实例更新的时间。格式为 yyyy-MM-ddTHH:mm:ss.sssZ(UTC 时间)。
StorageTypeStringLocalSSD实例存储类型。取值为 LocalSSD,即本地 SSD 盘。
StorageSpaceInteger200实例总存储空间。单位:GB。
StorageUseLong142635726实例已用储空间。单位:Byte。
StorageDataUseLong25666194实例主节点已用数据文件空间。单位:Byte。
StorageTempUseLong4096实例主节点已用临时文件空间。单位:Byte。
StorageWALUseLong1241523717实例主节点已用 WAL 文件空间。单位:Byte。
StorageLogUseLong1095433115实例主节点已用日志文件空间。单位:Byte。
VpcIDStringvpc-2gdgzrrl5icjk50ztyz6b****专有网络(VPC) ID。
SubnetIdStringsubnet-30uhx4w39n75s7r2qr0lq****子网 ID。
ProjectNameStringTest实例所属项目。

InstanceTag

Array of TagObject

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

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

DataSyncModeStringAsync同步方式。取值为 Async,即异步同步。

BackupObject

被 DescribeBackups 和 DescribeDetachedBackups 接口引用。

名称类型示例值描述
BackupIdString20231016-024****_20231017-125****备份 ID。
BackupFileNameString20230508-021****_20230511-141****备份文件名称。

BackupStatus

String

Success

备份状态,取值:

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

BackupProgress

Integer

70

备份进展百分比。
-当 BackupStatusSuccess 时,BackupProgress 为 100。
-当 BackupStatusRunning 时,BackupProgress 最小为 0,最大为 100。

BackupType

String

Full

备份类型,取值:

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

CreateType

String

System

创建类型,取值:

  • System:系统。
  • User:用户。
BackupFileSizeLong41750219备份文件大小,单位为 Byte。
BackupStartTimeString2022-01-01T10:10:10.000Z备份的开始时间,格式 yyyy-MM-dd HH:mm:ss.sssZ(UTC 时间)。
BackupEndTimeString2022-01-01T10:10:10.000Z备份的结束时间,格式 yyyy-MM-dd HH:mm:ss.sssZ(UTC 时间)。
InstanceInfoInstanceInfoObject-实例信息。关于 InstanceInfo 的详细信息,请参见 InstanceInfoObject

ChargeDetailObject

该结构体被以下接口引用:

  • DescribeDBInstances
  • DescribeDBInstanceDetail
  • DescribeBackups
  • DescribeDetachedBackups
名称类型示例值描述

ChargeType

String

PostPaid

付费类型。取值:

  • PostPaid:按量付费。
  • PrePaid:包年包月(默认)。

AutoRenew

Boolean

true

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

  • true:自动续费。
  • false:不自动续费(默认)。
NumberInteger1实例数量。

PeriodUnit

String

Month

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

  • Month:包月(默认)。
  • Year:包年。
PeriodInteger1预付费场景下的购买时长。默认值:1。

ChargeStatus

String

Normal

付费状态。取值:

  • Normal:正常。
  • Overdue:欠费。
  • Unpaid:等待支付。
ChargeStartTimeString2023-01-10T11:13:30.000Z实例的计费开始时间。
ChargeEndTimeString2023-01-10T11:13:34.000Z包年包月实例的计费到期时间。
OverdueTimeString2023-01-10T11:13:30.000Z实例的欠费关停时间。
OverdueReclaimTimeString2023-01-15T16:00:00.000Z实例欠费关停后的预计释放时间。

TempModifyStartTime

String

2023-12-01T10:10:10.000Z

临时升配的开始时间。

说明

  • 当实例处于临时升配期时返回。
  • 如果对实例进行了多次连续的临时升配,此处返回的为首次临时升配的开始时间。

TempModifyEndTime

String

2023-12-07T10:10:09.000Z

临时升配的还原时间。

说明

当实例处于临时升配期时返回。

:::

ChargeInfoObject

该结构体被以下接口引用:

  • CreateDBInstance
  • RestoreToNewInstance
  • DescribeDBinstancePriceDetail
名称类型是否必选示例值描述

ChargeType

String

PostPaid

付费类型。取值:

  • PostPaid:按量付费。
  • PrePaid:包年包月(默认)。

AutoRenew

Boolean

true

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

  • true:自动续费。
  • false:不自动续费(默认)。

PeriodUnit

String

Month

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

  • Month:包月(默认)。
  • Year:包年。
PeriodInteger1预付费场景下的购买时长。默认值:1。

Number

Integer

1

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

说明

当 ChargeInfoObject 被 RestoreToNewInstance 接口引用时,Number 只允许设置为 1。

ChargeItemPriceObject

该结构体被以下接口引用:

  • DescribeDBinstancePriceDetail
  • DescribeDBInstancePriceDifference
名称类型示例值描述

ChargeItemType

String

Primary

付费项名称,取值:

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

ChargeItemKey

String

rds.pg.d1.1c2g

  • 如果 ChargeItemKey 取值为 PrimarySecondaryReadOnly,该参数返回实例的规格,如 rds.pg.d1.1c2g
  • 如果 ChargeItemKey 取值为 Storage,该参数返回存储的 Key,如 rds.pg.d1.localssd

ChargeItemValue

Integer

100

  • 如果 ChargeItemKey 取值为 PrimarySecondaryReadOnly,该参数返回节点个数,取值均为 1。
  • 如果 ChargeItemKey 取值为 Storage,该参数返回存储的容量大小,单位为 GB。
NodeNumPerInstanceInteger3每个实例的节点数量。
OriginalPriceDouble300原价。
DiscountPriceDouble200折扣价。
PayablePriceDouble100应付价格。

DatabaseObject

被 DescribeDatabases 接口引用。

名称类型示例值描述
DBNameStringdb1数据库名称。
CharacterSetNameStringutf8数据库字符集。

Collate

String

en_US.utf8

排序规则。默认值:C。取值范围:
CC.UTF-8en_US.utf8zh_CN.utf8

CType

String

en_US.utf8

字符分类。默认值:C。取值范围:
CC.UTF-8en_US.utf8zh_CN.utf8

OwnerStringtestuser数据库绑定的账号。

DBStatus

String

Available

数据库状态:

  • Unavailable:不可用。
  • Available:可用。

EndpointObject

被 DescribeDBInstanceDetail 接口引用。

名称类型示例值描述
EndpointIdStringpostgres-ca7b7019****实例连接终端 ID。
EndpointNameString主连接终端实例连接终端名称。

EndpointType

String

Cluster

终端类型:

  • Cluster:默认终端(默认创建)。
  • Custom:自定义终端。

ReadWriteMode

String

ReadOnly

读写模式:

  • ReadWrite:读写。
  • ReadOnly:只读。
DescriptionString主地址地址描述。

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。

说明

支持对开通了读写分离的默认终端设置此参数。

FailoverLogObject

被 DescribeFailoverLogs 接口引用。

名称类型示例值描述
NewMasterNodeIdStringpostgres-21a3333b****-0新主节点 ID。
OldMasterNodeIdStringpostgres-21a3333b****-1旧主节点 ID。

FailoverType

String

System

主备切换类型。

  • System:系统自动主备切换。
  • User:用户手动主备切换。
FailoverTimeString2020-06-18T01:40:44Z主备切换时间。

InstanceInfoObject

被 DescribeBackups 和 DescribeDetachedBackups 接口引用。

名称类型示例值描述
ChargeDetailChargeDetailObject-实例计费信息。关于 ChargeDetail 的更多详情,请参见数据结构

DBEngineVersion

String

PostgreSQL_12

兼容版本。取值:

  • PostgreSQL_11:PostgreSQL 11。
  • PostgreSQL_12:PostgreSQL 12。
  • PostgreSQL_13:PostgreSQL 13。
InstanceIdStringpostgres-21a3333b****实例 ID。
InstanceNameStringtest-instance-name实例名称。

InstanceStatus

String

Released

实例状态,取值:

  • Running:运行中。
  • Creating:创建中。
  • Deleting:删除中。
  • Restarting:重启中。
  • Restoring:恢复中。
  • Updating:变更中。
  • Upgrading:升级中。
  • Error:错误。
  • Released:已释放。
  • CreateError:创建错误。
  • MasterChanging:主节点切换中。
  • Deleted:已删除。
  • Recycled:已回收。
InstanceTypeStringHA实例类型。取值为 HA,高可用类型。
MemoryInteger2内存大小。单位:GB。
NodesArray of NodeObject-实例节点信息。关于 NodeInfo 的详细信息,请参见 数据结构
ProjectNameStringtestProject项目名称。
StorageSpaceInteger200实例总存储空间。单位:GB。
StorageTypeStringLocalSSD实例存储类型。取值固定为 LocalSSD,即本地 SSD 盘。
SubnetIdStringsubnet-30vhlwb1el0qo7r2qr2c5****子网 ID。
VCPUInteger1CPU 大小。例如:1 表示 1U。
VpcIdStringvpc-3rebt5uf5fr405zsk2if9****私有网络(VPC) ID。
ZoneIdStringcn-beijing-a可用区 ID。

InstanceObject

被 DescribeDBInstances 接口引用。

名称类型示例值描述
InstanceIdStringpostgres-21a3333b****实例 ID。
InstanceNameStringtest实例名称。

InstanceStatus

String

Running

实例状态,取值:

  • Running:运行中。
  • Creating:创建中。
  • Deleting:删除中。
  • Restarting:重启中。
  • Restoring:恢复中。
  • Updating:变更中。
  • Upgrading:升级中。
  • Error:错误。
  • Released:已释放。
  • CreateError:创建错误。
  • MasterChanging:主节点切换中。
  • Deleted:已删除。
  • Recycled:已回收。
RegionIdStringcn-beijing地域 ID。可调用 DescribeRegions 接口查询,使用此参数指定要创建实例的地域。
ZoneIdStringcn-beijing-a实例初始主节点所在的可用区的 ID。
ZoneIdsArray of String["cn-beijing-a","cn-beijing-b"]实例各节点所在的可用区的 ID。

DBEngineVersion

String

PostgreSQL_12

兼容版本。取值:

  • PostgreSQL_11:PostgreSQL 11。
  • PostgreSQL_12:PostgreSQL 12。
  • PostgreSQL_13:PostgreSQL 13。
InstanceTypeStringHA实例类型。取值:HA(高可用版)。
NodeSpecStringrds.postgres.1c2g主节点规格。
NodeNumberInteger2节点数量。
CreateTimeString2022-01-01T10:10:10.000Z创建实例的本地时间。
StorageSpaceInteger200实例总存储空间。单位:GB。
StorageTypeStringLocalSSD实例存储类型。取固定值 LocalSSD,即本地 SSD 盘。
VpcIdStringvpc-2gdgzrrl5icjk50ztyz6b****专有网络(VPC) ID。
SubnetIdStringsubnet-30uhx4w39n75s7r2qr0lq****子网 ID。
ProjectNameStringTest实例所属项目。

Tags

Array of TagObject

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

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

AddressObjectArray of AddressObject-默认终端的连接信息。关于 AddressObject 的更多详情,请参见数据结构
ChargeDetailChargeDetailObject-实例计费信息。关于 ChargeDetail 的更多详情,请参见数据结构

InstanceSpecObject

被 DescribeDBInstanceSpecs 接口引用。

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

ZoneId

String

cn-beijing-a

支持的可用区 ID。

说明

仅在 DescribeDBInstanceSpecs 请求参数中指定 ZoneId 字段时,才会在作为返回数据的 InstanceSpecObject 中返回 ZoneId 字段。

DBEngineVersion

String

PostgreSQL_12

兼容版本。取值:

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

说明

仅在 DescribeDBInstanceSpecs 请求参数中指定 DBEngineVersion 字段时,才会在作为返回数据的 InstanceSpecObject 中返回 DBEngineVersion 字段。

SpecCodeStringrds.postgres.1c2g实例规格编码。
VCPUInteger1CPU 大小。例如:1 表示 1U。
MemoryInteger5内存大小,单位为 GB。
ConnectionInteger200对应规格实例支持的最大连接数。

SpecStatus

String

Normal

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

  • Normal:在售。
  • Soldout:售罄。

NodeInfoObject

该结构体被以下接口引用:

  • CreateDBInstance
  • RestoreToNewinstance
  • DescribeDBInstancePriceDetail
  • DescribeDBInstancePriceDifference
  • ModifyDBInstancesSpec
名称类型是否必选示例值描述

NodeId

String

postgres-ca7b7019****

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

说明

在变更节点规格和删除节点(ModifyDBInstancesSpec)时必传。

ZoneId

String

cn-beijing-a

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

说明

  • 在创建实例(CreateDBInstance)、恢复到新实例(RestoreToNewInstance)、新增节点和修改节点(ModifyDBInstancesSpec)时必传。
  • 主节点、备节点和只读节点可部署在同一地域下的不同可用区。

NodeType

String

Primary

节点类型,取值为:

  • Primary:主节点。
  • Secondary:备节点。
  • ReadOnly:只读节点。
NodeSpecStringrds.postgres.1c2g节点规格。可通过 DescribeDBInstanceSpecs 接口查询可售卖的规格。

NodeOperateType

String

Modify

操作类型。取值范围:

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

说明

修改实例配置时为必传。

NodeObject

该结构体被以下结构引用:

  • DescribeDBInstanceDetail
  • DescribeDetachedBackups
名称类型示例值描述
InstanceIdStringpostgres-ca7b7019****实例 ID。
NodeIdStringpostgres-ca7b7019****-zgqy节点 ID。
RegionIdStringcn-beijing地域 ID,可调用 DescribeRegions 查询,使用此参数指定要创建实例的地域。
ZoneIdStringcn-beijing-a可用区 ID。

NodeType

String

Primary

节点类型。取值:

  • Primary:主节点。
  • Secondary:备节点。
  • ReadOnly:只读节点。
NodeStatusStringRunning节点状态。
NodeSpecStringrds.postgres.1c2g节点规格。
VCPUInteger4CPU大小。例如:1 表示 1U。
MemoryInteger16内存大小,单位为 GB。
CreateTimeString2022-01-01T10:10:10Z节点创建的时间。格式为 yyyy-MM-ddTHH:mm:ss.sssZ(UTC 时间)。
UpdateTimeString2022-01-01T10:10:10Z节点更新的时间。格式为 yyyy-MM-ddTHH:mm:ss.sssZ(UTC 时间)。

ReadOnlyNodeWeightObject

该结构体被以下结构引用:

  • ModifyDBEndpointReadWriteFlag
  • ModifyDBEndpointReadWeight
  • DescribeDBInstanceDetail
名称类型是否必填示例值描述

NodeId

String

postgres-c23003b1****-ojmo

只读节点需要传入 NodeId。

说明

主节点可不传入 NodeId。

NodeType

String

Primary

节点类型。取值:

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

Weight

Integer

100

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

说明

权重不可全部设置为 0。

ParameterChangeLogObject

被 DescribeDBInstanceParametersLog 接口引用。

名称类型示例值描述
NameStringinnodb_stats_sample_pages参数名称。

Status

String

Applied

状态。取值:

  • Applied:已生效。
  • Invalid:未生效。
  • Syncing:正在应用,尚未生效。
NewValueString3修改后参数值。
OldValueString8修改前参数值。
ModifyTimeString2020-03-01T00:00:00.000Z修改参数的时间戳。格式:yyyy-MM-ddTHH:mm:ss.sssZ(UTC 时间)。

ParameterObject

被 DescribeDBInstanceParameters 和 ModifyDBInstanceParameters 接口引用。

说明

ParameterObject 在 DescribeDBInstanceParameters 作为请求参数使用时,只需设置 Name 和 Value 字段,且这两个字段为必选字段。

名称类型是否必选示例值描述
NameStringauto_increment_increment参数名。
ValueString1参数值。特指当前实例运行值。
DefaultValueStringDefault参数默认值。指在该实例对应的默认模板中提供的默认值。
TypeStringString参数值类型。取值:StringIntegerFloatBooleanListEnum
ForceRestartBooleanfalse是否重启才生效,取值:truefalse
CheckingCodeString[10-3000]参数取值范围。
DescriptionStringdetermines the starting point for the AUTO_INCREMENT column value.参数描述。

RecoverableTimeInfoObject

被 DescribeRecoverableTime 接口引用。

名称类型示例值描述
EarliestRecoverableTimeString2022-01-01T10:10:10.000Z实例最早可恢复的时间(UTC 时间),为空表示实例目前不可恢复。
LatestRecoverableTimeString2022-01-01T10:10:10.000Z实例最晚可恢复的时间(UTC 时间),为空表示实例目前不可恢复。

RegionObject

被 DescribeRegions 接口引用。

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

SchemaObject

被 DescribeSchemas 和 ModifySchemaOwner 接口引用。

名称类型示例值描述
DBNameStringtestdb数据库名。
SchemaNameStringtestschema数据库下的 schema 名称。
OwnerStringtestuserschema 的 owner。

TagFilterObject

被 DescribeDBInstances 接口引用。

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

Key

String

abc

标签键。

说明

  • 允许重复
  • 单次查询数量不超过 10 个。
  • 不可传入空字符串。

Value

String

3

标签值。

说明

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

TagObject

该结构体被以下结构引用:

  • CreateDBInstance
  • DescribeDBInstanceDetail
  • DescribeDBInstances
名称类型是否必选示例值描述

Key

String

abc

标签键。命名规则如下:

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

说明

  • 单次创建的标签数量不能超过 20 个。
  • 单个实例下的标签键不能重复。

Value

String

3

标签值。
命名规则如下:

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

ZoneObject

被 DescribeAvailabilityZones 接口引用。

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