查询备份空间超阈值实例列表 - ShowBackupUsageExceededInstances
调试
您可以在API Explorer中调试该接口。
授权信息
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
| 授权项 | 访问级别 | 资源类型（*为必须） | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
| rds:backup:getBackupUsageExceededInstances | read | - | - | - | - |
接口约束
仅支持MySQL引擎，且内核版本需要大于等于8.0.43.260600。
URI
- URI格式
GET /v3/{project_id}/backups/usage-exceeded-instances
- 参数说明
表1 参数说明 参数
是否必选
参数类型
描述
project_id
是
String
参数解释：
租户在某一region下的project ID。
获取方法请参见获取项目ID。
约束限制：
不涉及。
取值范围：
不涉及。
默认取值：
不涉及。
请求消息
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| limit | 否 | Integer | 参数解释： 查询记录数。 约束限制： 不涉及。 取值范围： [1, 100] 默认取值： 100 |
| offset | 否 | Integer | 参数解释： 索引位置，偏移量。 约束限制： 不涉及。 取值范围： 大于或等于0。 默认取值： 0 |
请求示例
查询备份空间超阈值实例列表。
GET https://{endpoint}/v3/04d4856ce8c0272c0e2fc0b4db90e5b4/backups/usage-exceeded-instances 响应消息
- 正常响应要素说明
表3 参数说明 参数
参数类型
描述
instances
Array of objects
参数解释：
超阈值实例列表。
详见表4。
total
Integer
参数解释：
超过阈值的实例总数。
取值范围：
不涉及。
表4 instances字段说明 参数
参数类型
描述
instance_id
String
参数解释：
实例ID。
取值范围：
不涉及。
obs_usage_gb
Double
参数解释：
日志备份空间使用量，单位GB。
取值范围：
不涉及。
obs_free_backup_space_gb
Double
参数解释：
日志备份免费备份空间额度，单位GB。
取值范围：
不涉及。
snapshot_usage_gb
Double
参数解释：
快照备份空间使用量，单位GB。
取值范围：
不涉及。
snapshot_free_backup_space_gb
Double
参数解释：
快照免费备份空间额度，单位GB。
取值范围：
不涉及。
- 正常响应样例
{ "instances" : [ { "instance_id" : "3b2f4a5e-6b7c-8d9e-0f1a-2b3c4d5e6f7a", "obs_usage_gb" : 80.5, "obs_free_backup_space_gb" : 40, "snapshot_usage_gb" : 45.3, "snapshot_free_backup_space_gb" : 40 } ], "total" : 1 }
- 异常响应
请参见异常响应结果。
状态码
- 正常
- 异常
请参见状态码。
错误码
请参见错误码。
