调用DescribeDBInstanceAttribute接口查询RDS实例的详细信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

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

系统规定参数，取值：DescribeDBInstanceAttribute。

DBInstanceId String 是 rm-uf6wjk5xxxxxxxxxx

实例ID。可以一次输入最多30个，以英文逗号（,）分隔。
Expired String 否 False

实例过期状态，取值：

  • True：已过期
  • False：未过期

返回数据

名称 类型 示例值 描述
Items Array of DBInstanceAttribute

实例属性列表。
DBInstanceAttribute
DBInstanceId String rm-uf6wjk5xxxxxxxxxx

实例ID。
PayType String Postpaid

实例付费方式，取值：

  • Postpaid：按量付费
  • Prepaid：包年包月
DBInstanceType String Primary

实例类型，取值：

  • Primary：主实例
  • Readonly：只读实例
  • Guard：灾备实例
  • Temp：临时实例
Category String Basic

实例系列，取值：

  • Basic：基础版
  • HighAvailability：高可用版
  • AlwaysOn：集群版
  • Finance：三节点企业版
InstanceNetworkType String Classic

实例的网络类型，取值：

  • Classic：经典网络
  • VPC：专有网络
RegionId String cn-hangzhou

地域ID。
ZoneId String cn-hangzhou-a

可用区ID。
ConnectionString String rm-uf6wjk5xxxxxxxxxx.mysql.rds.aliyuncs.com

内网连接地址。
Port String 3306

内网连接端口。
Engine String MySQL

数据库类型。
EngineVersion String 5.5

数据库版本。
DBInstanceClassType String s

实例规格族，取值：

  • s：共享型
  • x：通用型
  • d：独享套餐
  • h：独占物理机
DBInstanceClass String rds.mys2.small

实例规格，详情请参见实例规格表。

DBInstanceMemory Long 4096

实例内存，单位：M。
DBInstanceStorage Integer 10

实例存储空间，单位：GB。
DBInstanceNetType String Internet

实例是内网或外网，取值：

  • Internet：外网
  • Intranet：内网
DBInstanceStatus String Running

实例状态，详情请参见实例状态表。

DBInstanceDescription String 测试数据库

实例备注。
LockMode String Unlock

实例锁定模式：

  • Unlock：正常
  • ManualLock：手动触发锁定
  • LockByExpiration：实例过期自动锁定
  • LockByRestoration：实例回滚前的自动锁定
  • LockByDiskQuota：实例空间满自动锁定
  • LockReadInstanceByDiskQuota：只读实例空间满自动锁定
LockReason String instance_expired

锁定原因。
DBMaxQuantity Integer 200

一个实例下可创建最大数据库数量。
AccountMaxQuantity Integer 50

可创建账号的最大数量。
CreationTime String 2011-05-30T12:11:04Z

创建时间。yyyy-MM-ddTHH:mm:ssZ（UTC时间）。

ExpireTime String 2019-03-27T16:00:00Z

到期时间。yyyy-MM-ddTHH:mm:ssZ（UTC时间）。

说明 按量付费实例无到期时间。
MaintainTime String 00:00Z-02:00Z

实例可维护时间段，是UTC时间，+8小时才是控制台上显示的可维护时间段。
AvailabilityValue String 100.0%

实例可用性状态，单位：百分比。
MaxIOPS Integer 150

最大每秒IO请求次数。
MaxConnections Integer 60

最大并发连接数。
MasterInstanceId String rm-uf6wjk5xxxxxxxxxx

主实例的ID，如果没有返回此参数则表示该实例是主实例。
IncrementSourceDBInstanceId String rm-uf6wjk5xxxxxxxxxx

增量数据来源的实例ID，如灾备实例的增量数据来源是主实例。只读实例的增量数据来源是主实例，如果没有返回此参数则表示该实例是主实例。
GuardDBInstanceId String rm-uf64zsuxxxxxxxxxx

该实例如果挂载着灾备实例，即为灾备实例的ID。
TempDBInstanceId String rm-uf64zsuxxxxxxxxxx

该实例如果挂载着临时实例，即为临时实例ID。
ReadOnlyDBInstanceIds Array of ReadOnlyDBInstanceId

主实例下挂载的只读实例ID列表。
ReadOnlyDBInstanceId
DBInstanceId String rm-bpxxxxxxxxx

只读实例ID。
AdvancedFeatures String LinkedServer

目前只针对SQL Server，获取高级特性值，多个值之间用英文逗号（,）隔开，现返回值如下：

  • LinkedServer：链接服务器
  • DistributeTransaction：分布式事务
AutoUpgradeMinorVersion String Auto

实例升级小版本的方式，取值：

  • Auto：自动升级小版本
  • Manual：不自动升级，仅在当前版本下线时才强制升级
Collation String Chinese_PRC_CI_AS

系统字符集排序规则。
ConnectionMode String Standard

实例的访问模式，取值：

  • Standard：标准访问模式
  • Safe：数据库代理模式
ConsoleVersion String 2

实例的代理类型。取值：

  • 1：共享代理
  • 2：独享代理
