You need to enable JavaScript to run this app.
文档中心
云数据库 MySQL 版

云数据库 MySQL 版

复制全文
下载 pdf
实例管理
DescribeDBInstanceAttribute - 查询实例的属性
复制全文
下载 pdf
DescribeDBInstanceAttribute - 查询实例的属性
调用 DescribeDBInstanceAttribute 接口查询实例的属性。​
请求类型​
同步请求。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
​
参数​
类型​
是否必选​
示例值​
描述​
InstanceId​
String​
是​
mysql-f83edc2e****​
实例 ID。​
​
返回参数​
​
参数​
类型​
示例值​
描述​
DBInstanceAttribute​
Object of DBInstanceAttribute​
请参见返回示例。​
实例的各项属性。​
​
DBInstanceAttribute​
​
参数​
类型​
示例值​
描述​
AllowListVersion​
String​
v2​
实例白名单的版本。​
AutoUpgradeMinorVersion​
String​
Auto​
实例内核小版本的升级策略。取值:​
  • Auto:自动升级。​
  • Manual:手动升级。​
CreateTime​
String​
2025-07-23T03:40:54.000Z​
实例的创建时间(UTC 时间)。格式为 yyyy-MM-ddTHH:mm:ss.sssZ。​
CurrentKernelVersion​
String​
MySQL 5.7.32_20250615​
实例当前的内核小版本。​
DBEngineVersion​
String​
MySQL_5_7​
实例的兼容版本。取值:​
  • MySQL_5_7:MySQL 5.7 版本。​
  • MySQL_8_0:MySQL 8.0 版本。​
  • MySQL 8.4:MySQL 8.4 版本。​
DeletionProtection​
String​
Enabled​
是否启用实例的删除保护功能。取值:​
  • Enabled:是。​
  • Disabled:否。​
HasDisasterRecoveryInstances​
Boolean​
false​
实例是否有灾备实例。取值:​
  • true:是。​
  • false:否。​
HasGreenInstance​
Boolean​
false​
实例是否处于蓝绿部署中。取值:​
  • true:是。​
  • false:否。​
InstanceId​
String​
mysql-f83edc2e****​
实例 ID。​
InstanceName​
String​
测试实例​
实例名称。​
InstanceStatus​
String​
Running​
实例状态。取值:​
  • Creating:创建中。​
  • Running:运行中。​
  • Deleting:删除中。​
  • Restarting:重启中。​
  • Updating:变更中。​
  • Restoring:恢复中。​
  • Error:错误。​
  • Upgrading:升级中。​
  • Released:回收中。​
  • Recycled:已回收。​
  • MasterChanging:主节点切换中。​
  • TDEUpdating:TDE 修改中。​
  • Closed:关停。​
  • Maintaining:维护中。​
  • CreateFailed:创建失败。​
  • Closing:关停中。​
  • SSLUpdating:SSL 变更中。​
  • AllowListMaintaining:白名单变更中。​
  • Unknown:未知。​
  • ProxyCreating:代理开启中。​
  • ProxyDeleting:代理关闭中。​
  • ChargeTypeChanging:计费类型变更中。​
  • NetWorkChanging:网络变更中。​
InstanceType​
String​
DoubleNode​
实例类型。取值:​
  • DoubleNode,双节点类型。​
  • MultiNode,多节点类型。​
LowerCaseTableNames​
String​
false​
表名称是否区分大小写。取值:​
  • false:表名被存储成固定且表名称大小写敏感。​
  • true:表名将被存储成小写且表名称大小写不敏感。​
MaintenanceWindow​
请参见返回示例。​
实例的可维护时间段。​
Memory​
Integer​
2​
实例的内存大小。单位为 GiB。​
NodeNumber​
String​
2​
实例的节点数量。​
NodeSpec​
String​
rds.mysql.d1.n.1c1g​
节点规格。关于节点规格的详细信息,请参见产品规格。​
ProjectName​
String​
default​
实例所属的项目。​
RegionId​
String​
cn-beijing​
实例所处地域的 ID。​
StorageSpace​
Long​
200​
实例存储空间。单位为 GiB。​
StorageType​
String​
LocalSSD​
实例的存储类型。取值范围:​
  • LocalSSD:本地盘。​
  • CloudESSD_FlexPL:FlexPL 云盘。​
  • CloudESSD_PL0:PL0 云盘。​
  • CloudESSD_HighPerf:高性能云盘。​
