调用 DescribeDBInstances 接口查询实例列表。

请求类型

异步请求。

注意事项

本接口的请求参数均无默认值。在不传入某个参数时，表示不对该参数进行过滤，按照其他参数限定的查询条件下进行查询。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	否	postgres-21a3333b****	实例 ID。
InstanceName	String	否	测试实例	实例名称。
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。 PostgreSQL_14：PostgreSQL 14。 PostgreSQL_15：PostgreSQL 15。 PostgreSQL_16：PostgreSQL 16。 PostgreSQL_17：PostgreSQL 17。 PostgreSQL_18：PostgreSQL 18。
CreateTimeStart	String	否	2022-01-01T10:10:10.000Z	查询创建实例创建时间范围。
CreateTimeEnd	String	否	2022-01-01T10:10:10.000Z	查询创建实例创建时间范围。
ZoneId	String	否	cn-beijing-a	实例所属可用区。
ChargeType	String	否	PostPaid	付费类型。取值： PostPaid：按量付费。 PrePaid：包年包月
ProjectName	String	否	testProject	项目名称。
TagFilters	Array of TagFilterObject	否	请参见请求示例。	标签查询数组对象。单次最多支持同时传入 10 组标签键值对进行查询筛选。
PageNumber	Integer	否	1	当前页查询偏移量，默认值为 1。
PageSize	Integer	否	10	每页记录数，取值应大于 0 且不超过 1000，默认值为 10。
StorageType	String	否	LocalSSD	实例存储类型。取固定值 LocalSSD（本地 SSD 盘）。
PrivateNetworkVpcId	String	否	vpc-miswzgsgy77k5smt1ar9****	私有网络的 ID。可通过该字段筛选使用指定私有网络的实例。

TagFilterObject

参数	类型	是否必选	示例值	描述
Key	String	是	abc	标签键。说明允许重复单次查询数量不超过 10 个。不可传入空字符串。
Value	String	否	3	标签值。说明如果传入该参数，则必须先传入 Key。不传则表示查询同一标签键下的所有标签值。传入空字符串时，表示查询标签值为空的标签。

返回参数

参数	类型	示例值	描述
Total	Integer	1	实例总数。
Instances	Array of InstanceObject	请参见返回示例。	实例列表。

InstanceObject

参数	类型	示例值	描述
AddressObject	Array of AddressObject	请参见返回示例。	默认终端的连接信息。
ChargeDetail	Object of ChargeDetailObject	请参见返回示例。	实例计费信息。
CreateTime	String	2022-01-01T10:10:10.000Z	创建实例的本地时间。
DBEngineVersion	String	PostgreSQL_12	兼容版本。取值： PostgreSQL_11：PostgreSQL 11。 PostgreSQL_12：PostgreSQL 12。 PostgreSQL_13：PostgreSQL 13。 PostgreSQL_14：PostgreSQL 14。 PostgreSQL_15：PostgreSQL 15。 PostgreSQL_16：PostgreSQL 16。 PostgreSQL_17：PostgreSQL 17。 PostgreSQL_18：PostgreSQL 18。
Endpoints	Array of EndpointObject	请参见返回示例。	实例的连接终端信息。
InstanceId	String	postgres-21a3333b****	实例 ID。
InstanceName	String	test	实例名称。
InstanceStatus	String	Running	实例状态，取值： Running：运行中。 Creating：创建中。 Deleting：删除中。 Restarting：重启中。 Restoring：恢复中。 Updating：变更中。 Upgrading：升级中。 Error：错误。 Released：已释放。 CreateError：创建错误。 MasterChanging：主节点切换中。 Deleted：已删除。 Recycled：已回收。
InstanceType	String	HA	实例类型。取值：HA（高可用版）。
MaintenanceWindow	Object of MaintenanceWindowObject	请参见返回示例。	实例的可维护时间段信息。
NodeNumber	Integer	2	节点数量。
NodeSpec	String	rds.postgres.1c2g	主节点规格。
ProjectName	String	Test	实例所属项目。
RegionId	String	cn-beijing	地域 ID。可调用 DescribeRegions 接口查询，使用此参数指定要创建实例的地域。
StorageSpace	Integer	200	实例总存储空间。单位：GB。
StorageType	String	LocalSSD	实例存储类型。取固定值 LocalSSD（本地 SSD 盘）。
SubnetId	String	subnet-30uhx4w39n75s7r2qr0lq****	子网 ID。
Tags	Array of TagObject	[{ "Key": "test", "Value": "123" }]	标签数组对象。
VpcId	String	vpc-2gdgzrrl5icjk50ztyz6b****	专有网络（VPC） ID。
ZoneId	String	cn-beijing-a	实例初始主节点所在的可用区的 ID。
ZoneIds	Array of String	["cn-beijing-a","cn-beijing-b"]	实例各节点所在的可用区的 ID。
ScheduledResumeTime	String		停机不收费系统最迟发起恢复的时间，RFC3339 UTC；不代表恢复完成时间