说明 不建议使用该参数，请使用返回参数ProxyType。
CurrentKernelVersion String rds_20181010

当前内核版本。
DBInstanceCPU String 2

实例CPU数量。
DBInstanceStorageType String local_ssd

实例储存类型，取值：

  • local_ssd/ephemeral_ssd：本地SSD盘
  • cloud_ssd：SSD云盘
  • cloud_essd：ESSD云盘
DedicatedHostGroupId String dhg-7a9xxxxxxxx

主机组ID。
Extra Struct

扩展信息。
DBInstanceIds List rm-uf6wjk5xxxxxxxxxx

实例ID。
MasterZone String 5454284

主可用区ID。
ProxyType Integer 1

实例支持的代理类型，取值：

  • 0：表示不支持开通代理
  • 1：表示支持开通共享代理（多租户模式）
  • 2：表示支持开通独享代理（单租户模式）
ReadonlyInstanceSQLDelayedTime String 30

只读实例延迟复制时间，只读实例延迟ReadonlyInstanceSQLDelayedTime的时间后再同步主实例数据，单位：秒。

ResourceGroupId String rg-acfmyxxxxxxxxxx

资源组ID。
SecurityIPMode String normal

白名单模式。取值：

  • normal：通用模式
  • safety：高安全模式
SlaveZones Array of SlaveZone

组成SlaveZones的参数。
SlaveZone
ZoneId String cn-hangzhou-a

可用区。
SuperPermissionMode String Disabled

当前实例是否可以开放SA账号、AD域、主机账号等高权限功能。取值：

  • Enable：开放
  • Disabled：不开放
TimeZone String Central Standard Time

时区。
VSwitchId String vsw-xxxxxx

交换机ID。
VpcCloudInstanceId String vpc-23rsxdfxxxxxxx

专有网络实例ID。
VpcId String vpc-xxxxxxxxx

VPC ID。
RequestId String 1AD222E9-E606-4A42-BF6D-8A4442913CEF

请求ID。

示例

请求示例

http(s)://rds.aliyuncs.com/?Action=DescribeDBInstanceAttribute
&DBInstanceId=rm-uf6wjk5xxxxxxxxxx
&<公共请求参数>

正常返回示例

XML 格式 

<DescribeDBInstanceAttributeResponse>
  <RequestId>BD3A30D8-32E7-40CF-AAEA-6BFD4E3DC55E</RequestId>
  <Items>
        <DBInstanceAttribute>
              <DBInstanceMemory>8192</DBInstanceMemory>
              <ResourceGroupId>rg-acfmyxxxxxxxxxx</ResourceGroupId>
              <Port>3306</Port>
              <MasterZone>cn-hangzhou-h</MasterZone>
              <LatestKernelVersion>rds_20201031</LatestKernelVersion>
              <DBInstanceType>Primary</DBInstanceType>
              <ConsoleVersion>2</ConsoleVersion>
              <InstanceNetworkType>VPC</InstanceNetworkType>
              <DBInstanceClassType>x</DBInstanceClassType>
              <DBInstanceId>rm-uf6wjk5xxxxxxxxxx</DBInstanceId>
              <AutoUpgradeMinorVersion>Auto</AutoUpgradeMinorVersion>
              <DBInstanceStorage>150</DBInstanceStorage>
              <AvailabilityValue>100.0%</AvailabilityValue>
              <Engine>MySQL</Engine>
              <DBInstanceDescription>test1</DBInstanceDescription>
              <IPType>IPv4</IPType>
              <EngineVersion>8.0</EngineVersion>
              <DBInstanceStatus>Running</DBInstanceStatus>
              <MaxConnections>2000</MaxConnections>
              <DBInstanceClass>rds.mysql.s3.large</DBInstanceClass>
              <AccountMaxQuantity>99999</AccountMaxQuantity>
              <VSwitchId>vsw-xxxxxx</VSwitchId>
              <PayType>Prepaid</PayType>
              <LockMode>Unlock</LockMode>
              <GuardDBInstanceId>rm-uf64zsuxxxxxxxxxx</GuardDBInstanceId>
              <SupportCreateSuperAccount>No</SupportCreateSuperAccount>
              <InsId>1</InsId>
              <VpcId>vpc-xxxxxxxxx</VpcId>
              <CurrentKernelVersion>rds_20200831</CurrentKernelVersion>
              <TempUpgradeTimeStart>2021-01-10 00:00:00</TempUpgradeTimeStart>
              <TempUpgradeTimeEnd>2021-06-18 00:00:00</TempUpgradeTimeEnd>
              <CreationTime>2020-06-17T09:03:57Z</CreationTime>
              <ConnectionMode>Standard</ConnectionMode>
              <VpcCloudInstanceId>vpc-23rsxdfxxxxxxx</VpcCloudInstanceId>
              <ProxyType>2</ProxyType>
              <ConnectionString>rm-uf6wjk5xxxxxxxxxx.mysql.rds.aliyuncs.com</ConnectionString>
              <ExpireTime>2021-06-17T16:00:00Z</ExpireTime>
              <DBMaxQuantity>99999</DBMaxQuantity>
              <Category>HighAvailability</Category>
              <DBInstanceNetType>Intranet</DBInstanceNetType>
              <SuperPermissionMode></SuperPermissionMode>
              <DedicatedHostGroupId></DedicatedHostGroupId>
              <DBInstanceCPU>4</DBInstanceCPU>
              <GuardDBInstanceName>rm-m5xxxxx</GuardDBInstanceName>
              <SecurityIPList>42.xx.xx.xx</SecurityIPList>
              <OriginConfiguration></OriginConfiguration>
              <ReadOnlyDBInstanceIds>
        </ReadOnlyDBInstanceIds>
              <SecurityIPMode>normal</SecurityIPMode>
              <MaintainTime>23:00Z-00:00Z</MaintainTime>
              <DispenseMode>MultiAVZDispenseMode</DispenseMode>
              <ZoneId>cn-hangzhou-h</ZoneId>
              <DBInstanceStorageType>local_ssd</DBInstanceStorageType>
              <AccountType>Mix</AccountType>
              <MaxIOPS>5000</MaxIOPS>
              <SupportUpgradeAccountType>No</SupportUpgradeAccountType>
              <SlaveZones>
                    <SlaveZone>
                          <ZoneId>cn-hangzhou-h</ZoneId>
                    </SlaveZone>
              </SlaveZones>
              <Extra>
                    <DBInstanceIds>
            </DBInstanceIds>
              </Extra>
              <CanTempUpgrade>true</CanTempUpgrade>
              <RegionId>cn-hangzhou</RegionId>
        </DBInstanceAttribute>
  </Items>
