DescribeDBInstances_云原生数据仓库 AnalyticDB PostgreSQL版

接口说明

本接口用于查看目标地域下的 AnalyticDB PostgreSQL 版实例的实例类型、网络类型、实例状态等信息。

本接口的单用户 QPS 限制默认为 1000 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。

本文档中的 QPS 仅为默认参考值，准确信息请参见 API 速率配额列表。

请求速率为1000/1(s)。更多流控信息，请前往配额中心查看

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

gpdb:DescribeDBInstances	Get	DBInstance acs:gpdb:{#regionId}:{#accountId}:dbinstance/*	无	无

字段名称	字段详情
RegionIdstring	地域 ID。展开详情示例值:cn-hangzhou参考取值来源: DescribeRegions
DBInstanceDescriptionstring	实例描述。示例值:gp-bp12ga6v69h86****
InstanceNetworkTypestring	实例网络类型，取值说明：展开详情示例值:VPC参考取值来源: DescribeDBInstanceNetInfo
DBInstanceIdsstring	实例 ID，多个实例 ID 之间用英文半角逗号（,）分隔。示例值:gp-bp12ga6v69h86****参考取值来源: UpgradeDBInstance PauseInstance CreateDBInstance ResumeInstance UpdateDBInstancePlan DescribeDBInstanceSSL ModifyDBInstancePayType DownloadDiagnosisRecords UnloadSampleData
PageSizeinteger<int32>	每页记录数，取值说明：展开详情示例值:50
PageNumberinteger<int32>	页码，大于 0 且不超过 Integer 的最大值，默认值：1。示例值:1
Tagarray<object>	标签列表。子级条数 <= 21
InstanceDeployTypesarray<string>	该参数已废弃，无需传入该参数。
DBInstanceStatusesarray<string>	实例运行状态。
DBInstanceCategoriesarray<string>	实例系列，多个值用英文逗号（,）分隔。
DBInstanceModesarray<string>	资源类型，多个值用英文逗号（,）分隔。
ResourceGroupIdstring	实例所在的企业资源组 ID。示例值:rg-bp67acfmxazb4p****参考取值来源: DescribeDBResourceGroup
VpcIdstring	专有网络 ID。展开详情示例值:vpc-t4nqyp3tc5mx7vy6****

字段名称	字段详情
Itemsobject
PageNumberinteger<int32>	当前页码。示例值:1
PageRecordCountinteger<int32>	当前页记录数。示例值:1
RequestIdstring	请求 ID。示例值:53EA07B7-FC2A-521B-AB7C-27**********
TotalRecordCountinteger<int32>	总记录数。示例值:1

	变更时间	变更内容概要	操作
	2024-01-04	变更返回参数
	2023-12-11	新增请求参数VpcId
	2022-10-28	变更返回参数
	2022-08-11	新增请求参数ResourceGroupId 变更返回参数