SubnetId​
String​
subnet-11wfw1cvzttds40yrhcx1****​
实例使用的子网的 ID。​
Tags​
Array of TagObject​
[​
{​
"Key": "Key1",​
"Value": "Value1"​
},​
{​
"Key": "Key2",​
"Value": "Value2"​
}​
]​
实例绑定的标签。​
TimeZone​
String​
UTC +08:00​
实例的时区。​
UpdateTime​
String​
2025-07-24T13:40:54.000Z​
实例更新的本地时间。​
VCPU​
Integer​
1​
实例的 CPU 核数。​
VpcId​
String​
vpc-3ezxu117lv18g72200rro****​
实例使用的私有网络的 ID。​
ZoneId​
String​
cn-guangzhou-a​
实例主节点所在的可用区 ID。​
EngineType​
String​
RocksDB​
数据库引擎类型。取值:​
  • InnoDB:InnoDB 引擎。​
  • RocksDB:RocksDB 引擎。​
说明​
作为请求参数时,默认值为 InnoDB。​
​
MaintenanceWindowObject​
​
参数​
类型​
示例值​
描述​
DayKind​
String​
Week​
可维护周期粒度,取值为 Week,周。​
DayOfWeek​
Array of String​
["Monday","Tuesday"]​
指定修改每周哪一天的可维护时间段,取值为:Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday,可多选。如果不指定该值或者为空,则默认一周七天都指定。​
MaintenanceTime​
String​
22:00Z-02:00Z​
实例的可维护时间段。格式:HH:mmZ-HH:mmZ(UTC 时间)。​
​
TagObject​
​
参数​
类型​
示例值​
描述​
Key​
String​
tagkey​
实例标签的标签键。标签键的设置规则如下:​
  • 支持任何语言字母或文字(如中文、英文字母等)、数字、空格。​
  • 支持特殊字符:_.:/=+-@。​
  • volc: 为系统预留的标签键,添加标签时,标签键的开头不能设置为任何大小写形式的 volc:。​
  • 标签键的长度需为 1~128 个字符。​
Value​
String​
tagvalue​
实例标签的标签值。标签值的设置规则如下:​
  • 支持任何语言字母或文字(如中文、英文字母等)、数字、空格。​
  • 支持特殊字符:_.:/=+-@。​
  • 标签值的长度需为 0~256 个字符,即标签值可以为空。​
​
示例​
请求示例​
​
POST /?Action=DescribeDBInstanceAttribute&Version=2022-01-01 HTTP/1.1​
Content-Type: application/json​
Host: rds-mysql.cn-beijing.volcengineapi.com​
X-Date: 20211202T101010Z​
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_mysql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****​
{​
"InstanceId": "mysql-66347599****"​
}​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "202507241406442EEEFDBA9025ACFAD59A-fdf98c",​
"Action": "DescribeDBInstanceAttribute",​
"Version": "2022-01-01",​
"Service": "rds_mysql",​
"Region": "cn-guangzhou"​
},​
"Result": {​
"DBInstanceAttribute": {​
"AllowListVersion": "v2",​
"AutoUpgradeMinorVersion": "Auto",​
"CreateTime": "2025-07-23T03:40:54.000Z",​
"CurrentKernelVersion": "MySQL 5.7.32_20250615",​
"DBEngineVersion": "MySQL_5_7",​
"DeletionProtection": "Enabled",​
"HasDisasterRecoveryInstances": false,​
"HasGreenInstance": true,​
"InstanceId": "mysql-f83edc2e****",​
"InstanceName": "测试实例",​
"InstanceStatus": "Updating",​
"InstanceType": "DoubleNode",​
"LowerCaseTableNames": "1",​
"MaintenanceWindow": {​
"DayKind": "Week",​
"DayOfWeek": [​
"Monday",​
"Tuesday",​
"Wednesday",​
"Thursday",​
"Friday",​
"Saturday",​
"Sunday"​
],​
"MaintenanceTime": "18:00Z-21:59Z"​
},​
"Memory": 1,​
"NodeNumber": "4",​
"NodeSpec": "rds.mysql.d1.n.1c1g",​
"ProjectName": "default",​
"RegionId": "cn-guangzhou",​
"StorageSpace": 100,​
"StorageType": "LocalSSD",​
"SubnetId": "subnet-3rf442t6a54w016nf3pg9****",​
"Tags": [​
{​
"Key": "Key1",​
"Value": "Value1"​
},​
{​
"Key": "Key2",​
"Value": "Value2"​
}​
],​
"TimeZone": "UTC +08:00",​
"UpdateTime": "",​
"VCPU": 1,​
"VpcId": "vpc-3ezxu117lv18g72200rro****",​
"ZoneId": "cn-guangzhou-a"​
}​
}​
}​
​
错误码​
更多详情,请参见错误码。​
​
最近更新时间:2026.08.05 14:42:12
这个页面对您有帮助吗?
有用
有用
无用
无用