调用GetAutoResourceOptimizeRules接口,获取指定数据库实例的空间碎片自动回收规则。

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

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

请求参数

名称 类型 是否必选 示例值 描述
Action String GetAutoResourceOptimizeRules

系统规定参数。取值:GetAutoResourceOptimizeRules

ConsoleContext String None

备用参数。

InstanceIds String ['rm-2ze8g2am97624****','rm-2vc54m2a6pd6p****','rm-2ze9xrhze0709****','rm-2ze8g2am97627****']

数据库实例ID。

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

返回数据

名称 类型 示例值 描述
Code Long 200

返回的状态码。

Message String Successful

请求返回消息。

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

返回的数据。

TotalAutoResourceOptimizeRulesCount Long 3

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

EnableAutoResourceOptimizeCount Long 1

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

TurnOffAutoResourceOptimizeCount Long 1

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

HasEnableRuleButNotDasProCount Long 1

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

EnableAutoResourceOptimizeList Array of enableAutoResourceOptimizeList

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

InstanceId String rm-2ze8g2am97624****

数据库实例ID。

AutoDefragment Boolean true

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

  • true:是。
  • false:否。
TableSpaceSize double 10

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

DasProOn Boolean true

是否开启了DAS专业版。

  • true:是。
  • false:否。
TableFragmentationRatio double 0.2

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

UserId String 140692647406****

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

TurnOffAutoResourceOptimizeList Array of turnOffAutoResourceOptimizeList

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

InstanceId String rm-2vc54m2a6pd6p****

数据库实例ID。

AutoDefragment Boolean false

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

  • true:是。
  • false:否。
TableSpaceSize double 10

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

DasProOn Boolean true

是否开启了DAS专业版。

  • true:是。
  • false:否。
TableFragmentationRatio double 0.2

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

UserId String 140692647406****

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

HasEnableRuleButNotDasProList Array of hasEnableRuleButNotDasProList

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

说明 此类数据库实例不会执行空间碎片自动回收,直至再次为数据库实例开启DAS专业版。
InstanceId String rm-2ze9xrhze0709****

数据库实例ID。

AutoDefragment Boolean true

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

  • true:是。
  • false:否。
TableSpaceSize double 10

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

DasProOn Boolean false

是否开启了DAS专业版。

  • true:是。
  • false:否。
TableFragmentationRatio double 0.2

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

UserId String 140692647406****

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

NeverEnableAutoResourceOptimizeOrReleasedInstanceCount Long 1

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

说明 实例不存在:数据库实例已经释放或者传入的数据库实例ID存在错误。
NeverEnableAutoResourceOptimizeOrReleasedInstanceIdList Array of String rm-2ze8g2am97624****

数据库实例ID。

RequestId String B6D17591-B48B-4D31-9CD6-9B9796B2****

请求ID。

Success Boolean true

请求是否执行成功:

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

示例

请求示例

http(s)://das.cn-shanghai.aliyuncs.com/?Action=GetAutoResourceOptimizeRules
&InstanceIds=['rm-2ze8g2am97624****','rm-2vc54m2a6pd6p****','rm-2ze9xrhze0709****','rm-2ze8g2am97627****']
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<GetAutoResourceOptimizeRulesResponse>
    <Code>200</Code>
    <Message>Successful</Message>
    <Data>
        <TotalAutoResourceOptimizeRulesCount>3</TotalAutoResourceOptimizeRulesCount>
        <EnableAutoResourceOptimizeCount>1</EnableAutoResourceOptimizeCount>
        <TurnOffAutoResourceOptimizeCount>1</TurnOffAutoResourceOptimizeCount>
        <HasEnableRuleButNotDasProCount>1</HasEnableRuleButNotDasProCount>
        <EnableAutoResourceOptimizeList>
            <InstanceId>rm-2ze8g2am97624****</InstanceId>
            <AutoDefragment>true</AutoDefragment>
            <TableSpaceSize>10</TableSpaceSize>
            <DasProOn>true</DasProOn>
            <TableFragmentationRatio>0.2</TableFragmentationRatio>
            <UserId>140692647406****</UserId>
        </EnableAutoResourceOptimizeList>
        <TurnOffAutoResourceOptimizeList>
            <InstanceId>rm-2vc54m2a6pd6p****</InstanceId>
            <AutoDefragment>false</AutoDefragment>
            <TableSpaceSize>10</TableSpaceSize>
            <DasProOn>true</DasProOn>
            <TableFragmentationRatio>0.2</TableFragmentationRatio>
            <UserId>140692647406****</UserId>
        </TurnOffAutoResourceOptimizeList>
        <HasEnableRuleButNotDasProList>
            <InstanceId>rm-2ze9xrhze0709****</InstanceId>
            <AutoDefragment>true</AutoDefragment>
            <TableSpaceSize>10</TableSpaceSize>
            <DasProOn>false</DasProOn>
            <TableFragmentationRatio>0.2</TableFragmentationRatio>
            <UserId>140692647406****</UserId>
        </HasEnableRuleButNotDasProList>
        <NeverEnableAutoResourceOptimizeOrReleasedInstanceCount>1</NeverEnableAutoResourceOptimizeOrReleasedInstanceCount>
        <NeverEnableAutoResourceOptimizeOrReleasedInstanceIdList>rm-2ze8g2am97624****</NeverEnableAutoResourceOptimizeOrReleasedInstanceIdList>
    </Data>
    <RequestId>B6D17591-B48B-4D31-9CD6-9B9796B2****</RequestId>
    <Success>true</Success>
</GetAutoResourceOptimizeRulesResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidParams The request parameters are invalid. 请求参数错误

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