首页 云数据库 RDS API参考 API目录 实例 DescribeDBInstanceAttribute - 查询实例详情

DescribeDBInstanceAttribute - 查询实例详情

该接口用于查询RDS实例的详细信息。

接口说明

适用引擎

  • RDS MySQL
  • RDS PostgreSQL
  • RDS SQL Server
  • RDS MariaDB

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
rds:DescribeDBInstanceAttributeREAD
  • RDS
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
  • rds:ResourceTag

请求参数

名称类型必填描述示例值
DBInstanceIdstring

实例ID。可调用DescribeDBInstances获取。

rm-uf6wjk5****
Expiredstring

实例过期状态,取值如下:

  • True:已过期。
  • False:未过期。
False

返回参数

名称类型描述示例值
object

返回参数详情。

RequestIdstring

请求ID。

1AD222E9-E606-4A42-BF6D-8A4442913CEF
Itemsobject []

实例属性列表。

VpcIdstring

VPC ID。

vpc-****
CreationTimestring

创建时间。格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

2011-05-30T12:11:04Z
IncrementSourceDBInstanceIdstring

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

rm-uf6wjk5****
MaintainTimestring

实例可维护时间段,表示为UTC时间,+8小时后是控制台上显示到的可维护时间段。

00:00Z-02:00Z
PayTypestring

实例付费方式,返回值如下:

  • Postpaid:按量付费。
  • Prepaid:包年包月。
Postpaid
AvailabilityValuestring

实例可用性状态,单位:百分比(%)。

100.0%
EngineVersionstring

数据库版本。

8.0
DedicatedHostGroupIdstring

专属集群ID。

dhg-7a9*****
ConnectionStringstring

内网连接地址。

rm-uf6wjk5****.mysql.rds.aliyuncs.com
SuperPermissionModestring

当前实例是否可以开放SA账号、AD域、主机账号等高权限功能,返回值如下:

  • Enable:开放。
  • Disabled:不开放。
Disabled
InstanceNetworkTypestring

实例的网络类型,返回值如下:

  • Classic:经典网络。
  • VPC:专有网络。
Classic
MasterInstanceIdstring

主实例的ID。

说明如果没有返回此参数则表示该实例是主实例。
rm-uf6wjk5****
AutoUpgradeMinorVersionstring

实例升级小版本的方式,返回值如下:

  • Auto:自动升级小版本。
  • Manual:不自动升级,仅在当前版本下线时才强制升级。
Auto
ExpireTimestring

到期时间。格式为yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

说明按量付费实例无到期时间。
2019-03-27T16:00:00Z
AccountMaxQuantityinteger

可创建账号的最大数量。

50
MasterZonestring

主可用区ID。

5454284
GuardDBInstanceIdstring

该实例如果挂载着灾备实例,即为灾备实例的ID。

rm-uf64zsu****
DBInstanceStorageinteger

实例存储空间,单位:GB。

10
TimeZonestring

时区。

Central Standard Time
LatestKernelVersionstring

当前实例支持的最新内核版本。

rds_20231031
TipsLevelinteger

专属集群MySQL通用版实例的异常提示等级,返回值如下:

  • 1:正常。
  • 2:只读实例和主实例规格不对齐,可能影响可用性,请按需调整实例规格。
1
ZoneIdstring

可用区ID。

cn-hangzhou-a
MaxConnectionsinteger

最大并发连接数。

60
DBInstanceIdstring

实例ID。

rm-uf6wjk5****
TempDBInstanceIdstring

该实例如果挂载着临时实例,即为临时实例ID。

rm-uf64zsu****
AdvancedFeaturesstring

目前只针对SQL Server,获取高级特性值,多个值之间用半角逗号(,)隔开,返回值如下:

  • LinkedServer:链接服务器。
  • DistributeTransaction:分布式事务。
LinkedServer
DBInstanceStorageTypestring

实例储存类型,返回值如下:

  • local_ssdephemeral_ssd:本地SSD盘。
  • cloud_ssd:SSD云盘。
  • cloud_essd:ESSD云盘。
local_ssd
DBInstanceMemorylong

实例内存,单位:M。

4096
IPTypestring

IP地址类型。当前仅支持IPv4

IPv4
ConsoleVersionstring

实例的代理类型,返回值如下:

  • 1:共享代理。
  • 2:独享代理。
说明不建议使用该参数,请使用返回参数ProxyType
2
ConnectionModestring

实例的访问模式,返回值如下:

  • Standard:标准访问模式。
  • Safe:数据库代理模式。
Standard
Portstring

内网连接端口。

3306
LockModestring

实例锁定模式,返回值如下:

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

专属集群MySQL通用版实例所属的组名。

TestGroup
VpcCloudInstanceIdstring

专有网络实例ID。

vpc-23rsxdf****
Collationstring

系统字符集排序规则。

Chinese_PRC_CI_AS
MaxIOPSinteger

最大每秒IO请求次数。

150
MaxIOMBPSinteger

最大IO吞吐。单位:MB/s。

100
Tipsstring

专属集群MySQL通用版实例的异常提示信息。

normal
SecurityIPListstring