</DescribeDBInstanceAttributeResponse>

JSON 格式 

{
	"RequestId": "BD3A30D8-32E7-40CF-AAEA-6BFD4E3DC55E",
	"Items": {
		"DBInstanceAttribute": [
			{
				"DBInstanceMemory": 8192,
				"ResourceGroupId": "rg-acfmyxxxxxxxxxx",
				"Port": "3306",
				"MasterZone": "cn-hangzhou-h",
				"LatestKernelVersion": "rds_20201031",
				"DBInstanceType": "Primary",
				"ConsoleVersion": "2",
				"InstanceNetworkType": "VPC",
				"DBInstanceClassType": "x",
				"DBInstanceId": "rm-uf6wjk5xxxxxxxxxx",
				"AutoUpgradeMinorVersion": "Auto",
				"DBInstanceStorage": 150,
				"AvailabilityValue": "100.0%",
				"Engine": "MySQL",
				"DBInstanceDescription": "test1",
				"IPType": "IPv4",
				"EngineVersion": "8.0",
				"DBInstanceStatus": "Running",
				"MaxConnections": 2000,
				"DBInstanceClass": "rds.mysql.s3.large",
				"AccountMaxQuantity": 99999,
				"VSwitchId": "vsw-xxxxxx",
				"PayType": "Prepaid",
				"LockMode": "Unlock",
				"GuardDBInstanceId": "rm-uf64zsuxxxxxxxxxx",
				"SupportCreateSuperAccount": "No",
				"InsId": 1,
				"VpcId": "vpc-xxxxxxxxx",
				"CurrentKernelVersion": "rds_20200831",
				"TempUpgradeTimeStart": "2021-01-10 00:00:00",
				"TempUpgradeTimeEnd": "2021-06-18 00:00:00",
				"CreationTime": "2020-06-17T09:03:57Z",
				"ConnectionMode": "Standard",
				"VpcCloudInstanceId": "vpc-23rsxdfxxxxxxx",
				"ProxyType": 2,
				"ConnectionString": "rm-uf6wjk5xxxxxxxxxx.mysql.rds.aliyuncs.com",
				"ExpireTime": "2021-06-17T16:00:00Z",
				"DBMaxQuantity": 99999,
				"Category": "HighAvailability",
				"DBInstanceNetType": "Intranet",
				"SuperPermissionMode": "",
				"DedicatedHostGroupId": "",
				"DBInstanceCPU": "4",
				"GuardDBInstanceName": "rm-m5xxxxx",
				"SecurityIPList": "42.xx.xx.xx",
				"OriginConfiguration": "",
				"ReadOnlyDBInstanceIds": {
					"ReadOnlyDBInstanceId": []
				},
				"SecurityIPMode": "normal",
				"MaintainTime": "23:00Z-00:00Z",
				"DispenseMode": "MultiAVZDispenseMode",
				"ZoneId": "cn-hangzhou-h",
				"DBInstanceStorageType": "local_ssd",
				"AccountType": "Mix",
				"MaxIOPS": 5000,
				"SupportUpgradeAccountType": "No",
				"SlaveZones": {
					"SlaveZone": [
						{
							"ZoneId": "cn-hangzhou-h"
						}
					]
				},
				"Extra": {
					"DBInstanceIds": {
						"DBInstanceId": []
					}
				},
				"CanTempUpgrade": true,
				"RegionId": "cn-hangzhou"
			}
		]
	}
}

错误码

访问错误中心查看更多错误码。