DescribeResourceUsage_云数据库 RDS_API文档-阿里云OpenAPI开发者门户

接口说明

适用引擎

RDS MySQL
RDS PostgreSQL
RDS SQL Server
RDS MariaDB

流控信息

请求速率为500/1(s)。更多流控信息，请前往配额中心查看

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

rds:DescribeResourceUsage	Get	DBInstance acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}	rds:ResourceTag rds:ResourceTag rds:ResourceTag rds:ResourceTag	无

请求参数

字段名称	字段详情
DBInstanceIdstring	实例 ID。可调用 DescribeDBInstances 获取。示例值:rm-uf6wjk5****参考取值来源: CloneDBInstance CreateDBInstance ReceiveDBInstance ModifyDBInstanceSpec RecoveryDBInstance DescribeDBInstances CalculateDBInstanceWeight MigrateDBNodes UpgradeDBInstanceMajorVersion TransformDBInstancePayType EvaluateLocalExtendDisk RestoreDdrTable RebuildReplicationLink
ResourceGroupIdstring	资源组 ID。示例值:rg-acfmy****参考取值来源: DescribeResourceDetails

返回参数

字段名称	字段详情
ArchiveBackupSizeinteger<int64>	归档备份的占用空间，单位：Byte。注意请注意，该值为 Long 类型，在某些语言中可能存在精度丢失的风险，请小心使用。示例值:0
BackupDataSizeinteger<int64>	数据备份占用的总空间（不包括归档备份），单位：Byte。展开详情注意请注意，该值为 Long 类型，在某些语言中可能存在精度丢失的风险，请小心使用。示例值:94324736
BackupLogSizeinteger<int64>	日志备份占用的总空间（不包括归档备份），单位：Byte。注意请注意，该值为 Long 类型，在某些语言中可能存在精度丢失的风险，请小心使用。示例值:45145563
BackupOssDataSizeinteger<int64>	OSS 中备份集的数据文件大小，单位：Byte。0 表示没有数据。展开详情注意请注意，该值为 Long 类型，在某些语言中可能存在精度丢失的风险，请小心使用。示例值:8821760
BackupOssLogSizeinteger<int64>	OSS 中备份集的日志文件大小，单位：Byte。0 表示没有数据。注意请注意，该值为 Long 类型，在某些语言中可能存在精度丢失的风险，请小心使用。示例值:44180999
BackupSizeinteger<int64>	备份占用空间（数据备份+日志备份），单位：Byte。-1 表示没有数据。注意请注意，该值为 Long 类型，在某些语言中可能存在精度丢失的风险，请小心使用。示例值:53002759
ColdBackupSizeinteger<int64>	冷备份的占用空间，单位：Byte。-1 表示没有数据。注意请注意，该值为 Long 类型，在某些语言中可能存在精度丢失的风险，请小心使用。示例值:2337275904
DBInstanceIdstring	实例 ID。示例值: rm-uf6wjk5******
DataSizeinteger<int64>	数据文件占用空间，单位：Byte。-1 表示没有数据。注意请注意，该值为 Long 类型，在某些语言中可能存在精度丢失的风险，请小心使用。示例值:1292094741
DiskUsedinteger<int64>	已用空间（DataSize+LogSize），单位：Byte。-1 表示没有数据。注意请注意，该值为 Long 类型，在某些语言中可能存在精度丢失的风险，请小心使用。示例值:2337275904
Enginestring	数据库类型。示例值:MySQL
LogSizeinteger<int64>	日志占用空间，单位：Byte。-1 表示没有数据。注意请注意，该值为 Long 类型，在某些语言中可能存在精度丢失的风险，请小心使用。示例值:1045181163
PaidBackupSizeinteger<int64>	扣除免费额度后，需要付费的备份占用空间，单位：Byte。注意请注意，该值为 Long 类型，在某些语言中可能存在精度丢失的风险，请小心使用。示例值:0
RequestIdstring	请求 ID。示例值:F937E173-559C-4498-8D90-38D32342B9E4
SQLSizeinteger<int64>	SQL 的占用空间，单位：Byte。-1 表示没有数据。注意请注意，该值为 Long 类型，在某些语言中可能存在精度丢失的风险，请小心使用。示例值:315052751
BackupEcsSnapshotSizestring	SQL Server 实例的快照备份占用空间，单位：Byte。0 表示没有数据。示例值:0

返回示例

错误返回示例

错误码

没有我想要的错误码, 点击反馈

全局错误码

HTTP 状态码	错误码	错误信息	操作