IP白名单分组下的IP列表。

192.168.XX.XX/24
SecurityIPModestring

白名单模式,返回值如下:

  • normal:通用模式。
  • safety:高安全模式。
normal
DBInstanceClassTypestring

实例规格族,返回值如下:

  • s:共享型。
  • x:通用型。
  • d:独享套餐。
  • h:独占物理机。
s
ProxyTypeinteger

实例支持的代理类型,返回值如下:

  • 0:表示不支持开通代理。
  • 1:表示支持开通共享代理(多租户模式)。
  • 2:表示支持开通独享代理(单租户模式)。
1
CurrentKernelVersionstring

当前内核版本。

rds_20201010
DBInstanceDescriptionstring

实例备注。

testInstance
DBInstanceCPUstring

实例CPU数量。

2
DBInstanceNetTypestring

实例是内网或外网,返回值如下:

  • Internet:外网。
  • Intranet:内网。
Internet
DBInstanceTypestring

实例类型,返回值如下:

  • Primary:主实例。
  • Readonly:只读实例。
  • Guard:灾备实例。
  • Temp:临时实例。
Primary
LockReasonstring

锁定原因。

instance_expired
DBInstanceStatusstring

实例状态,详情请参见实例状态表

Running
DBMaxQuantityinteger

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

200
RegionIdstring

地域ID。

cn-hangzhou
ReadonlyInstanceSQLDelayedTimestring

只读实例延迟复制时间,只读实例延迟ReadonlyInstanceSQLDelayedTime的时间后再同步主实例数据,单位:秒(s)。

30
VSwitchIdstring

交换机ID。

vsw-****
ResourceGroupIdstring

资源组ID。

rg-acfmy****
Categorystring

实例系列,返回值如下:

  • Basic:基础版。
  • HighAvailability:高可用版。
  • cluster:MySQL集群版。
  • AlwaysOn:SQL Server集群版。
  • Finance:三节点企业版。
  • Serverless_basic:Serverless基础版。
Basic
DBInstanceClassstring

实例规格,详情请参见实例规格表

rds.mys2.small
Enginestring

数据库类型,返回值如下:

  • MySQL
  • PostgreSQL
  • SQLServer
  • MariaDB
MySQL
SlaveZonesobject []

组成SlaveZones的参数列表。

ZoneIdstring

可用区。

cn-hangzhou-a
ReadOnlyDBInstanceIdsobject []

主实例下挂载的只读实例ID列表。

DBInstanceIdstring

只读实例ID。

rm-bp****
Extraobject

扩展信息。

DBInstanceIdsarray

数据库实例ID列表。

string

实例ID。

rm-uf6wjk5****
DeletionProtectionboolean

是否已开启释放保护功能,返回值如下:

  • true:已开启。
  • false:未开启。
true
ServerlessConfigobject

RDS Serverless实例的相关设置。

ScaleMindouble

实例RCU(RDS Capacity Unit)自动扩缩范围的最小值。

0.5
ScaleMaxdouble

实例RCU(RDS Capacity Unit)自动扩缩范围的最大值。

8
AutoPauseboolean

是否开启Serverless实例的自动启停功能,返回值如下:

  • true:启用。
  • false::不启用,默认值。
说明10分钟无任何连接将进入暂停状态,连接时会自动唤醒。
true
SwitchForceboolean

是否开启Serverless实例的强制弹性扩缩容,返回值如下:

  • true:启用。
  • false:不启用,默认值。
说明实例RCU的弹性扩缩容通常会立刻生效,但在某些特殊情况下无法即时完成扩缩容,此时可开启本参数进行强制扩缩容。
false
BabelfishConfigobject

Babelfish for RDS PostgreSQL配置信息。

说明该参数仅适用于Babelfish for RDS PostgreSQL实例,更多介绍,请参见Babelfish简介
BabelfishEnabledstring

Babelfish开关。

说明购买RDS PostgreSQL实例时,如果开启了Babelfish,则此参数固定为true
true
MigrationModestring

Babelfish迁移模式,返回值如下:

  • single-db:单数据库模式。
  • multi-db:多数据库模式。
说明Babelfish迁移模式的更多信息,请参见迁移模式简介
single-db
kindCodestring

内部参数,无需关注。

test
InstructionSetArchstring

实例的架构类型,返回值如下:

  • x86
  • arm
x86
DBClusterNodesobject []

集群节点相关信息。

NodeRegionIdstring

Region ID。

cn-beijing
NodeZoneIdstring

可用区ID。

cn-beijing-h
NodeIdstring

节点ID。

rn-****
NodeRolestring

节点角色,取值含义如下:

  • primary:主节点
  • secondary:备节点
primary
ClassCodestring

节点规格。

mysql.n2.medium.xc

示例

正常返回示例

JSON格式

