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

调试

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

请求参数

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

系统规定参数,取值:DescribeDBInstanceAttribute

DBInstanceId String rm-uf6wjk5*****

实例ID。可以一次输入最多30个,以半角逗号(,)分隔。

Expired String False

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

  • True:已过期。
  • 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

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

  • Postpaid:按量付费。
  • Prepaid:包年包月。
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域、主机账号等高权限功能,返回值如下:

  • Enable:开放。
  • Disabled:不开放。
InstanceNetworkType String Classic

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

  • Classic:经典网络。
  • VPC:专有网络。
MasterInstanceId String rm-uf6wjk5*****

主实例的ID。

说明 如果没有返回此参数则表示该实例是主实例。
AutoUpgradeMinorVersion String Auto

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

  • Auto:自动升级小版本。
  • Manual:不自动升级,仅在当前版本下线时才强制升级。
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通用版实例的异常提示等级,返回值如下:

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

可用区ID。

MaxConnections Integer 60

最大并发连接数。

DBInstanceId String rm-uf6wjk5*****

实例ID。

TempDBInstanceId String rm-uf64zsu*****

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

AdvancedFeatures String LinkedServer

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

  • LinkedServer:链接服务器。
  • DistributeTransaction:分布式事务。
DBInstanceStorageType String local_ssd

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

  • local_ssdephemeral_ssd:本地SSD盘。
  • cloud_ssd:SSD云盘。
  • cloud_essd:ESSD云盘。
DBInstanceMemory Long 4096

实例内存,单位:M。

IPType String IPv4

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

ConsoleVersion String 2

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

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

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

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

内网连接端口。

LockMode String Unlock

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

  • Unlock:正常。
  • ManualLock:手动触发锁定。
  • LockByExpiration:实例过期自动锁定。
  • LockByRestoration:实例回滚前的自动锁定。
  • LockByDiskQuota:实例空间满自动锁定。
  • LockReadInstanceByDiskQuota:只读实例空间满自动锁定。
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

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

  • normal:通用模式。
  • safety:高安全模式。
DBInstanceClassType String s

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

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

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

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

当前内核版本。

DBInstanceDescription String 测试数据库

实例备注。

DBInstanceCPU String 2

实例CPU数量。

DBInstanceNetType String Internet

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

  • Internet:外网。
  • Intranet:内网。
DBInstanceType String Primary

实例类型,返回值如下:

  • Primary:主实例。
  • Readonly:只读实例。
  • Guard:灾备实例。
  • Temp:临时实例。
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

实例系列,返回值如下:

  • Basic:基础版。
  • HighAvailability:高可用版。
  • AlwaysOn:集群版。
  • Finance:三节点企业版。
DBInstanceClass String rds.mys2.small

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

Engine String MySQL

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

  • MySQL
  • PostgreSQL
  • SQLServer
  • MariaDB
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

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

  • true:已开启。
  • false:未开启。
ServerlessConfig Object

RDS Serverless实例的相关设置。

ScaleMin double 0.5

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

ScaleMax double 8

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

AutoPause Boolean true

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

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

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

  • true:启用。
  • false:不启用,默认值。
说明 实例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迁移模式,返回值如下:

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

内部参数,无需关注。

InstructionSetArch String x86

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

  • x86
  • arm
DBClusterNodes Array of DBClusterNode

集群节点相关信息。

DBClusterNode
NodeRegionId String cn-beijing

Region ID。

NodeZoneId String cn-beijing-h

可用区ID。

NodeId String rn-****

节点ID。

NodeRole String primary

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

  • primary:主节点
  • secondary:备节点
ClassCode String mysql.n2.medium.xc

节点规格。

示例

请求示例

http(s)://rds.aliyuncs.com/?Action=DescribeDBInstanceAttribute
&DBInstanceId=rm-uf6wjk5*****
&Expired=False
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "Items" : [ {
    "VpcId" : "vpc-*****",
    "CreationTime" : "2011-05-30T12:11:04Z",
    "IncrementSourceDBInstanceId" : "rm-uf6wjk5*****",
    "MaintainTime" : "00:00Z-02:00Z",
    "PayType" : "Postpaid",
    "AvailabilityValue" : "100.0%",
    "EngineVersion" : "5.5",
    "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_20201031",
    "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,
    "Tips" : "一切正常",
    "SecurityIPList" : "192.168.XX.XX/24",
    "SecurityIPMode" : "normal",
    "DBInstanceClassType" : "s",
    "ProxyType" : 1,
    "CurrentKernelVersion" : "rds_20181010",
    "DBInstanceDescription" : "测试数据库",
    "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" : [ {
      "ZoneId" : "cn-hangzhou-a"
    } ],
    "ReadOnlyDBInstanceIds" : [ {
      "DBInstanceId" : "rm-bp*****"
    } ],
    "Extra" : {
      "DBInstanceIds" : [ "rm-uf6wjk5*****" ]
    },
    "DeletionProtection" : true,
    "ServerlessConfig" : {
      "ScaleMin" : 0.5,
      "ScaleMax" : 8,
      "AutoPause" : true,
      "SwitchForce" : false
    },
    "BabelfishConfig" : {
      "BabelfishEnabled" : "true",
      "MigrationMode" : "single-db"
    },
    "kindCode" : "无",
    "InstructionSetArch" : "x86",
    "DBClusterNodes" : [ {
      "NodeRegionId" : "cn-beijing",
      "NodeZoneId" : "cn-beijing-h",
      "NodeId" : "rn-****",
      "NodeRole" : "primary",
      "ClassCode" : "mysql.n2.medium.xc"
    } ]
  } ]
}

错误码

HttpCode 错误码 错误信息 描述
400 ConnectTimeoutRetryLater Connect timeout retry later. 连接超时,请稍后重试。
400 DataNotExist Data not exist. 数据不存在。

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