400	Order.ComboInstanceNotAllowOperate	A package instance is not allowed to operate independently.	诊断
400	Price.PricingPlanResultNotFound	Pricing plan price result not found.	诊断
400	Order.NoRealNameAuthentication	You 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.	诊断
400	InsufficientAvailableQuota	Your account quota limit is less than 0, please recharge before trying to purchase.	诊断
400	CommodityServiceCalling.Exception	Failed to call commodity service.	诊断
400	RegionDissolvedEOM	Dear 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.	诊断
400	Commodity.InvalidComponent	The module you purchased is not legal, please buy it again.	诊断
400	RegionEndTimeDissolvedAustralia	Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.	诊断
400	Price.CommoditySys	Commodity system call exception.	诊断
400	Pay.InsufficientBalance	Insufficient available balance.	诊断
400	Order.PeriodInvalid	There is a problem with the period you selected, please choose again.	诊断
400	pay.noCreditCard	Account not bound to credit card.	诊断
400	Order.InstHasUnpaidOrder	There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.	诊断
400	noAvailablePaymentMethod	No payment method is specified for your account. We recommend that you add a payment method.	诊断
400	BasicInfoUncompleted	Your information is incomplete. Complete your information before the operation.	诊断
400	Risk.RiskControlRejection	Your account is abnormal, please contact customer service for details.	诊断
400	Api.NotSupport	Specified api is not supported.	诊断
400	ContainForbiddenLabelError	There is a label that prohibits placing orders. Please contact your distributor for assistance.	诊断
400	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in records.	诊断
400	InvalidInstanceLevel.DiskType	Specified instance level not support request disk type	诊断
400	InvalidParam	Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.	诊断
400	KmsApiError	User secret key invalid.	诊断
400	System.SaleValidateFailed	Sales expression validation system error.	诊断
400	Abs.InvalidAccount.NotFound	account is not found.	诊断
400	SqlExecuteFailedOrTimeout	sql command execution failed or timed out:%s.	诊断
400	ColdData.EngineVersionNotSupport	The current instance engine version not support coldDataEnabled.	诊断
400	ColdData.MinorVersionNotSupport	The current instance minor version not support coldDataEnabled.	诊断
400	IncorrectTargetClasscode	The current instance type does not support this operation.	诊断
400	InvalidConnectionString.Duplicate	Specified connection string already exists in the RDS.	诊断
400	RequiredParam.NotFound	Required input param is not found.	诊断
400	Parameters.Invalid	Parameter error, please check the parameters.	诊断
400	BackupPolicyNotSupport	Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.	诊断
400	InvalideStatus.Format	The instance status does not support this operation.	诊断
400	InvalidReleasedKeepPolicy.Format	Specified Released Keep Policy is not valid.	诊断
400	InvalidDBInstanceEngineType.Format	the DB instance engine type does not support this operation.	诊断
400	Pay.NoCreditCard	No credit cards.	诊断
400	VpcNetworkTypeNotSupport	The vpc network type instance does not support this operation.	诊断
400	MirrorInsExists	Specified DB instance mirror ins already existed.	诊断
400	UnsupportedClassCode	The specified DB instance class stops selling.	诊断
400	InvalidBackupSet	The specified database does not exist in the backup set.	诊断
400	OrdTCommodityQueryError	Failed to query for product.	诊断
400	ProductInstanceReleased	The instance has been released. Please check before placing the order.	诊断
400	RegionEndTimeDissolvedIndia	The region is no longer supported.	诊断
403	OrderStatus.UnPaid	The specified db instance has unpaid order.	诊断
403	InvalidReduceDiskSize	The storage capacity after the scale-down must be larger than the used amount.	诊断
403	CloudSSDNotSupport	Cloud ssd does not support this operation, please upgrade to essd.	诊断
403	InvalidUserOperatorPermission	The user permission does not support this operation.	诊断
403	InvalidVswitchId	Specified conn vswitch id is not valid.	诊断
403	IncorrectMinorVersion	Current engine minor version does not support operations.	诊断
403	OperationDenied.ZoneResource	There is no available zone for inventory.	诊断
403	NotInFlowController	Sorry,no permission.	诊断
403	InvalidKmsKey	Kms key is disabled.	诊断
403	InvalidInstanceLevel.Malformed	Current DB instance level does not support this operation.	诊断
404	InvalidClusterKms	The current instance does not authorized to access the Key Management Service.	诊断
404	Request.NotFound	The requested resource is not available.	诊断
404	HostInfo.NotFound	The specified host info is not found.	诊断
500	InvokeProxyFailure	The request processing has failed due to service failure of rds api.	诊断
500	ExternalFailure	The request processing has failed due to external service failure.	诊断
500	RequestMetaDataFailed	The service request failed. Please try again later or contact service personnel.	诊断

变更历史

	变更时间	变更内容概要	操作
	2025-01-09	变更返回参数
	2024-05-22	新增错误码500
	2022-08-04	新增请求参数ResourceGroupId

DescribeResourceUsage_云数据库 RDS_API文档

接口说明

适用引擎

流控信息

授权信息

请求参数

返回参数

返回示例

错误返回示例

错误码

变更历史

相关示例