{
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "Items": {
    "DBInstanceAttribute": [
      {
        "VpcId": "vpc-****",
        "CreationTime": "2011-05-30T12:11:04Z",
        "IncrementSourceDBInstanceId": "rm-uf6wjk5****",
        "MaintainTime": "00:00Z-02:00Z",
        "PayType": "Postpaid",
        "AvailabilityValue": "100.0%",
        "EngineVersion": "8.0",
        "DedicatedHostGroupId": "dhg-7a9*****",
        "ConnectionString": "rm-uf6wjk5****.mysql.rds.aliyuncs.com",
        "SuperPermissionMode": "Disabled",
        "InstanceNetworkType": "Classic",
        "MasterInstanceId": "rm-uf6wjk5****",
        "AutoUpgradeMinorVersion": "Auto",
        "ExpireTime": "2019-03-27T16:00:00Z",
        "AccountMaxQuantity": 50,
        "MasterZone": "5454284",
        "GuardDBInstanceId": "rm-uf64zsu****",
        "DBInstanceStorage": 10,
        "TimeZone": "Central Standard Time",
        "LatestKernelVersion": "rds_20231031",
        "TipsLevel": 1,
        "ZoneId": "cn-hangzhou-a",
        "MaxConnections": 60,
        "DBInstanceId": "rm-uf6wjk5****",
        "TempDBInstanceId": "rm-uf64zsu****",
        "AdvancedFeatures": "LinkedServer",
        "DBInstanceStorageType": "local_ssd",
        "DBInstanceMemory": 4096,
        "IPType": "IPv4",
        "ConsoleVersion": "2",
        "ConnectionMode": "Standard",
        "Port": "3306",
        "LockMode": "Unlock",
        "GeneralGroupName": "TestGroup",
        "VpcCloudInstanceId": "vpc-23rsxdf****",
        "Collation": "Chinese_PRC_CI_AS",
        "MaxIOPS": 150,
        "MaxIOMBPS": 100,
        "Tips": "normal",
        "SecurityIPList": "192.168.XX.XX/24",
        "SecurityIPMode": "normal",
        "DBInstanceClassType": "s",
        "ProxyType": 1,
        "CurrentKernelVersion": "rds_20201010",
        "DBInstanceDescription": "testInstance",
        "DBInstanceCPU": "2",
        "DBInstanceNetType": "Internet",
        "DBInstanceType": "Primary",
        "LockReason": "instance_expired",
        "DBInstanceStatus": "Running",
        "DBMaxQuantity": 200,
        "RegionId": "cn-hangzhou ",
        "ReadonlyInstanceSQLDelayedTime": "30",
        "VSwitchId": "vsw-****",
        "ResourceGroupId": "rg-acfmy****",
        "Category": "Basic",
        "DBInstanceClass": "rds.mys2.small",
        "Engine": "MySQL",
        "SlaveZones": {
          "SlaveZone": [
            {
              "ZoneId": "cn-hangzhou-a"
            }
          ]
        },
        "ReadOnlyDBInstanceIds": {
          "ReadOnlyDBInstanceId": [
            {
              "DBInstanceId": "rm-bp****"
            }
          ]
        },
        "Extra": {
          "DBInstanceIds": {
            "DBInstanceId": [
              "rm-uf6wjk5****"
            ]
          }
        },
        "DeletionProtection": true,
        "ServerlessConfig": {
          "ScaleMin": 0.5,
          "ScaleMax": 8,
          "AutoPause": true,
          "SwitchForce": false
        },
        "BabelfishConfig": {
          "BabelfishEnabled": "true",
          "MigrationMode": "single-db"
        },
        "kindCode": "test",
        "InstructionSetArch": "x86",
        "DBClusterNodes": {
          "DBClusterNode": [
            {
              "NodeRegionId": "cn-beijing",
              "NodeZoneId": "cn-beijing-h",
              "NodeId": "rn-****",
              "NodeRole": "primary",
              "ClassCode": "mysql.n2.medium.xc"
            }
          ]
        },
        "BurstingEnabled": true,
        "BpeEnabled": ""
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400ConnectTimeoutRetryLaterConnect timeout retry later.连接超时,请稍后重试。
400TimeoutRetryLaterTimeout, please retry later.-
400DataNotExistData not exist.数据不存在。

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

变更历史

变更时间变更内容概要操作
2022-09-01OpenAPI 错误码发生变更,OpenAPI 返回结构发生变更
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
出参OpenAPI 返回结构发生变更
2022-07-05OpenAPI 描述信息更新,OpenAPI 错误码发生变更,OpenAPI 返回结构发生变更
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    删除错误码:400
出参OpenAPI 返回结构发生变更
2022-02-28OpenAPI 错误码发生变更,OpenAPI 返回结构发生变更
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
出参OpenAPI 返回结构发生变更
2022-02-28OpenAPI 错误码发生变更,OpenAPI 返回结构发生变更
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
出参OpenAPI 返回结构发生变更
2022-02-28OpenAPI 错误码发生变更,OpenAPI 返回结构发生变更
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
出参OpenAPI 返回结构发生变更
2022-02-28OpenAPI 错误码发生变更,OpenAPI 返回结构发生变更
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
出参OpenAPI 返回结构发生变更
2022-02-28OpenAPI 错误码发生变更,OpenAPI 返回结构发生变更
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
出参OpenAPI 返回结构发生变更
阿里云首页 关系型数据库 相关技术圈