DescribeDBInstanceAttribute
调用DescribeDBInstanceAttribute接口查看RDS实例的详细信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeDBInstanceAttribute |
系统规定参数,取值:DescribeDBInstanceAttribute。 |
DBInstanceId | String | 是 | rm-uf6wjk5xxxxxxxxxx |
实例ID。可以一次输入最多30个,以英文逗号(,)分隔。 |
Expired | String | 否 | False |
实例过期状态,取值:
|
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 1AD222E9-E606-4A42-BF6D-8A4442913CEF |
请求ID。 |
Items | Array |
实例属性列表。 |
|
DBInstanceId | String | rm-uf6wjk5xxxxxxxxxx |
实例ID。 |
PayType | String | Postpaid |
实例付费方式,取值:
|
DBInstanceClassType | String | s |
实例规格族,取值:
|
DBInstanceType | String | Primary |
实例类型,取值:
|
RegionId | String | cn-hangzhou |
地域ID。 |
ConnectionString | String | rm-uf6wjk5xxxxxxxxxx.mysql.rds.aliyuncs.com |
内网连接地址。 |
Port | String | 3306 |
内网连接端口。 |
Engine | String | MySQL |
数据库类型。 |
EngineVersion | String | 5.5 |
数据库版本。 |
DBInstanceClass | String | rds.mys2.small |
实例规格,详情请参见实例规格表。 |
DBInstanceMemory | Long | 4096 |
实例内存,单位:M。 |
DBInstanceStorage | Integer | 10 |
实例存储空间,单位:GB。 |
VpcCloudInstanceId | String | vpc-23rsxdfxxxxxxx |
专有网络实例ID。 |
DBInstanceNetType | String | Internet |
实例是内网或外网,取值:
|
DBInstanceStatus | String | Running |
实例状态,详情请参见实例状态表。 |
DBInstanceDescription | String | 测试数据库 |
实例备注。 |
LockMode | String | Unlock |
实例锁定模式:
|
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,如果没有返回此参数(即为null)则表示该实例是主实例。 |
IncrementSourceDBInstanceId | String | rm-uf6wjk5xxxxxxxxxx |
增量数据来源的实例ID,如灾备实例的增量数据来源是主实例。只读实例的增量数据来源是主实例,如果没有返回此参数(即为null)则表示该实例是主实例。 |
GuardDBInstanceId | String | rm-uf64zsuxxxxxxxxxx |
该实例如果挂载着灾备实例,即为灾备实例的ID。 |
TempDBInstanceId | String | rm-uf64zsuxxxxxxxxxx |
该实例如果挂载着临时实例,即为临时实例ID。 |
ZoneId | String | cn-hangzhou-a |
可用区ID。 |
InstanceNetworkType | String | Classic |
实例的网络类型,取值:
|
DBInstanceStorageType | String | local_ssd |
实例储存类型,取值:
|
AdvancedFeatures | String | LinkedServer |
目前只针对SQL Server,获取高级特性值,多个值之间用英文逗号(,)隔开,现返回值如下:
|
Category | String | Basic |
实例系列,取值:
|
VpcId | String | vpc-xxxxxxxxx |
VPC ID。 |
VSwitchId | String | vsw-xxxxxx |
交换机ID。 |
ConnectionMode | String | Standard |
实例的访问模式,取值:
|
CurrentKernelVersion | String | rds_20181010 |
当前内核版本。 |
ResourceGroupId | String | rg-acfmyxxxxxxxxxx |
资源组ID。 |
ReadonlyInstanceSQLDelayedTime | String | 30 |
只读实例延迟复制时间,只读实例延迟ReadonlyInstanceSQLDelayedTime的时间后再同步主实例数据,单位:秒。 |
SecurityIPMode | String | normal |
白名单模式。取值:
|
TimeZone | String | Central Standard Time |
时区。 |
Collation | String | Chinese_PRC_CI_AS |
系统字符集排序规则。 |
MasterZone | String | 5454284 |
主可用区ID。 |
AutoUpgradeMinorVersion | String | Auto |
实例升级小版本的方式,取值:
|
ProxyType | Integer | 1 |
主实例的代理类型,取值:
|
ConsoleVersion | String | 2 |
当前实例的代理类型。取值:
|
SlaveZones | Array |
组成SlaveZones的参数。 |
|
ZoneId | String | cn-hangzhou-a |
可用区。 |
ReadOnlyDBInstanceIds | Array |
主实例下挂载的只读实例ID列表。 |
|
DBInstanceId | String | rm-bpxxxxxxxxx |
只读实例ID。 |
Extra | Struct |
扩展信息。 |
|
DBInstanceId | List | rm-uf6wjk5xxxxxxxxxx |
实例ID。 |
示例
请求示例
http(s)://rds.aliyuncs.com/?Action=DescribeDBInstanceAttribute
&DBInstanceId=rm-uf6wjk5xxxxxxxxxx
&<公共请求参数>
正常返回示例
JSON
格式
{
"Items": {
"DBInstanceAttribute": [
{
"Extra": {
"DBInstanceId": {
"DBInstanceId": []
}
},
"ConnectionString": "rm-uf6wjk5xxxxxxxxxx.mysql.rds.aliyuncs.com",
"AccountMaxQuantity": 99999,
"CurrentKernelVersion": "rds_20170714",
"DBInstanceCPU": "2",
"ZoneId": "cn-hangzhou-f",
"ReadOnlyDBInstanceIds": {
"ReadOnlyDBInstanceId": []
},
"ConnectionMode": "Standard",
"VSwitchId": "vsw-bp1w9oueixxxxx",
"VpcId": "vpc-bp1opxu1zkhxxxxx",
"Engine": "MySQL",
"MaintainTime": "18:00Z-22:00Z",
"MaxConnections": 4000,
"DBInstanceType": "Primary",
"DBInstanceMemory": 4096,
"EngineVersion": "5.7",
"ConsoleVersion":"2",
"DBInstanceStorageType": "cloud_ssd",
"DBInstanceStatus": "Running",
"SecurityIPMode": "normal",
"PayType": "Prepaid",
"SupportUpgradeAccountType": "No",
"AccountType": "Mix",
"LockMode": "Unlock",
"DBInstanceNetType": "Intranet",
"MaxIOPS": 600,
"DBInstanceClass": "mysql.n2.medium.1",
"DBMaxQuantity": 99999,
"ResourceGroupId": "rg-acfmyxxxxx",
"DBInstanceId": "rm-bp176xxxxx",
"VpcCloudInstanceId": "rm-bp176gz7xxxxx",
"DBInstanceClassType": "x",
"LatestKernelVersion": "",
"InstanceNetworkType": "VPC",
"DBInstanceStorage": 20,
"SupportCreateSuperAccount": "No",
"CreationTime": "2018-11-28T01:32:08Z",
"Category": "Basic",
"Port": "3306",
"InsId": 1,
"ExpireTime": "2018-12-28T16:00:00Z",
"RegionId": "cn-hangzhou",
"AvailabilityValue": "100.0%",
"SecurityIPList": "1.1.1.1"
}
]
},
"RequestId": "CFE76192-2F85-4D18-975E-465B77C129C4"
}
XML
格式
<DescribeDBInstanceAttributeResponse>
<Items>
<DBInstanceAttribute>
<Extra>
<DBInstanceId></DBInstanceId>
</Extra>
<ConnectionString>rm-uf6wjk5xxxxxxxxxx.mysql.rds.aliyuncs.com</ConnectionString>
<AccountMaxQuantity>99999</AccountMaxQuantity>
<CurrentKernelVersion>rds_20170714</CurrentKernelVersion>
<DBInstanceCPU>2</DBInstanceCPU>
<ZoneId>cn-hangzhou-f</ZoneId>
<ReadOnlyDBInstanceIds></ReadOnlyDBInstanceIds>
<ConnectionMode>Standard</ConnectionMode>
<VSwitchId>vsw-bp1w9oueixxxxx</VSwitchId>
<VpcId>vpc-bp1opxu1zkhxxxxx</VpcId>
<ConsoleVersion>2</ConsoleVersion>
<Engine>MySQL</Engine>
<MaintainTime>18:00Z-22:00Z</MaintainTime>
<MaxConnections>4000</MaxConnections>
<DBInstanceType>Primary</DBInstanceType>
<DBInstanceMemory>4096</DBInstanceMemory>
<EngineVersion>5.7</EngineVersion>
<DBInstanceStorageType>cloud_ssd</DBInstanceStorageType>
<DBInstanceStatus>Running</DBInstanceStatus>
<SecurityIPMode>normal</SecurityIPMode>
<PayType>Prepaid</PayType>
<SupportUpgradeAccountType>No</SupportUpgradeAccountType>
<AccountType>Mix</AccountType>
<LockMode>Unlock</LockMode>
<DBInstanceNetType>Intranet</DBInstanceNetType>
<MaxIOPS>600</MaxIOPS>
<DBInstanceClass>mysql.n2.medium.1</DBInstanceClass>
<DBMaxQuantity>99999</DBMaxQuantity>
<ResourceGroupId>rg-acfmyxxxxx</ResourceGroupId>
<DBInstanceId>rm-bp176xxxxx</DBInstanceId>
<VpcCloudInstanceId>rm-bp176gz7xxxxx</VpcCloudInstanceId>
<DBInstanceClassType>x</DBInstanceClassType>
<LatestKernelVersion></LatestKernelVersion>
<InstanceNetworkType>VPC</InstanceNetworkType>
<DBInstanceStorage>20</DBInstanceStorage>
<SupportCreateSuperAccount>No</SupportCreateSuperAccount>
<CreationTime>2018-11-28T01:32:08Z</CreationTime>
<Category>Basic</Category>
<Port>3306</Port>
<InsId>1</InsId>
<ExpireTime>2018-12-28T16:00:00Z</ExpireTime>
<RegionId>cn-hangzhou</RegionId>
<AvailabilityValue>100.0%</AvailabilityValue>
<SecurityIPList>1.1.1.1</SecurityIPList>
</DBInstanceAttribute>
</Items>
<RequestId>CFE76192-2F85-4D18-975E-465B77C129C4</RequestId>
</DescribeDBInstanceAttributeResponse>
错误码
访问错误中心查看更多错误码。
版权声明
本文仅代表作者观点,不代表本站立场。
本文系作者授权发表,未经许可,不得转载。
评论