调用GetAutoResourceOptimizeRules获取空间碎片自动回收规则-数据库自治服务-阿里云-数据库自治服务(DAS)-阿里云帮助中心

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

接口说明

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

在使用 SDK 调用 DAS 服务时，需要将地域指定为 cn-shanghai。
实例类型为 RDS MySQL 高可用系列。
数据库实例的 CPU 规格不小于 4 核，且innodb_file_per_table参数值为 ON。

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

hdm:GetAutoResourceOptimizeRules

none

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
ConsoleContext	string	否	备用参数。	None
InstanceIds	string	否	数据库实例 ID。数据格式为 JSONArray，例如`['实例 ID1','实例 ID2']`，实例 ID 间用英文逗号（,）分隔。不输入数据库实例 ID 时，默认返回当前账号曾经开启过空间碎片自动回收功能的全部数据库实例信息，包括：正在使用该功能的数据库实例。已关闭该功能的数据库实例（包含已经关闭了 DAS 企业版数据库实例，但不包含已经释放的数据库实例）。	['rm-2ze8g2am97624**','rm-2vc54m2a6pd6p','rm-2ze9xrhze0709','rm-2ze8g2am97627**']

返回参数

名称	类型	描述	示例值
	object
Code	integer	返回的状态码。	200
Message	string	请求返回消息。说明请求成功时该参数返回 Successful，请求失败时会返回请求异常信息（如错误码等）。	Successful
Data	object	返回的数据。
TotalAutoResourceOptimizeRulesCount	integer	所有开启过空间碎片自动回收功能的数据库实例数量。	3
EnableAutoResourceOptimizeCount	integer	正在使用空间碎片自动回收功能的数据库实例数量。	1
TurnOffAutoResourceOptimizeCount	integer	曾经开启并且当前已关闭空间碎片自动回收功能的数据库实例数量。	1
HasEnableRuleButNotDasProCount	integer	已开启并且未关闭空间碎片自动回收功能，但已不再使用 DAS 企业版的数据库实例数量。	1
EnableAutoResourceOptimizeList	array<object>	正在使用空间碎片自动回收功能的数据库实例信息列表。
	object
InstanceId	string	数据库实例 ID。	rm-2ze8g2am97624****
AutoDefragment	boolean	是否开启了自动空间碎片回收功能。 true：是。 false：否。	true
TableSpaceSize	number	触发空间碎片自动回收单个物理表的最小空间，单位为 GB。	10
DasProOn	boolean	是否开启了 DAS 企业版。 true：是。 false：否。	true
TableFragmentationRatio	number	触发空间碎片自动回收单个物理表的碎片率。	0.2
UserId	string	用户 ID，即创建数据库实例的阿里云主账号 ID。	140692647406****
TurnOffAutoResourceOptimizeList	array<object>	曾经开启并且当前已关闭空间碎片自动回收功能的数据库实例信息列表。
	object
InstanceId	string	数据库实例 ID。	rm-2vc54m2a6pd6p****
AutoDefragment	boolean	是否开启了自动空间碎片回收功能。 true：是。 false：否。	false
TableSpaceSize	number	触发空间碎片自动回收单个物理表的最小空间，单位为 GB。	10
DasProOn	boolean	是否开启了 DAS 企业版。 true：是。 false：否。	true
TableFragmentationRatio	number	触发空间碎片自动回收单个物理表的碎片率。	0.2
UserId	string	用户 ID，即创建数据库实例的阿里云主账号 ID。	140692647406****
HasEnableRuleButNotDasProList	array<object>	已开启并且未关闭空间碎片自动回收功能，但已不再使用 DAS 企业版的数据库实例列表。说明此类数据库实例不会执行空间碎片自动回收，直至再次为数据库实例开启 DAS 企业版。
	object
InstanceId	string	数据库实例 ID。	rm-2ze9xrhze0709****
AutoDefragment	boolean	是否开启了自动空间碎片回收功能。 true：是。 false：否。	true
TableSpaceSize	number	触发空间碎片自动回收单个物理表的最小空间，单位为 GB。	10
DasProOn	boolean	是否开启了 DAS 企业版。 true：是。 false：否。	false
TableFragmentationRatio	number	触发空间碎片自动回收单个物理表的碎片率。	0.2
UserId	string	用户 ID，即创建数据库实例的阿里云主账号 ID。	140692647406****
NeverEnableAutoResourceOptimizeOrReleasedInstanceCount	integer	从未开启过空间碎片自动回收或者实例不存在的数据库实例数量。说明实例不存在：数据库实例已经释放或者传入的数据库实例 ID 存在错误。	1
NeverEnableAutoResourceOptimizeOrReleasedInstanceIdList	array	从未开启过空间碎片自动回收或者实例不存在的数据库实例信息列表。
	string	数据库实例 ID。	rm-2ze8g2am97624****
RequestId	string	请求 ID。	B6D17591-B48B-4D31-9CD6-9B9796B2****
Success	boolean	请求是否执行成功： true：执行成功。 false：执行失败。	true

示例

正常返回示例

JSON格式

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

错误码

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

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

变更历史

更多信息，参考变更详情。