文档

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
  • DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

请求参数

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

实例 ID。可调用 DescribeDBInstances 获取。

警告 请勿同时配置多个实例 ID 进行批量查询,否则将会查询超时导致失败。

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:包年包月。
  • SERVERLESS:Serverless。
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 云盘。
  • general_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
DBInstanceDiskUsedstring

实例的磁盘使用量,单位:mb。

300
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
ClassTypestring

节点规格类型。取值范围:

  • d:独享规格
  • x:通用规格
x
Cpustring

节点 CPU 大小。

4
Memorystring

节点的内存大小。单位:MB。

4096
Statusstring

节点的状态。取值范围:

  • active
  • creating
  • deleting
  • classchanging
  • restarting
active
BurstingEnabledboolean

预留参数,无需配置。

false
BpeEnabledstring

弃用参数,无需配置。

0
IoAccelerationEnabledstring

是否开启通用云盘 IO 加速功能,参数取值含义如下:

  • 1:开启
  • 0:不开启
0
PGBouncerEnabledstring

PgBouncer 开关。

说明 仅 PostgreSQL 实例返回此参数,如果开启了 PgBouncer,则此参数返回值为 true
true
ColdDataEnabledboolean

预留参数,无需配置。

false

示例

正常返回示例

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",
        "CanTempUpgrade": true,
        "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",
        "DBInstanceDiskUsed": "300",
        "ProxyType": 1,
        "CurrentKernelVersion": "rds_20201010",
        "DBInstanceDescription": "testInstance",
        "TempUpgradeTimeStart": "",
        "DBInstanceCPU": "2",
        "DBInstanceNetType": "Internet",
        "DBInstanceType": "Primary",
        "LockReason": "instance_expired",
        "DBInstanceStatus": "Running",
        "DBMaxQuantity": 200,
        "RegionId": "cn-hangzhou ",
        "ReadonlyInstanceSQLDelayedTime": "30",
        "TempUpgradeTimeEnd": "",
        "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",
              "ClassType": "x",
              "Cpu": "4",
              "Memory": "4096",
              "Status": "active"
            }
          ]
        },
        "BurstingEnabled": false,
        "BpeEnabled": "0",
        "IoAccelerationEnabled": "0",
        "PGBouncerEnabled": "true",
        "ColdDataEnabled": false
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400ConnectTimeoutRetryLaterConnect timeout retry later.连接超时,请稍后重试。
400TimeoutRetryLaterTimeout, please retry later.-
400DataNotExistData not exist.数据不存在。
400Order.ComboInstanceNotAllowOperateA package instance is not allowed to operate independently.套餐实例不允许单独操作。
400Price.PricingPlanResultNotFoundPricing plan price result not found.定价计划价格结果没有找到。
400Order.NoRealNameAuthenticationYou have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.您还未通过实名认证,不符合购买条件,请登录用户中心进行实名认证。
400InsufficientAvailableQuotaYour account quota limit is less than 0, please recharge before trying to purchase.您的账户可用额度小于0,请先充值后再尝试购买。
400CommodityServiceCalling.ExceptionFailed to call commodity service.调用商品服务返回失败。
400RegionDissolvedEOMDear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.客户您好,阿里云计划对当前地域进行优化调整,该区域云服务将停止运营,为确保您的业务连续性及数据迁移工作的平稳过渡,您目前无法操作新购类型的订单,感谢理解与支持。
400Commodity.InvalidComponentThe module you purchased is not legal, please buy it again.您购买的模块不合法,请重新购买。
400RegionEndTimeDissolvedIndiaCloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.客户您好,印度地域裁撤,购买的服务效期不能超过2024.07.15。
400RegionEndTimeDissolvedAustraliaCloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.客户您好,澳洲地域裁撤,购买的服务效期不能超过2024.09.30
400Price.CommoditySysCommodity system call exception.商品系统调用异常。
400Pay.InsufficientBalanceInsufficient available balance.可用金不足。
400Order.PeriodInvalidThere is a problem with the period you selected, please choose again.您选购的周期有问题,请重新选购。
400pay.noCreditCardAccount not bound to credit card.账户未绑定信用卡。
400Order.InstHasUnpaidOrderThere is an unpaid order for the service you have purchased. Please pay or void it before placing the order.您选购的服务存在未支付订单,请支付或作废后再下单。
400noAvailablePaymentMethodNo payment method is specified for your account. We recommend that you add a payment method.没有为您的帐户指定付款方式。我们建议您添加一种付款方式。
400BasicInfoUncompletedYour information is incomplete. Complete your information before the operation.您的基本信息未完善,请在操作前先完善您的基本信息。
400Risk.RiskControlRejectionYour account is abnormal, please contact customer service for details.您的账户出现异常,详情请联系客服。
400BasicInfoUncompletedYour information is incomplete, Complete your information before the operation.您的信息不完整,请在操作前填写您的信息。
400Api.NotSupportSpecified api is not supported.当前接口不支持。
400ContainForbiddenLabelErrorThere is a label that prohibits placing orders. Please contact your distributor for assistance.存在禁止下单的标签,请联系您的分销商处理
400InvalidDBInstanceId.NotFoundThe DBInstanceId provided does not exist in records.提供的DBInstanceId不存在。
400InvalidInstanceLevel.DiskTypeSpecified instance level not support request disk type当前实例规格不支持该存储类型。
400InvalidParamSepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.指定的 wal_level 参数无效。实例中仍然存在复制槽,因此无法将其设置为replica。
400KmsApiErrorUser secret key invalid.用户密钥失效。
400System.SaleValidateFailedSales expression validation system error.销售表达式校验系统错误。
400Abs.InvalidAccount.NotFoundaccount is not found.账户不存在。
403OrderStatus.UnPaidThe specified db instance has unpaid order.实例当前存在未支付订单,请支付后重试。
403InvalidReduceDiskSizeThe storage capacity after the scale-down must be larger than the used amount.缩容目标容量不能小于当前存储空间使用量
403CloudSSDNotSupportCloud ssd does not support this operation, please upgrade to essd.SSD盘不支持此操作,请升级至ESSD。
403InvalidUserOperatorPermissionThe user permission does not support this operation.用户权限不支持此操作。
403InvalidVswitchIdSpecified conn vswitch id is not valid.指定的VSwitchId格式不正确或为空
404InvalidClusterKmsThe current instance does not authorized to access the Key Management Service.当前实例未授权访问密钥管理服务。
500ExternalFailureThe request processing has failed due to external service failure.请求服务失败,请稍后重试。

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

变更历史

变更时间变更内容概要操作
2024-01-04OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
出参OpenAPI 返回结构发生变更
2023-11-15OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
出参OpenAPI 返回结构发生变更
2023-10-11OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
出参OpenAPI 返回结构发生变更
2023-06-27OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
出参OpenAPI 返回结构发生变更
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 返回结构发生变更
  • 本页导读 (1)