AddressObject

参数	类型	示例值	描述
CrossRegionDomain	String	postgresca7b7019****.rds-pg.cn-beijing.ivolces.com	可跨地域访问的私网地址。说明无此地址时则不返回该字段。
DNSVisibility	Boolean	false	是否开启公网解析。取值为： false：默认值，火山引擎私网解析。 true：火山引擎私网以及公网解析。
Domain	String	postgresca7b7019****.rds-pg.ivolces.com	连接域名。
DomainVisibilitySetting	String	CrossRegionDomain	私网地址类型。取值： LocalDomain：本地域域名。 CrossRegionDomain：可跨地域访问域名。
EipId	String	eip-3jhjud2zgy1og3pncmeh7****	EIP 的 ID，仅对 Public 地址有效。
IPAddress	String	192.. .253	IP 地址。
NetworkType	String	Private	网络地址类型，取值为： Private：私网连接地址。 Public：公网连接地址。 Inner：公共服务区地址。
Port	String	5432	端口。
SubnetId	String	subnet-30uhx4w39n75s7r2qr0lq****	子网 ID。

ChargeDetailObject

参数	类型	示例值	描述
ChargeType	String	PostPaid	付费类型。取值： PostPaid：按量付费。 PrePaid：包年包月（默认）。
AutoRenew	Boolean	true	预付费场景下是否自动续费。 true：自动续费。 false：不自动续费（默认）。
Number	Integer	1	实例数量。
PeriodUnit	String	Month	预付费场景下的购买周期。 Month：包月（默认）。 Year：包年。
Period	Integer	1	预付费场景下的购买时长。默认值：1。
ChargeStatus	String	Normal	付费状态。取值： Normal：正常。 Overdue：欠费。 Unpaid：等待支付。
ChargeStartTime	String	2023-01-10T11:13:30.000Z	实例的计费开始时间。
ChargeEndTime	String	2023-01-10T11:13:34.000Z	包年包月实例的计费到期时间。
OverdueTime	String	2023-01-10T11:13:30.000Z	实例的欠费关停时间。
OverdueReclaimTime	String	2023-01-15T16:00:00.000Z	实例欠费关停后的预计释放时间。
TempModifyStartTime	String	2023-12-01T10:10:10.000Z	临时升配的开始时间。说明当实例处于临时升配期时返回。如果对实例进行了多次连续的临时升配，此处返回的为首次临时升配的开始时间。
TempModifyEndTime	String	2023-12-07T10:10:09.000Z	临时升配的还原时间。说明当实例处于临时升配期时返回。

EndpointObject

