调用DescribeDBInstanceAttribute接口查询RDS实例的详细信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeDBInstanceAttribute |
系统规定参数,取值:DescribeDBInstanceAttribute。 |
DBInstanceId | String | 是 | rm-uf6wjk5***** |
实例ID。可以一次输入最多30个,以半角逗号(,)分隔。 |
Expired | String | 否 | False |
实例过期状态,取值如下:
|
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 1AD222E9-E606-4A42-BF6D-8A4442913CEF |
请求ID。 |
Items | Array of DBInstanceAttribute |
实例属性列表。 |
|
DBInstanceAttribute | |||
VpcId | String | vpc-***** |
VPC ID。 |
CreationTime | String | 2011-05-30T12:11:04Z |
创建时间。格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)。 |
IncrementSourceDBInstanceId | String | rm-uf6wjk5***** |
增量数据来源的实例ID,例如灾备实例的增量数据来源是主实例。只读实例的增量数据来源是主实例,如果没有返回此参数则表示该实例是主实例。 |
MaintainTime | String | 00:00Z-02:00Z |
实例可维护时间段,表示为UTC时间,+8小时后是控制台上显示到的可维护时间段。 |
PayType | String | Postpaid |
实例付费方式,返回值如下:
|
AvailabilityValue | String | 100.0% |
实例可用性状态,单位:百分比(%)。 |
EngineVersion | String | 5.5 |
数据库版本。 |
DedicatedHostGroupId | String | dhg-7a9***** |
专属集群ID。 |
ConnectionString | String | rm-uf6wjk5*****.mysql.rds.aliyuncs.com |
内网连接地址。 |
SuperPermissionMode | String | Disabled |
当前实例是否可以开放SA账号、AD域、主机账号等高权限功能,返回值如下:
|
InstanceNetworkType | String | Classic |
实例的网络类型,返回值如下:
|
MasterInstanceId | String | rm-uf6wjk5***** |
主实例的ID。 说明 如果没有返回此参数则表示该实例是主实例。
|
AutoUpgradeMinorVersion | String | Auto |
实例升级小版本的方式,返回值如下:
|
ExpireTime | String | 2019-03-27T16:00:00Z |
到期时间。格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)。 说明 按量付费实例无到期时间。
|
AccountMaxQuantity | Integer | 50 |
可创建账号的最大数量。 |
MasterZone | String | 5454284 |
主可用区ID。 |
GuardDBInstanceId | String | rm-uf64zsu***** |
该实例如果挂载着灾备实例,即为灾备实例的ID。 |
DBInstanceStorage | Integer | 10 |
实例存储空间,单位:GB。 |
TimeZone | String | Central Standard Time |
时区。 |
LatestKernelVersion | String | rds_20201031 |
当前实例支持的最新内核版本。 |
TipsLevel | Integer | 1 |
专属集群MySQL通用版实例的异常提示等级,返回值如下:
|
ZoneId | String | cn-hangzhou-a |
可用区ID。 |
MaxConnections | Integer | 60 |
最大并发连接数。 |
DBInstanceId | String | rm-uf6wjk5***** |
实例ID。 |
TempDBInstanceId | String | rm-uf64zsu***** |
该实例如果挂载着临时实例,即为临时实例ID。 |
AdvancedFeatures | String | LinkedServer |
目前只针对SQL Server,获取高级特性值,多个值之间用半角逗号(,)隔开,返回值如下:
|
DBInstanceStorageType | String | local_ssd |
实例储存类型,返回值如下:
|
DBInstanceMemory | Long | 4096 |
实例内存,单位:M。 |
IPType | String | IPv4 |
IP地址类型。当前仅支持IPv4。 |
ConsoleVersion | String | 2 |
实例的代理类型,返回值如下:
说明 不建议使用该参数,请使用返回参数ProxyType。
|
ConnectionMode | String | Standard |
实例的访问模式,返回值如下:
|
Port | String | 3306 |
内网连接端口。 |
LockMode | String | Unlock |
实例锁定模式,返回值如下:
|
GeneralGroupName | String | TestGroup |
专属集群MySQL通用版实例所属的组名。 |
VpcCloudInstanceId | String | vpc-23rsxdf***** |
专有网络实例ID。 |
Collation | String | Chinese_PRC_CI_AS |
系统字符集排序规则。 |
MaxIOPS | Integer | 150 |
最大每秒IO请求次数。 |
MaxIOMBPS | Integer | 0MB/s |
最大IO吞吐。单位:MB/s。 |
Tips | String | 一切正常 |
专属集群MySQL通用版实例的异常提示信息。 |
SecurityIPList | String | 192.168.XX.XX/24 |
IP白名单分组下的IP列表。 |
SecurityIPMode | String | normal |
白名单模式,返回值如下:
|
DBInstanceClassType | String | s |
实例规格族,返回值如下:
|
ProxyType | Integer | 1 |
实例支持的代理类型,返回值如下:
|
CurrentKernelVersion | String | rds_20181010 |
当前内核版本。 |
DBInstanceDescription | String | 测试数据库 |
实例备注。 |
DBInstanceCPU | String | 2 |
实例CPU数量。 |
DBInstanceNetType | String | Internet |
实例是内网或外网,返回值如下:
|
DBInstanceType | String | Primary |
实例类型,返回值如下:
|
LockReason | String | instance_expired |
锁定原因。 |
DBInstanceStatus | String | Running |
实例状态,详情请参见实例状态表。 |
DBMaxQuantity | Integer | 200 |
一个实例下可创建最大数据库数量。 |
RegionId | String | cn-hangzhou |
地域ID。 |
ReadonlyInstanceSQLDelayedTime | String | 30 |
只读实例延迟复制时间,只读实例延迟ReadonlyInstanceSQLDelayedTime的时间后再同步主实例数据,单位:秒(s)。 |
VSwitchId | String | vsw-***** |
交换机ID。 |
ResourceGroupId | String | rg-acfmy***** |
资源组ID。 |
Category | String | Basic |
实例系列,返回值如下:
|
DBInstanceClass | String | rds.mys2.small |
实例规格,详情请参见实例规格表。 |
Engine | String | MySQL |
数据库类型,返回值如下:
|
SlaveZones | Array of SlaveZone |
组成SlaveZones的参数。 |
|
SlaveZone | |||
ZoneId | String | cn-hangzhou-a |
可用区。 |
ReadOnlyDBInstanceIds | Array of ReadOnlyDBInstanceId |
主实例下挂载的只读实例ID列表。 |
|
ReadOnlyDBInstanceId | |||
DBInstanceId | String | rm-bp***** |
只读实例ID。 |
Extra | Object |
扩展信息。 |
|
DBInstanceIds | Array of String | rm-uf6wjk5***** |
实例ID。 |
DeletionProtection | Boolean | true |
是否已开启释放保护功能,返回值如下:
|
ServerlessConfig | Object |
RDS Serverless实例的相关设置。 |
|
ScaleMin | double | 0.5 |
实例RCU(RDS Capacity Unit)自动扩缩范围的最小值。 |
ScaleMax | double | 8 |
实例RCU(RDS Capacity Unit)自动扩缩范围的最大值。 |
AutoPause | Boolean | true |
是否开启Serverless实例的自动启停功能,返回值如下:
说明 10分钟无任何连接将进入暂停状态,连接时会自动唤醒。
|
SwitchForce | Boolean | false |
是否开启Serverless实例的强制弹性扩缩容,返回值如下:
说明 实例RCU的弹性扩缩容通常会立刻生效,但在某些特殊情况下无法即时完成扩缩容,此时可开启本参数进行强制扩缩容。
|
BabelfishConfig | Object |
Babelfish for RDS PostgreSQL配置信息。 说明 该参数仅适用于Babelfish for RDS PostgreSQL实例,更多介绍,请参见Babelfish简介。
|
|
BabelfishEnabled | String | true |
Babelfish开关。 说明 购买RDS PostgreSQL实例时,如果开启了Babelfish,则此参数固定为true。
|
MigrationMode | String | single-db |
Babelfish迁移模式,返回值如下:
说明 Babelfish迁移模式的更多信息,请参见迁移模式简介。
|
kindCode | String | 无 |
内部参数,无需关注。 |
InstructionSetArch | String | x86 |
实例的架构类型,返回值如下:
|
示例
请求示例
http(s)://rds.aliyuncs.com/?Action=DescribeDBInstanceAttribute
&DBInstanceId=rm-uf6wjk5*****
&<公共请求参数>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeDBInstanceAttributeResponse>
<RequestId>BD3A30D8-32E7-40CF-AAEA-6BFD4E3DC55E</RequestId>
<Items>
<DBInstanceAttribute>
<DBInstanceMemory>8192</DBInstanceMemory>
<ResourceGroupId>rg-acfmy*****</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-uf6wjk5*****</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-*****</VSwitchId>
<PayType>Prepaid</PayType>
<LockMode>Unlock</LockMode>
<DeletionProtection>true</DeletionProtection>
<GuardDBInstanceId>rm-uf64zsu*****</GuardDBInstanceId>
<SupportCreateSuperAccount>No</SupportCreateSuperAccount>
<InsId>1</InsId>
<VpcId>vpc-*****</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-23rsxdf*****</VpcCloudInstanceId>
<ProxyType>2</ProxyType>
<ConnectionString>rm-uf6wjk5*****.mysql.rds.aliyuncs.com</ConnectionString>
<ExpireTime>2021-06-17T16:00:00Z</ExpireTime>
<DBMaxQuantity>99999</DBMaxQuantity>
<Category>HighAvailability</Category>
<DBInstanceNetType>Intranet</DBInstanceNetType>
<SuperPermissionMode/>
<DedicatedHostGroupId/>
<DBInstanceCPU>4</DBInstanceCPU>
<GuardDBInstanceName>rm-m5*****</GuardDBInstanceName>
<SecurityIPList>42.xx.xx.xx</SecurityIPList>
<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>
<ServerlessConfig/>
<CanTempUpgrade>true</CanTempUpgrade>
<RegionId>cn-hangzhou</RegionId>
</DBInstanceAttribute>
</Items>
</DescribeDBInstanceAttributeResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "BD3A30D8-32E7-40CF-AAEA-6BFD4E3DC55E",
"Items" : {
"DBInstanceAttribute" : {
"DBInstanceMemory" : 8192,
"ResourceGroupId" : "rg-acfmy*****",
"Port" : 3306,
"MasterZone" : "cn-hangzhou-h",
"LatestKernelVersion" : "rds_20201031",
"DBInstanceType" : "Primary",
"ConsoleVersion" : 2,
"InstanceNetworkType" : "VPC",
"DBInstanceClassType" : "x",
"DBInstanceId" : "rm-uf6wjk5*****",
"AutoUpgradeMinorVersion" : "Auto",
"DBInstanceStorage" : 150,
"AvailabilityValue" : "100.0%",
"Engine" : "MySQL",
"DBInstanceDescription" : "test1",
"IPType" : "IPv4",
"EngineVersion" : 8,
"DBInstanceStatus" : "Running",
"MaxConnections" : 2000,
"DBInstanceClass" : "rds.mysql.s3.large",
"AccountMaxQuantity" : 99999,
"VSwitchId" : "vsw-*****",
"PayType" : "Prepaid",
"LockMode" : "Unlock",
"DeletionProtection" : true,
"GuardDBInstanceId" : "rm-uf64zsu*****",
"SupportCreateSuperAccount" : "No",
"InsId" : 1,
"VpcId" : "vpc-*****",
"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-23rsxdf*****",
"ProxyType" : 2,
"ConnectionString" : "rm-uf6wjk5*****.mysql.rds.aliyuncs.com",
"ExpireTime" : "2021-06-17T16:00:00Z",
"DBMaxQuantity" : 99999,
"Category" : "HighAvailability",
"DBInstanceNetType" : "Intranet",
"SuperPermissionMode" : "",
"DedicatedHostGroupId" : "",
"DBInstanceCPU" : 4,
"GuardDBInstanceName" : "rm-m5*****",
"SecurityIPList" : "42.xx.xx.xx",
"OriginConfiguration" : "",
"ReadOnlyDBInstanceIds" : "",
"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" : ""
},
"ServerlessConfig" : "",
"CanTempUpgrade" : true,
"RegionId" : "cn-hangzhou"
}
}
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | ConnectTimeoutRetryLater | Connect timeout retry later. | 连接超时,请稍后重试。 |
400 | DataNotExist | Data not exist. | 数据不存在。 |
访问错误中心查看更多错误码。