全部产品
Search
文档中心

数据库自治服务 DAS:GetAutoResourceOptimizeRules - 获取空间碎片自动回收规则

更新时间:Oct 17, 2024

获取指定数据库实例的空间碎片自动回收规则。

接口说明

使用该接口需满足以下前提条件:

  • 在使用 SDK 调用 DAS 服务时,需要将地域指定为 cn-shanghai。

  • 实例类型为 RDS MySQL 高可用系列。

  • 数据库实例的 CPU 规格不小于 4 核,且innodb_file_per_table参数值为 ON

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
ConsoleContextstring

备用参数。

None
InstanceIdsstring

数据库实例 ID。

  • 数据格式为 JSONArray,例如['实例 ID1','实例 ID2'],实例 ID 间用英文逗号(,)分隔。
  • 不输入数据库实例 ID 时,默认返回当前账号曾经开启过空间碎片自动回收功能的全部数据库实例信息,包括:
    • 正在使用该功能的数据库实例。
    • 已关闭该功能的数据库实例(包含已经关闭了 DAS 企业版数据库实例,但不包含已经释放的数据库实例)。
['rm-2ze8g2am97624****','rm-2vc54m2a6pd6p****','rm-2ze9xrhze0709****','rm-2ze8g2am97627****']

返回参数

名称类型描述示例值
object
Codelong

返回的状态码。

200
Dataobject

返回的数据。

EnableAutoResourceOptimizeCountlong

正在使用空间碎片自动回收功能的数据库实例数量。

1
EnableAutoResourceOptimizeListarray<object>

正在使用空间碎片自动回收功能的数据库实例信息列表。

enableAutoResourceOptimizeListobject
AutoDefragmentboolean

是否开启了自动空间碎片回收功能。

  • true:是。
  • false:否。
true
DasProOnboolean

是否开启了 DAS 企业版。

  • true:是。
  • false:否。
true
InstanceIdstring

数据库实例 ID。

rm-2ze8g2am97624****
TableFragmentationRatiodouble

触发空间碎片自动回收单个物理表的碎片率。

0.2
TableSpaceSizedouble

触发空间碎片自动回收单个物理表的最小空间,单位为 GB。

10
UserIdstring

用户 ID,即创建数据库实例的阿里云主账号 ID。

140692647406****
HasEnableRuleButNotDasProCountlong

已开启并且未关闭空间碎片自动回收功能,但已不再使用 DAS 企业版的数据库实例数量。

1
HasEnableRuleButNotDasProListarray<object>

已开启并且未关闭空间碎片自动回收功能,但已不再使用 DAS 企业版的数据库实例列表。

说明 此类数据库实例不会执行空间碎片自动回收,直至再次为数据库实例开启 DAS 企业版。
hasEnableRuleButNotDasProListobject
AutoDefragmentboolean

是否开启了自动空间碎片回收功能。

  • true:是。
  • false:否。
true
DasProOnboolean

是否开启了 DAS 企业版。

  • true:是。
  • false:否。
false
InstanceIdstring

数据库实例 ID。

rm-2ze9xrhze0709****
TableFragmentationRatiodouble

触发空间碎片自动回收单个物理表的碎片率。

0.2
TableSpaceSizedouble

触发空间碎片自动回收单个物理表的最小空间,单位为 GB。

10
UserIdstring

用户 ID,即创建数据库实例的阿里云主账号 ID。

140692647406****
NeverEnableAutoResourceOptimizeOrReleasedInstanceCountlong

从未开启过空间碎片自动回收或者实例不存在的数据库实例数量。

说明 实例不存在:数据库实例已经释放或者传入的数据库实例 ID 存在错误。
1
NeverEnableAutoResourceOptimizeOrReleasedInstanceIdListarray

从未开启过空间碎片自动回收或者实例不存在的数据库实例信息列表。

neverEnableAutoResourceOptimizeOrReleasedInstanceIdListstring

数据库实例 ID。

rm-2ze8g2am97624****
TotalAutoResourceOptimizeRulesCountlong

所有开启过空间碎片自动回收功能的数据库实例数量。

3
TurnOffAutoResourceOptimizeCountlong

曾经开启并且当前已关闭空间碎片自动回收功能的数据库实例数量。

1
TurnOffAutoResourceOptimizeListarray<object>

曾经开启并且当前已关闭空间碎片自动回收功能的数据库实例信息列表。

turnOffAutoResourceOptimizeListobject
AutoDefragmentboolean

是否开启了自动空间碎片回收功能。

  • true:是。
  • false:否。
false
DasProOnboolean

是否开启了 DAS 企业版。

  • true:是。
  • false:否。
true
InstanceIdstring

数据库实例 ID。

rm-2vc54m2a6pd6p****
TableFragmentationRatiodouble

触发空间碎片自动回收单个物理表的碎片率。

0.2
TableSpaceSizedouble

触发空间碎片自动回收单个物理表的最小空间,单位为 GB。

10
UserIdstring

用户 ID,即创建数据库实例的阿里云主账号 ID。

140692647406****
Messagestring

请求返回消息。

说明 请求成功时该参数返回 Successful,请求失败时会返回请求异常信息(如错误码等)。
Successful
RequestIdstring

请求 ID。

B6D17591-B48B-4D31-9CD6-9B9796B2****
Successboolean

请求是否执行成功:

  • true:执行成功。
  • false:执行失败。
true

示例

正常返回示例

JSON格式

{
  "Code": 200,
  "Data": {
    "EnableAutoResourceOptimizeCount": 1,
    "EnableAutoResourceOptimizeList": [
      {
        "AutoDefragment": true,
        "DasProOn": true,
        "InstanceId": "rm-2ze8g2am97624****",
        "TableFragmentationRatio": 0.2,
        "TableSpaceSize": 10,
        "UserId": "140692647406****"
      }
    ],
    "HasEnableRuleButNotDasProCount": 1,
    "HasEnableRuleButNotDasProList": [
      {
        "AutoDefragment": true,
        "DasProOn": false,
        "InstanceId": "rm-2ze9xrhze0709****",
        "TableFragmentationRatio": 0.2,
        "TableSpaceSize": 10,
        "UserId": "140692647406****"
      }
    ],
    "NeverEnableAutoResourceOptimizeOrReleasedInstanceCount": 1,
    "NeverEnableAutoResourceOptimizeOrReleasedInstanceIdList": [
      "rm-2ze8g2am97624****"
    ],
    "TotalAutoResourceOptimizeRulesCount": 3,
    "TurnOffAutoResourceOptimizeCount": 1,
    "TurnOffAutoResourceOptimizeList": [
      {
        "AutoDefragment": false,
        "DasProOn": true,
        "InstanceId": "rm-2vc54m2a6pd6p****",
        "TableFragmentationRatio": 0.2,
        "TableSpaceSize": 10,
        "UserId": "140692647406****"
      }
    ]
  },
  "Message": "Successful",
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Success": true
}

错误码

HTTP status code错误码错误信息描述
400InvalidParamsThe request parameters are invalid.请求参数错误
403NoPermissionYou are not authorized to do this action.没有权限执行该操作

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

变更历史

变更时间变更内容概要操作
2023-11-17API 内部配置变更,不影响调用查看变更详情
2023-11-17OpenAPI 错误码发生变更查看变更详情