参数	类型	示例值	描述
Address	Array of AddressObject	请参见返回示例。	地址列表。
AutoAddNewNodes	String	Enable	当终端类型为读写终端或只读终端时，支持设置新节点是否自动加入。取值： Enable：自动加入。 Disable：不自动加入（默认）。
Description	String	主地址	地址描述。
EnableReadOnly	String	Enable	是否已开启全局只读。 Enable：开启。 Disable：未开启。
EnableReadWriteSplitting	String	Enable	是否已开启读写分离，取值： Enable：开启。 Disable：未开启。
EndpointId	String	postgres-ca7b7019****	实例连接终端 ID。
EndpointName	String	主连接终端	实例连接终端名称。
EndpointType	String	Cluster	终端类型： Cluster：默认终端（默认创建）。 Custom：自定义终端。
ReadOnlyNodeDistributionType	String	Default	只读权重分配模式。取值： Default：标准权重分配（默认值）。 Custom：自定义权重分配。
ReadOnlyNodeMaxDelayTime	Integer	30	只读节点的最大延迟阈值，当只读节点延迟时间超过该值时，读取流量不发往该节点，单位：秒。取值：0~3600。默认值：30。说明支持对开通了读写分离的默认终端设置此参数。
ReadOnlyNodeWeight	Array of NodeWeightObject	[ { "NodeType" : "Primary", "Weight" : 100 }, { "NodeId" : "postgres-ca7b7019**-2", "Weight" : 100 }, { "NodeId" : "postgres-ca7b7019**-3", "Weight" : 200 } ]	连接终端配置的节点列表及对应的只读权重。
ReadWriteMode	String	ReadOnly	读写模式： ReadWrite：读写。 ReadOnly：只读。
ReadWriteProxyConnection	Integer	200	终端开启读写分离后，为终端设置的代理连接数。代理连接数的取值下限为 20。代理连接数的取值上限取决于实例主节点的规格，不同规格支持的代理连接数上限不同，详细信息请参见产品规格。
WriteNodeHaltWriting	Boolean	false	终端是否将写请求发送给写节点（目前仅主节点为写节点）。取值： true：是。默认值。 false：否。

NodeWeightObject

参数	类型	示例值	描述
NodeId	String	postgres-c23003b1****-ojmo	只读节点需要传入 NodeId。说明主节点可不传入 NodeId。
NodeType	String	Primary	节点类型。取值： Primary：主节点。 ReadOnly：只读节点。
Weight	Integer	100	节点的读权重，以 100 递增，最大值为 40000。说明权重不可全部设置为 0。

MaintenanceWindowObject

参数	类型	示例值	描述
DayKind	String	Week	可维护周期的粒度，取值为 Week，周。
DayOfWeekMaintenanceTime	Array of DayOfWeekObject	请参见示例。	实例可维护时间段的详细信息。

DayOfWeekObject

参数	类型	示例值	描述
DayOfWeek	String	Monday,Tuesday	指定实例在每周的可维护日。可多选。 Monday：周一。 Tuesday：周二。 Wednesday：周三。 Thursday：周四。 Friday：周五。 Saturday：周六。 Sunday：周日。说明如果不指定该值或者为空，则默认一周七天都生效。
MaintenanceWindowStartTime	String	22:00Z	实例在可维护日的可维护时间段的起始时间。格式：HH:mmZ（UTC 时间）。说明当前仅支持将可维护时间段的起始时间设置在 16:00Z 至 20:00Z 之间。
Period	Integer	6	实例在可维护日的可维护时间段的时长。说明时长最小为 2 小时，最大时 6 小时。

TagObject

参数	类型	示例值	描述
Key	String	abc	标签键。命名规则如下：不能以任何大小写形式的 volc: 开头。 volc: 为系统预留标签键，禁止使用。只能包含语言字符、数字、空格和英文符号 _、.、:、/、=、+、-、@。长度限制在 1~128 个字符之间。说明单次创建的标签数量不能超过 20 个。单个实例下的标签键不能重复。
Value	String	3	标签值。命名规则如下：只能包含语言字符、数字、空格和英文符号 _、.、:、/、=、+、-、@。允许为空，长度限制在 0~256 个字符之间。

示例

请求示例

返回示例

云数据库 PostgreSQL 版